README.md

eslint-config

An ESLint Shareable Config

Installation

npm install eslint-config-tcd eslint
# OR
yarn add  eslint-config-tcd eslint
# OR
pnpm add  eslint-config-tcd eslint

Usage

Shareable configs are designed to work with the extends feature of .eslintrc files. You can learn more about Shareable Configs on the official ESLint website.

To use this shareable config, first run this:

npm install --save-dev eslint eslint-config-tcd
# OR
yarn add --dev eslint eslint-config-tcd

Then, add the config you need to your flat eslint.config.(.js|.json|.yml) file:

MJS

import defaultConfig from 'eslint-config-tcd';
import reactConfig from 'eslint-config-tcd/configs/react';

export default [
  defaultConfig,
  reactConfig,
  {
    files: ['*.ks', '*.jsx']
  }
];

CJS

const defaultConfig = require('eslint-config-tcd');
const reactConfig = require('eslint-config-tcd/configs/react');

module.exports = [
  defaultConfig,
  reactConfig,
  {
    files: ['*.ks', '*.jsx']
  }
];

All available configs

• eslint-config-tcd/configs/default - ES6+ config
• eslint-config-tcd/configs/node - ES6+ NodeJS config
• eslint-config-tcd/configs/react - React config
• eslint-config-tcd/configs/ts - TypeScript config
• eslint-config-tcd/configs/next - NextJS config