Usage

• If you are using eslint version 8.56 or below, use @nish1896/eslint-config.
• For eslint version 9 and above, use @nish1896/eslint-flat-config.

info

Both @nish1896/eslint-flat-config and @nish1896/eslint-config have the same set of rules. For node app, use only the js import of either package. For react/nextjs/vite apps, use both js and jsx/react imports

If you are using eslint v9 or above, create eslint.config.mjs file in your root directory and paste the below code -

import jsEslintConfig from '@nish1896/eslint-flat-config/js';
import jsxEslintConfig from '@nish1896/eslint-flat-config/jsx';

export default [
  ...jsEslintConfig,
  ...jsxEslintConfig,    /* for react/nextjs/vite apps */
  {
    rules: {}
  }
];

For eslint 8.57.0 or below, create .eslintrc.js or .eslintrc.json file in your root directory and paste the below code -

module.exports = {
  extends: [
    "@nish1896/eslint-config/js",
    "@nish1896/eslint-config/react"   /* for react/nextjs/vite apps */
  ],
  rules: {}
}

To add a new rule, turn off or modify the existing list of rules, append the rules in your eslint configuration file.

{
  rules: {
    "<new-rule>": "error",
    "no-unused-vars": "off",
    "id-length": ["warn", { min: 3, max: 20 }]
  }
}

To disable one or more rules throughout the file, add this at the top of your file.

/* eslint-disable  @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any */

To disable one or more rules in the next line,

/* eslint-disable-next-line <rule1>, <rule2> */

warning

The syntax below won't work

// eslint-disable-next-line <rule1>, <rule2>
/** eslint-disable-next-line  @typescript-eslint/no-unused-vars */

To run linting on your codebase,

npm run lint

yarn lint

For formatting non-js like .css, .html files you can use prettier alongside eslint. Prettier configuration, .prettierignore and usage of eslint with prettier in pre-commit hook can be referenced from my react-node-ts-monorepo.