Eslint config airbnb typescript base

Eslint config airbnb typescript base

Airbnb’s ESLint config with TypeScript support

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.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

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

If you don’t need React support, add «extends»: «airbnb-typescript/base» instead.

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 .

 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.

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.

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

Источник

eslint-config-airbnb-typescript

Make sure you have the regular Airbnb config setup. If you are using React, use eslint-config-airbnb, or if you aren’t using React, use eslint-config-airbnb-base.

2) Install dependencies (and peer dependencies)

npm install eslint-config-airbnb-typescript \ @typescript-eslint/eslint-plugin@^6.0.0 \ @typescript-eslint/parser@^6.0.0 \ --save-dev

npm install eslint-config-airbnb-typescript \ @typescript-eslint/eslint-plugin@^5.13.0 \ @typescript-eslint/parser@^5.0.0 \ --save-dev

3) Configure ESLint

Within your ESLint config file:

extends: [ 'airbnb', + 'airbnb-typescript' ]

If you don’t need React support:

extends: [ 'airbnb-base', + 'airbnb-typescript/base' ]

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 .

< extends: ['airbnb', '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

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

Why do I need the peer dependencies?

@typescript-eslint/eslint-plugin is a peer dependency due to a limitation within ESLint. See issue, RFC, and progress.

@typescript-eslint/parser is a peer dependency because the version number must match @typescript-eslint/eslint-plugin .

I wish this config would support [. ]

This config simply enhances the 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', 'airbnb-typescript', 'airbnb/hooks', 'plugin:@typescript-eslint/recommended-type-checked', // @typescript-eslint @v6 'plugin:@typescript-eslint/stylistic-type-checked', // @typescript-eslint @v6 // 'plugin:@typescript-eslint/recommended', // @typescript-eslint @v5 // 'plugin:@typescript-eslint/recommended-requiring-type-checking', // @typescript-eslint @v5 ], >;

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

Why is import/no-unresolved disabled?

1. It requires additional configuration, which may be different for monorepo’s, webpack usage, etc
2. The rule offers little value in a TypeScript world, as the TypeScript compiler will catch these errors

If you would like to enable this rule, then:

• Enable the rule within your config: ‘import/no-unresolved’: ‘error’
• Install and configure the TypeScript import resolver: eslint-import-resolver-typescript

Additional Documentation

Credits

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

Источник

Saved searches

Use saved searches to filter your results more quickly

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.

Airbnb’s ESLint config with TypeScript support

License

iamturns/eslint-config-airbnb-typescript

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Sign In Required

Please sign in to use Codespaces.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching Xcode

If nothing happens, download Xcode and try again.

Launching Visual Studio Code

Your codespace will open once ready.

There was a problem preparing your codespace, please try again.

Latest commit

Git stats

Files

Failed to load latest commit information.

README.md

Enhances Airbnb’s ESLint config with TypeScript support

1) Setup regular Airbnb config

Make sure you have the regular Airbnb config setup. If you are using React, use eslint-config-airbnb, or if you aren’t using React, use eslint-config-airbnb-base.

2) Install dependencies (and peer dependencies)

npm install eslint-config-airbnb-typescript \ @typescript-eslint/eslint-plugin@^6.0.0 \ @typescript-eslint/parser@^6.0.0 \ --save-dev

npm install eslint-config-airbnb-typescript \ @typescript-eslint/eslint-plugin@^5.13.0 \ @typescript-eslint/parser@^5.0.0 \ --save-dev

Within your ESLint config file:

extends: [ 'airbnb', + 'airbnb-typescript' ]

If you don’t need React support:

extends: [ 'airbnb-base', + 'airbnb-typescript/base' ]

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 .

< extends: ['airbnb', '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.

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

Why do I need the peer dependencies?

@typescript-eslint/eslint-plugin is a peer dependency due to a limitation within ESLint. See issue, RFC, and progress.

@typescript-eslint/parser is a peer dependency because the version number must match @typescript-eslint/eslint-plugin .

I wish this config would support [. ]

This config simply enhances the 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', 'airbnb-typescript', 'airbnb/hooks', 'plugin:@typescript-eslint/recommended-type-checked', // @typescript-eslint @v6 'plugin:@typescript-eslint/stylistic-type-checked', // @typescript-eslint @v6 // 'plugin:@typescript-eslint/recommended', // @typescript-eslint @v5 // 'plugin:@typescript-eslint/recommended-requiring-type-checking', // @typescript-eslint @v5 ], >;

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

Why is import/no-unresolved disabled?

1. It requires additional configuration, which may be different for monorepo’s, webpack usage, etc
2. The rule offers little value in a TypeScript world, as the TypeScript compiler will catch these errors

If you would like to enable this rule, then:

• Enable the rule within your config: ‘import/no-unresolved’: ‘error’
• Install and configure the TypeScript import resolver: eslint-import-resolver-typescript

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

Источник