Skip to main content

Announcing typescript-eslint v6

· 18 min read
Josh Goldberg
Josh Goldberg
typescript-eslint Maintainer

typescript-eslint is the tooling that enables standard JavaScript tools such as ESLint and Prettier to support TypeScript code. We've been working on a set of breaking changes and general features that we're excited to get released! 🎉

We'd previously blogged about v6 in Announcing typescript-eslint v6 Beta. This blog post contains much of the same information as that one, but updated for changes made since the beta - including a few breaking changes.

✨ indicates a change that was not present in the v6 beta.

Using v6​

Whether you're new to linting your TypeScript code or a returning user, please do upgrade to the latest major version of typescript-eslint! V6 comes with a suite of quality-of-life improvements we think you'll appreciate.

As A New User​

If you don't yet use typescript-eslint, you can go through our configuration steps on the Getting Started docs. It'll walk you through setting up typescript-eslint in a project.

As An Existing User​

If you already use typescript-eslint, you'll need to first replace your package's previous versions of @typescript-eslint/eslint-plugin and @typescript-eslint/parser with the latest versions:

npm i @typescript-eslint/eslint-plugin@latest @typescript-eslint/parser@latest --save-dev

We highly recommend then basing your ESLint configuration on the reworked typescript-eslint recommended configurations mentioned later in this post — especially if it's been a while since you've reworked your linter config.

User-Facing Breaking Changes​

These are the changes that users of typescript-eslint -generally, any developer running ESLint on TypeScript code- should pay attention to when upgrading typescript-eslint from v5 to v6.

Reworked Configuration Names​

The biggest configuration change in typescript-eslint v6 is that we've reworked the names of our provided user configuration files. typescript-eslint v5 provided three recommended configurations:

  • recommended: Recommended rules for code correctness that you can drop in without additional configuration.
  • recommended-requiring-type-checking: Additional recommended rules that require type information.
  • strict: Additional strict rules that can also catch bugs but are more opinionated than recommended rules.

Those configurations worked well for most projects. However, some users correctly noted two flaws in that approach:

  • Strict rules that didn't require type checking were lumped in with those that did.
  • Stylistic best practices were lumped in with rules that actually find bugs.

As a result, we've reworked the configurations provided by typescript-eslint into these two groups:

  • Functional rule configurations, for best best practices and code correctness:
    • recommended: Recommended rules that you can drop in without additional configuration.
    • recommended-type-checked: Additional recommended rules that require type information.
    • strict: Additional strict rules that can also catch bugs but are more opinionated than recommended rules (without type information).
    • strict-type-checked: Additional strict rules that do require type information.
  • Stylistic rule configurations, for consistent and predictable syntax usage:
    • stylistic: Stylistic rules you can drop in without additional configuration.
    • stylistic-type-checked: Additional stylistic rules that require type information.

recommended-requiring-type-checking is now an alias for recommended-type-checked. The alias will be removed in a future major version.

As of v6, we recommend that projects enable two configs from the above:

  • If you are not using typed linting, enable stylistic and either recommended or strict, depending on how intensely you'd like your lint rules to scrutinize your code.
  • If you are using typed linting, enable stylistic-type-checked and either recommended-type-checked or strict-type-checked, depending on how intensely you'd like your lint rules to scrutinize your code.

For example, a typical project that enables typed linting might have an ESLint configuration file that changes like:

.eslintrc.cjs
module.exports = {
  extends: [
    'eslint:recommended',
    'plugin:@typescript-eslint/recommended',
    'plugin:@typescript-eslint/recommended-requiring-type-checking',
    'plugin:@typescript-eslint/recommended-type-checked',
    'plugin:@typescript-eslint/stylistic-type-checked',
  ],
  plugins: ['@typescript-eslint'],
  parser: '@typescript-eslint/parser',
  parserOptions: {
    project: './tsconfig.json',
    project: true,
    tsconfigRootDir: __dirname,
  },
  root: true,
};

