Airbnb's ESLint config with TypeScript support

Works with both JS and TS files.

npm install eslint-config-airbnb-typescript --save-dev 

ESLint plugins used by this config must also be installed within your project. This is a limitation within ESLint.

npm install eslint-plugin-import@^2.22.0 \ eslint-plugin-jsx-a11y@^6.3.1 \ eslint-plugin-react@^7.20.3 \ eslint-plugin-react-hooks@^4.0.8 \ @typescript-eslint/eslint-plugin@^4.2.0 \ --save-dev

If you don't need React support:

npm install eslint-plugin-import@^2.22.0 \ @typescript-eslint/eslint-plugin@^4.2.0 \ --save-dev

Add "extends": "airbnb-typescript" to your ESLint config file.

If you don't need React support, add "extends": "airbnb-typescript/base" instead.

An example .eslintrc.js:

module.exports = { extends: ['airbnb-typescript'], };

This config requires knowledge of your TypeScript config.

In your ESLint config, set parserOptions.project to the path of your tsconfig.json.

For example:

 module.exports = { extends: ['airbnb-typescript'], + parserOptions: { + project: './tsconfig.json', + } };

Open a terminal to the root of your project, and run the following command:

npx eslint . --ext .js,.jsx,.ts,.tsx 

ESLint will lint all .js, .jsx, .ts, and .tsx files within the current folder, and output results to your terminal.

You can also get results in realtime inside most IDEs via a plugin.

This means you are attempting to lint a file that tsconfig.json doesn't include.

A common fix is to create a tsconfig.eslint.json file, which extends your tsconfig.json file and includes all files you are linting.

{ "extends": "./tsconfig.json", "include": ["src/**/*.ts", "src/**/*.js", "test/**/*.ts"] }

Update your ESLint config file:

parserOptions: { - project: './tsconfig.json', + project: './tsconfig.eslint.json', }

This is a known problem. Some suggestions exist in this GitHub issue.

The goal of eslint-config-airbnb-typescript is to simply decorate eslint-config-airbnb with TypeScript support. All rules and settings are identical. It's a drop-in replacement for eslint-config-airbnb, including linting for JavaScript files.

It's not a single config to cater for all TypeScript linting requirements.

For additional functionality, alter your ESLint config file. For example:

module.exports = { extends: [ 'airbnb-typescript', 'airbnb/hooks', 'plugin:@typescript-eslint/recommended', 'plugin:@typescript-eslint/recommended-requiring-type-checking', ], };

My personal ESLint config file with support for Jest, Promises, and Prettier can be found in create-exposed-app.

• CHANGELOG.md
• DEVELOPING.md
• CONTRIBUTING.md
• MAINTAINING.md

Authored and maintained by Matt Turnbull (iamturns.com / @iamturns)

A big thank you to all contributors!

Open source licensed as MIT.