Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

eslint-config-airbnb-typescript

12.0.0 • Public • Published

eslint-config-airbnb-typescript

Version Downloads Last commit Build License PRs Welcome Code of conduct

Airbnb's ESLint config with TypeScript support

Setup

1) Install

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

2) Install ESLint plugins

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.4.1 \
            --save-dev

If you don't need React support:

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

3) Configure ESLint

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'],
};

4) Configure the ESLint TypeScript parser

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',
+ }
 };

5) Run ESLint

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.

FAQ

Does this work with JavaScript files too?

Yep! This config is a drop-in replacement for eslint-config-airbnb, decorating it with TypeScript support.

I get this error when running ESLint: "The file must be included in at least one of the projects provided"

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',
}

I get peer dependency warnings for ESLint React plugins, but I'm using airbnb-typescript/base

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

I wish this config would support [...]

The goal of eslint-config-airbnb-typescript is to simply decorate eslint-config-airbnb with TypeScript support. 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.

Additional Documentation

Credits

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

A big thank you to all contributors!

License

Open source licensed as MIT.

Install

npm i eslint-config-airbnb-typescript

DownloadsWeekly Downloads

323,009

Version

12.0.0

License

MIT

Unpacked Size

38.5 kB

Total Files

24

Last publish

Collaborators

  • avatar