See our Configurations linting docs for the updated documentation on configurations provided by typescript-eslint.

For more information on these changes, see:

Updated Configuration Rules​

Every new major version of typescript-eslint comes with changes to which rules are enabled in the preset configurations - and with which options. Because this release also includes a reworking of the configurations themselves, the list of changes is too large to put in this blog post. Instead see the table in Changes to configurations for 6.0.0 and Configs: Last round of "final" changes to configs for v6 for a full description of the changes.

tip

If your ESLint configuration contains many rules configurations, we suggest the following strategy to start anew:

  1. Remove all your rules configurations
  2. Extend from the preset configs that make sense for you
  3. Run ESLint on your project
  4. In your ESLint configuration, turn off any rules creating errors that don't make sense for your project - with comments explaining why
  5. In your ESLint configuration and/or with inline eslint-disable comments, turn off any rules creating too many errors for you to fix - with "TODO" comments linking to tracking issues/tickets to re-enable them

Miscellaneous changes to all shared configurations include:

Diff patch from v5's recommended to v6's recommended and stylistic configs
{
   '@typescript-eslint/adjacent-overload-signatures': '...',
+  '@typescript-eslint/array-type': '...',
   '@typescript-eslint/ban-ts-comment': '...',
+  '@typescript-eslint/ban-tslint-comment': '...',
   '@typescript-eslint/ban-types': '...',
+  '@typescript-eslint/class-literal-property-style': '...',
+  '@typescript-eslint/consistent-generic-constructors': '...',
+  '@typescript-eslint/consistent-indexed-object-style': '...',
+  '@typescript-eslint/consistent-type-assertions': '...',
+  '@typescript-eslint/consistent-type-definitions': '...',
   'no-array-constructor': '...',
   '@typescript-eslint/no-array-constructor': '...',
+  '@typescript-eslint/no-confusing-non-null-assertion': '...',
+  '@typescript-eslint/no-duplicate-enum-values': '...',
   'no-empty-function': '...',
   '@typescript-eslint/no-empty-function': '...',
   '@typescript-eslint/no-empty-interface': '...',
   '@typescript-eslint/no-explicit-any': '...',
   '@typescript-eslint/no-extra-non-null-assertion': '...',
-  'no-extra-semi': '...',
-  '@typescript-eslint/no-extra-semi': '...',
   '@typescript-eslint/no-inferrable-types': '...',
   'no-loss-of-precision': '...',
   '@typescript-eslint/no-loss-of-precision': '...',
   '@typescript-eslint/no-misused-new': '...',
   '@typescript-eslint/no-namespace': '...',
   '@typescript-eslint/no-non-null-asserted-optional-chain': '...',
-  '@typescript-eslint/no-non-null-assertion': '...',
   '@typescript-eslint/no-this-alias': '...',
   '@typescript-eslint/no-unnecessary-type-constraint': '...',
+  '@typescript-eslint/no-unsafe-declaration-merging': '...',
   'no-unused-vars': '...',
   '@typescript-eslint/no-unused-vars': '...',
   '@typescript-eslint/no-var-requires': '...',
   '@typescript-eslint/prefer-as-const': '...',
+  '@typescript-eslint/prefer-for-of': '...',
+  '@typescript-eslint/prefer-function-type': '...',
   '@typescript-eslint/prefer-namespace-keyword': '...',
   '@typescript-eslint/triple-slash-reference': '...',
}
Diff patch from v5's recommended and recommended-type-checked to v6's recommended-type-checked and stylistic-type-checked configs
{
   '@typescript-eslint/adjacent-overload-signatures': '...',
+  '@typescript-eslint/array-type': '...',
   '@typescript-eslint/await-thenable': '...',
   '@typescript-eslint/ban-ts-comment': '...',
+  '@typescript-eslint/ban-tslint-comment': '...',
   '@typescript-eslint/ban-types': '...',
+  '@typescript-eslint/class-literal-property-style': '...',
+  '@typescript-eslint/consistent-generic-constructors': '...',
+  '@typescript-eslint/consistent-indexed-object-style': '...',
+  '@typescript-eslint/consistent-type-assertions': '...',
+  '@typescript-eslint/consistent-type-definitions': '...',
+  'dot-notation': '...',
+  '@typescript-eslint/dot-notation': '...',
   'no-array-constructor': '...',
   '@typescript-eslint/no-array-constructor': '...',
+  '@typescript-eslint/no-base-to-string': '...',
+  '@typescript-eslint/no-confusing-non-null-assertion': '...',
+  '@typescript-eslint/no-duplicate-enum-values': '...',
+  '@typescript-eslint/no-duplicate-type-constituents': '...',
   'no-empty-function': '...',
   '@typescript-eslint/no-empty-function': '...',
   '@typescript-eslint/no-empty-interface': '...',
   '@typescript-eslint/no-explicit-any': '...',
   '@typescript-eslint/no-extra-non-null-assertion': '...',
-  'no-extra-semi': '...',
-  '@typescript-eslint/no-extra-semi': '...',
   '@typescript-eslint/no-floating-promises': '...',
   '@typescript-eslint/no-for-in-array': '...',
   'no-implied-eval': '...',
   '@typescript-eslint/no-implied-eval': '...',
   '@typescript-eslint/no-inferrable-types': '...',
   'no-loss-of-precision': '...',
   '@typescript-eslint/no-loss-of-precision': '...',
   '@typescript-eslint/no-misused-new': '...',
   '@typescript-eslint/no-misused-promises': '...',
   '@typescript-eslint/no-namespace': '...',
   '@typescript-eslint/no-non-null-asserted-optional-chain': '...',
-  '@typescript-eslint/no-non-null-assertion': '...',
+  '@typescript-eslint/no-redundant-type-constituents': '...',
   '@typescript-eslint/no-this-alias': '...',
   '@typescript-eslint/no-unnecessary-type-assertion': '...',
   '@typescript-eslint/no-unnecessary-type-constraint': '...',
   '@typescript-eslint/no-unsafe-argument': '...',
   '@typescript-eslint/no-unsafe-assignment': '...',
   '@typescript-eslint/no-unsafe-call': '...',
+  '@typescript-eslint/no-unsafe-declaration-merging': '...',
+  '@typescript-eslint/no-unsafe-enum-comparison': '...',
   '@typescript-eslint/no-unsafe-member-access': '...',
   '@typescript-eslint/no-unsafe-return': '...',
   'no-unused-vars': '...',
   '@typescript-eslint/no-unused-vars': '...',
   '@typescript-eslint/no-var-requires': '...',
+  '@typescript-eslint/non-nullable-type-assertion-style': '...',
   '@typescript-eslint/prefer-as-const': '...',
+  '@typescript-eslint/prefer-for-of': '...',
+  '@typescript-eslint/prefer-function-type': '...',
   '@typescript-eslint/prefer-namespace-keyword': '...',
+  '@typescript-eslint/prefer-nullish-coalescing': '...',
+  '@typescript-eslint/prefer-optional-chain': '...',
+  '@typescript-eslint/prefer-string-starts-ends-with': '...',
   'require-await': '...',
   '@typescript-eslint/require-await': '...',
   '@typescript-eslint/restrict-plus-operands': '...',
   '@typescript-eslint/restrict-template-expressions': '...',
   '@typescript-eslint/triple-slash-reference': '...',
   '@typescript-eslint/unbound-method': '...',
}
Code that generated those diffs
const v5Recommended = {
  '@typescript-eslint/adjacent-overload-signatures': 'error',
  '@typescript-eslint/ban-ts-comment': 'error',
  '@typescript-eslint/ban-types': 'error',
  'no-array-constructor': 'off',
  '@typescript-eslint/no-array-constructor': 'error',
  'no-empty-function': 'off',
  '@typescript-eslint/no-empty-function': 'error',
  '@typescript-eslint/no-empty-interface': 'error',
  '@typescript-eslint/no-explicit-any': 'warn',
  '@typescript-eslint/no-extra-non-null-assertion': 'error',
  'no-extra-semi': 'off',
  '@typescript-eslint/no-extra-semi': 'error',
  '@typescript-eslint/no-inferrable-types': 'error',
  'no-loss-of-precision': 'off',
  '@typescript-eslint/no-loss-of-precision': 'error',
  '@typescript-eslint/no-misused-new': 'error',
  '@typescript-eslint/no-namespace': 'error',
  '@typescript-eslint/no-non-null-asserted-optional-chain': 'error',
  '@typescript-eslint/no-non-null-assertion': 'warn',
  '@typescript-eslint/no-this-alias': 'error',
  '@typescript-eslint/no-unnecessary-type-constraint': 'error',
  'no-unused-vars': 'off',
  '@typescript-eslint/no-unused-vars': 'warn',
  '@typescript-eslint/no-var-requires': 'error',
  '@typescript-eslint/prefer-as-const': 'error',
  '@typescript-eslint/prefer-namespace-keyword': 'error',
  '@typescript-eslint/triple-slash-reference': 'error',
};

