@wesp-up/eslint-config-react v2.1.0

@wesp-up/eslint-config-react

This project maintains base ESLint configuration for TypeScript projects. Each file may be extended and custom configuration may be added. We use the recommended rules as much as possible to gain great default support.

For ultimate productivity, configure your IDE to auto-lint when saving changes.

Installation

npm install --save-dev @wesp-up/eslint-config-react eslint

Usage

1. In your eslint.config.js (or alternative config entry), extend the config files that suit your project. For example:

   import config from '@wesp-up/eslint-config-react';
   
   export default [...config];

2. In your tsconfig.json, include all TypeScript and JavaScript files via the following, including dot files, such as eslint.config.js.

   {
     "include": ["**/*", ".*"]
   }

   • Be sure to also exclude any files from your tsconfig now that it is being used for both linting and transpiling.

   • To get the full capabilities of linting with TypeScript, the parser must use the transpiler. If you would like to use a different tsconfig for linting, you can specify a new one via tsconfig.eslint.json then add the following to your .eslintrc.cjs file.

     {
       "extends": "./tsconfig.json",
       "include": ["**/*", ".*"]
     }

     // eslint.config.js
     import config from '@wesp-up/eslint-config';
     
     export default [
       ...config,
       {
         languageOptions: {
           parserOptions: {
             project: './tsconfig.eslint.json',
           },
         },
       },
     ];

3. In your package.json add the following scripts.

   {
     "scripts": {
       "lint": "eslint --cache --cache-location ./node_modules/.cache/eslint .",
       "lint:fix": "npm run lint -- --fix"
     }
   }

4. Now test out linting via npm run lint and fixable issues with npm run lint:fix.

API

Below are each of the configuration files available and their explanations. Each config is composable and can be included with the other configs. Extend any configs that fit your project.

• index.js: Base config for all TypeScript projects.
• jest-testing-library.js: Config for a project using Jest or Vitest (because it currently has such a similar API to Jest) and React Testing Library.

Best Practices

• Extend the default config last (index.js), as it will override some undesirable rules provided by other configs.

FAQ

• Why do I get the error Parsing error: "parserOptions.project" has been set for @typescript-eslint/parser.?

The full error will look like the following:

  0:0  error  Parsing error: "parserOptions.project" has been set for @typescript-eslint/parser.
The file does not match your project config: <insert-file-name>.
The file must be included in at least one of the projects provided

This happens when a file should be included in linting when the TypeScript tsconfig.json is not including it. ESLint requires it to be included for TypeScript projects. This is why we recommend including all files in your tsconfig.json. For example, { "include": ["**/*", ".*"] }. This allows the entire project to adhere to the same linting and formatting rules.