Skip to content

Commit

Permalink
review fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
bradzacher committed Feb 7, 2024
1 parent 92133c0 commit 69084bd
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/Packages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,6 @@ They are:
- [`@typescript-eslint/parser`](./packages/Parser.mdx): An ESLint parser which allows for ESLint to lint TypeScript source code.
- [`@typescript-eslint/rule-tester`](./packages/Rule_Tester.mdx): A utility for testing ESLint rules.
- [`@typescript-eslint/scope-manager`](./packages/Scope_Manager.mdx): A fork of [`eslint-scope`](https://github.com/eslint/eslint-scope), enhanced to support TypeScript functionality.
- [`@typescript-eslint/typescript-eslint`](./packages/TypeScript_ESLint.mdx): Tooling which enables you to use TypeScript with ESLint.
- [`@typescript-eslint/typescript-estree`](./packages/TypeScript_ESTree.mdx): The underlying code used by [`@typescript-eslint/parser`](./packages/Parser.mdx) that converts TypeScript source code into an [ESTree](https://github.com/estree/estree)-compatible form.
- [`@typescript-eslint/utils`](./packages/Utils.mdx): Utilities for working with TypeScript + ESLint together.
4 changes: 1 addition & 3 deletions docs/packages/TypeScript_ESLint.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,7 @@ export default tseslint.config({
:::warning
We **_strongly_** recommend declaring our plugin with the namespace `@typescript-eslint` as shown above. If you use our shared configs this is the namespace that they use. This has been the standard namespace for our plugin for many years and is what users are most familiar with.

You may, however, choose to use a different namespace if you wish - but note that currently [flat configs allow the same plugin to be registered and configured under multiple namespaces](https://github.com/eslint/eslint/discussions/17766). This means that it's possible to have a plugin's rule turned on twice under different namespaces - leading to double reporting!

If you choose your own namespace - you are responsible for ensuring that you deduplicate usages of the plugin to ensure each rule is only enabled once.
You may choose a different namespace - but note that currently [flat configs allow the same plugin to be registered, configured, and have duplicate reports under multiple namespaces](https://github.com/eslint/eslint/discussions/17766).
:::

### Flat config `extends`
Expand Down
1 change: 1 addition & 0 deletions packages/website/sidebars/sidebar.base.js
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ module.exports = {
'packages/rule-tester',
'packages/scope-manager',
'packages/typescript-estree',
'packages/typescript-eslint',
'packages/utils',
],
label: 'Packages',
Expand Down

0 comments on commit 69084bd

Please sign in to comment.