const v5RecommendedRequiringTypeChecking = {
  '@typescript-eslint/await-thenable': 'error',
  '@typescript-eslint/no-floating-promises': 'error',
  '@typescript-eslint/no-for-in-array': 'error',
  'no-implied-eval': 'off',
  '@typescript-eslint/no-implied-eval': 'error',
  '@typescript-eslint/no-misused-promises': 'error',
  '@typescript-eslint/no-unnecessary-type-assertion': 'error',
  '@typescript-eslint/no-unsafe-argument': 'error',
  '@typescript-eslint/no-unsafe-assignment': 'error',
  '@typescript-eslint/no-unsafe-call': 'error',
  '@typescript-eslint/no-unsafe-member-access': 'error',
  '@typescript-eslint/no-unsafe-return': 'error',
  'require-await': 'off',
  '@typescript-eslint/require-await': 'error',
  '@typescript-eslint/restrict-plus-operands': 'error',
  '@typescript-eslint/restrict-template-expressions': 'error',
  '@typescript-eslint/unbound-method': 'error',
};

const v6Recommended = {
  '@typescript-eslint/ban-ts-comment': 'error',
  '@typescript-eslint/ban-types': 'error',
  'no-array-constructor': 'off',
  '@typescript-eslint/no-array-constructor': 'error',
  '@typescript-eslint/no-duplicate-enum-values': 'error',
  '@typescript-eslint/no-explicit-any': 'error',
  '@typescript-eslint/no-extra-non-null-assertion': 'error',
  'no-loss-of-precision': 'off',
  '@typescript-eslint/no-loss-of-precision': 'error',
  '@typescript-eslint/no-misused-new': 'error',
  '@typescript-eslint/no-namespace': 'error',
  '@typescript-eslint/no-non-null-asserted-optional-chain': 'error',
  '@typescript-eslint/no-this-alias': 'error',
  '@typescript-eslint/no-unnecessary-type-constraint': 'error',
  '@typescript-eslint/no-unsafe-declaration-merging': 'error',
  'no-unused-vars': 'off',
  '@typescript-eslint/no-unused-vars': 'error',
  '@typescript-eslint/no-var-requires': 'error',
  '@typescript-eslint/prefer-as-const': 'error',
  '@typescript-eslint/triple-slash-reference': 'error',
};

