eslint-config-airbnb-typescript

What is eslint-config-airbnb-typescript?

The eslint-config-airbnb-typescript package extends Airbnb's ESLint configuration, adapting it for TypeScript. It provides a set of linting rules that enforce JavaScript and TypeScript coding standards and best practices as defined by Airbnb. This package is designed to work with projects using TypeScript, helping developers to write cleaner, more consistent, and error-free code.

What are eslint-config-airbnb-typescript's main functionalities?

TypeScript Support

Integrates Airbnb's ESLint rules with TypeScript-specific adjustments. This feature allows developers to apply Airbnb's rigorous coding standards to TypeScript projects, ensuring consistency and quality in the codebase.

"extends": ["airbnb", "airbnb-typescript"]

Customizable Rules

Allows customization of linting rules. Developers can override or extend the default set provided by Airbnb to tailor the linting process to their project's specific needs, ensuring flexibility and control over code quality.

{
  "rules": {
    "@typescript-eslint/no-unused-vars": "error",
    "react/jsx-filename-extension": [1, { "extensions": [".tsx"] }]
  }
}

Other packages similar to eslint-config-airbnb-typescript

eslint-config-google

Provides a set of linting rules based on Google's JavaScript style guide. Similar to eslint-config-airbnb-typescript, it enforces coding standards and best practices but follows Google's guidelines instead of Airbnb's. It does not have built-in TypeScript support but can be adapted for use with TypeScript projects.

eslint-config-standard

An ESLint configuration package that adheres to the 'JavaScript Standard Style' guidelines. Unlike eslint-config-airbnb-typescript, which is tailored for Airbnb's style guide and TypeScript, eslint-config-standard focuses on a different set of rules and principles for JavaScript projects. TypeScript support can be added through additional plugins.

eslint-config-prettier

Disables all ESLint rules that are unnecessary or might conflict with Prettier. While eslint-config-airbnb-typescript focuses on enforcing specific coding standards, eslint-config-prettier is designed to be used in conjunction with other ESLint configurations to ensure compatibility with Prettier, rather than to enforce its own style rules.

README

eslint-config-airbnb-typescript

Enhances Airbnb's ESLint config with TypeScript support

Setup

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

or

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.

For example:

{
  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?

Two reasons:

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

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

Credits

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

A big thank you to all contributors!

License

Open source licensed as MIT.