Skip to content

docs(eslint-plugin): [consistent-type-imports] make a note about parserOptions.emitDecoratorMetadata #5904

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 31, 2022
Merged

docs(eslint-plugin): [consistent-type-imports] make a note about parserOptions.emitDecoratorMetadata #5904

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3b16e37
docs(eslint-plugin): [consistent-type-imports] make a note about `par…
bradzacher Oct 30, 2022
b42e3f1
Update consistent-type-imports.md
bradzacher Oct 30, 2022
7a4f8b8
Update consistent-type-imports.md
bradzacher Oct 30, 2022
2bb0394
Update consistent-type-imports.md
bradzacher Oct 30, 2022
2a1ceb7
Update consistent-type-imports.md
bradzacher Oct 31, 2022
37dfb4a
Merge branch 'main' into bradzacher-patch-20221030
bradzacher Oct 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/eslint-plugin/docs/rules/consistent-type-imports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ type T = import('Foo').Foo;
const x: import('Bar') = 1;
```

## Usage with `emitDecoratorMetadata`

The `emitDecoratorMetadata` compiler option changes the code the TypeScript emits. In short - it causes TypeScript to create references to value imports when they are used in a type-only location. If you are using `emitDecoratorMetadata` then our tooling will require additional information in order for the rule to work correctly.

If you are using [type-aware linting](https://typescript-eslint.io/docs/linting/typed-linting), then you just need to ensure that the `tsconfig.json` you've configured for `parserOptions.project` has `emitDecoratorMetadata` turned on. Otherwise you can explicitly tell our tooling to analyze your code as if the compiler option was turned on [by setting `parserOptions.emitDecoratorMetadata` to `true`](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/parser/README.md#parseroptionsemitdecoratormetadata).

## When Not To Use It

- If you specifically want to use both import kinds for stylistic reasons, you can disable this rule.