const v6RecommendedTypeChecked = {
  '@typescript-eslint/await-thenable': 'error',
  '@typescript-eslint/ban-ts-comment': 'error',
  '@typescript-eslint/ban-types': 'error',
  'no-array-constructor': 'off',
  '@typescript-eslint/no-array-constructor': 'error',
  '@typescript-eslint/no-base-to-string': 'error',
  '@typescript-eslint/no-duplicate-enum-values': 'error',
  '@typescript-eslint/no-duplicate-type-constituents': 'error',
  '@typescript-eslint/no-explicit-any': 'error',
  '@typescript-eslint/no-extra-non-null-assertion': 'error',
  '@typescript-eslint/no-floating-promises': 'error',
  '@typescript-eslint/no-for-in-array': 'error',
  'no-implied-eval': 'off',
  '@typescript-eslint/no-implied-eval': 'error',
  'no-loss-of-precision': 'off',
  '@typescript-eslint/no-loss-of-precision': 'error',
  '@typescript-eslint/no-misused-new': 'error',
  '@typescript-eslint/no-misused-promises': 'error',
  '@typescript-eslint/no-namespace': 'error',
  '@typescript-eslint/no-non-null-asserted-optional-chain': 'error',
  '@typescript-eslint/no-redundant-type-constituents': 'error',
  '@typescript-eslint/no-this-alias': 'error',
  '@typescript-eslint/no-unnecessary-type-assertion': 'error',
  '@typescript-eslint/no-unnecessary-type-constraint': 'error',
  '@typescript-eslint/no-unsafe-argument': 'error',
  '@typescript-eslint/no-unsafe-assignment': 'error',
  '@typescript-eslint/no-unsafe-call': 'error',
  '@typescript-eslint/no-unsafe-declaration-merging': 'error',
  '@typescript-eslint/no-unsafe-enum-comparison': 'error',
  '@typescript-eslint/no-unsafe-member-access': 'error',
  '@typescript-eslint/no-unsafe-return': 'error',
  'no-unused-vars': 'off',
  '@typescript-eslint/no-unused-vars': 'error',
  '@typescript-eslint/no-var-requires': 'error',
  '@typescript-eslint/prefer-as-const': 'error',
  'require-await': 'off',
  '@typescript-eslint/require-await': 'error',
  '@typescript-eslint/restrict-plus-operands': 'error',
  '@typescript-eslint/restrict-template-expressions': 'error',
  '@typescript-eslint/triple-slash-reference': 'error',
  '@typescript-eslint/unbound-method': 'error',
};

const v6Stylistic = {
  '@typescript-eslint/adjacent-overload-signatures': 'error',
  '@typescript-eslint/array-type': 'error',
  '@typescript-eslint/ban-tslint-comment': 'error',
  '@typescript-eslint/class-literal-property-style': 'error',
  '@typescript-eslint/consistent-generic-constructors': 'error',
  '@typescript-eslint/consistent-indexed-object-style': 'error',
  '@typescript-eslint/consistent-type-assertions': 'error',
  '@typescript-eslint/consistent-type-definitions': 'error',
  '@typescript-eslint/no-confusing-non-null-assertion': 'error',
  'no-empty-function': 'off',
  '@typescript-eslint/no-empty-function': 'error',
  '@typescript-eslint/no-empty-interface': 'error',
  '@typescript-eslint/no-inferrable-types': 'error',
  '@typescript-eslint/prefer-for-of': 'error',
  '@typescript-eslint/prefer-function-type': 'error',
  '@typescript-eslint/prefer-namespace-keyword': 'error',
};

const v6StylisticTypeChecked = {
  '@typescript-eslint/adjacent-overload-signatures': 'error',
  '@typescript-eslint/array-type': 'error',
  '@typescript-eslint/ban-tslint-comment': 'error',
  '@typescript-eslint/class-literal-property-style': 'error',
  '@typescript-eslint/consistent-generic-constructors': 'error',
  '@typescript-eslint/consistent-indexed-object-style': 'error',
  '@typescript-eslint/consistent-type-assertions': 'error',
  '@typescript-eslint/consistent-type-definitions': 'error',
  'dot-notation': 'off',
  '@typescript-eslint/dot-notation': 'error',
  '@typescript-eslint/no-confusing-non-null-assertion': 'error',
  'no-empty-function': 'off',
  '@typescript-eslint/no-empty-function': 'error',
  '@typescript-eslint/no-empty-interface': 'error',
  '@typescript-eslint/no-inferrable-types': 'error',
  '@typescript-eslint/non-nullable-type-assertion-style': 'error',
  '@typescript-eslint/prefer-for-of': 'error',
  '@typescript-eslint/prefer-function-type': 'error',
  '@typescript-eslint/prefer-namespace-keyword': 'error',
  '@typescript-eslint/prefer-nullish-coalescing': 'error',
  '@typescript-eslint/prefer-optional-chain': 'error',
  '@typescript-eslint/prefer-string-starts-ends-with': 'error',
};

function createDiffPatch(v5, v6) {
  const v5Keys = new Set(Object.keys(v5));
  const v6Keys = new Set(Object.keys(v6));
  const output = ['{'];

  for (const key of Array.from(new Set([...v5Keys, ...v6Keys])).sort((a, b) =>
    trimSlash(a).localeCompare(trimSlash(b)),
  )) {
    const prefix = v5Keys.has(key) ? (v6Keys.has(key) ? ' ' : '-') : '+';

    output.push(`${prefix}  '${key}': '...',`);
  }

  output.push('}');

  return output.join('\n');
}

function trimSlash(text) {
  return text.startsWith('@typescript-eslint/')
    ? text.slice('@typescript-eslint/'.length)
    : text;
}

console.log('From v5 recommended to v6 recommended & stylistic:');

console.log(
  createDiffPatch(v5Recommended, { ...v6Recommended, ...v6Stylistic }),
);

console.log(
  '\nFrom v5 recommended & recommended-requiring-type-checking to v6 recommended-type-checked & stylistic-type-checked:',
);

console.log(
  createDiffPatch(
    {
      ...v5Recommended,
      ...v5RecommendedRequiringTypeChecking,
    },
    { ...v6RecommendedTypeChecked, ...v6StylisticTypeChecked },
  ),
);

Rule Breaking Changes​

Several rules were changed in significant enough ways to be considered breaking changes:

Tooling Breaking Changes​

Developer-Facing Changes​

typescript-eslint v6 comes with a suite of cleanups and improvements for developers as well. If you author any ESLint plugins or other tools that interact with TypeScript syntax, then we recommend you try out typescript-eslint v6 soon. It includes some breaking changes that you may need to accommodate for.

tip

If you're having trouble with the changes, please let us know on the typescript-eslint Discord!

Type Checker Wrapper APIs​

As described in our ASTs and typescript-eslint post, ESLint rules don't natively work with AST nodes compatible with TypeScript's API. Retrieving type information for an ESLint AST node in a custom rule requires code somewhat like:

custom-rule-with-v5.ts
{
  // ...
  create() {
    const services = util.getParserServices(context);
    const checker = services.program.getTypeChecker();
    const tsNode = services.esTreeNodeToTSNodeMap.get(esNode);
    const type = checker.getTypeAtLocation(node);

    // ...
  }
  // ...
}

How cumbersome, just to call to a single method (getTypeAtLocation) on the TypeScript API!

In typescript-eslint v6, we've added a set of wrapper APIs on the services: ParserServices object that act as shortcuts for commonly used TypeScript APIs including getTypeAtLocation:

custom-rule-with-v6.ts
{
  // ...
  create() {
    const services = util.getParserServices(context);
    const type = services.getTypeAtLocation(node);

    // ...
  }
  // ...
}

For now, the available wrapper APIs are:

  • getSymbolAtLocation: passes an ESTree's equivalent TypeScript node to checker.getSymbolAtLocation
  • getTypeAtLocation: passes an ESTree node's equivalent TypeScript node to checker.getTypeAtLocation

We hope these wrapper APIs make it more convenient to write lint rules that rely on the awesome power of TypeScript's type checking. In the future, we may add more wrapper APIs, and may even add internal caching to those APIs to improve performance.

note

Rules can still retrieve their full backing TypeScript type checker with services.program.getTypeChecker(). This can be necessary for TypeScript APIs not wrapped by the parser services.

See Custom Rules for the updated documentation on creating custom rules with typescript-eslint.

AST Breaking Changes​

These PRs changed the AST shapes generated by typescript-eslint when parsing code. If you author any ESLint rules that refer to the syntax mentioned by them, these are relevant to you.

Errors on Invalid AST Parsing​

note

These changes only impact API consumers of typescript-eslint that work at parsing level. If the extent of your API usage is writing custom rules, these changes don't impact you.

The @typescript-eslint/typescript-estree parser is by default very forgiving of invalid ASTs. If it encounters invalid syntax, it will still attempt create an AST if possible: even if required properties of nodes don't exist.

For example, this snippet of TypeScript code creates a ClassDeclaration whose id is null:

export class {}

Invalid parsed ASTs can cause problems for downstream tools expecting AST nodes to adhere to the ESTree spec. ESLint rules in particular tend to crash when given invalid ASTs.

@typescript-eslint/typescript-estree will now throw an error when it encounters a known invalid AST such as the export class {} example. This is generally the correct behavior for most parsing contexts so downstream tools don't have to work with a potentially invalid AST.

For consumers that don't want the updated behavior of throwing on invalid ASTs, a new allowInvalidAST option exists to disable the throwing behavior. Keep in mind that with it enabled, ASTs produced by typescript-eslint might not match their TSESTree type definitions.

For more information, see:

Package Exports​

The v5 @typescript-eslint/* packages don't use Node.js package.json exports, which allows importing any file in any package by directly referencing a path within the package's dist/ directory. For example:

import * as TSESLint from '@typescript-eslint/utils/dist/ts-eslint';

That presents a few issues for developers:

  • It can be unclear which of many potential import paths to use.
  • TypeScript sometimes suggests importing types or values meant to be private.
  • Consumers using deep import paths can be broken by internal refactors that rename files.

As of feat: add package.json exports for public packages, @typescript-eslint/* packages now use exports to prevent importing internal file paths. Developers must now import directly from the package names, e.g.:

// import * as TSESLint from '@typescript-eslint/utils/dist/ts-eslint';
// -->
import { TSESLint } from '@typescript-eslint/utils';
// The following would also work and be equivalent:
// import * as TSESLint from '@typescript-eslint/utils/ts-eslint';
// But explicit importing should be generally favored over star imports.

// import { RuleModule } from '@typescript-eslint/utils/dist/ts-eslint';
// -->
import { RuleModule } from '@typescript-eslint/utils/ts-eslint';

// import { AST_NODE_TYPES } from "@typescript-eslint/types/dist/generated/ast-spec";
// -->
import { AST_NODE_TYPES } from '@typescript-eslint/types';

See RFC: Use package.json exports to "hide" the dist folder for packages and control our exported surface-area for more backing context.

note

If you update your imports and you still get an error from TypeScript saying "Cannot find module '@typescript-eslint/...' or its corresponding type declarations", then you might need to change the value of moduleResolution in your TypeScript config. See this tracking issue for package.json exports types.

Other Developer-Facing Breaking Changes​

Appreciation​

We'd like to extend a sincere thank you to everybody who pitched in to make typescript-eslint v6 possible.

See the v6.0.0 milestone for the list of issues and associated merged pull requests.

Supporting typescript-eslint​

If you enjoyed this blog post and/or use typescript-eslint, please consider supporting us on Open Collective. We're a small volunteer team and could use your support to make the ESLint experience on TypeScript great. Thanks! 💖