diff --git a/README.md b/README.md index ad867449f..76d77d12b 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ This plugin intends to support linting of ES2015+ (ES6+) import/export syntax, a ☑️ Enabled in the `recommended` configuration.\ ☑️⚠️ Warns in the `recommended` configuration.\ ❗ Enabled in the `errors` configuration.\ -⚠️ Warns in the `warnings` configuration.\ +🚸⚠️ Warns in the `warnings` configuration.\ ⌨️🚫 Disabled in the `typescript` configuration.\ 🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\ 💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).\ @@ -27,16 +27,16 @@ This plugin intends to support linting of ES2015+ (ES6+) import/export syntax, a ### Helpful warnings -| Name                       | Description | 💼 | 🔧 | 💡 | ❌ | -| :--------------------------------------------------------------------- | :------------------------------------------------------------------------------------ | :----------------- | :- | :- | :- | -| [export](docs/rules/export.md) | Forbid any invalid exports, i.e. re-export of the same name. | ❗ ☑️ | | | | -| [no-deprecated](docs/rules/no-deprecated.md) | Forbid imported names marked with `@deprecated` documentation tag. | | | | | -| [no-empty-named-blocks](docs/rules/no-empty-named-blocks.md) | Forbid empty named import blocks. | | 🔧 | 💡 | | -| [no-extraneous-dependencies](docs/rules/no-extraneous-dependencies.md) | Forbid the use of extraneous packages. | | | | | -| [no-mutable-exports](docs/rules/no-mutable-exports.md) | Forbid the use of mutable exports with `var` or `let`. | | | | | -| [no-named-as-default](docs/rules/no-named-as-default.md) | Forbid use of exported name as identifier of default export. | ☑️⚠️ ⚠️ | | | | -| [no-named-as-default-member](docs/rules/no-named-as-default-member.md) | Forbid use of exported name as property of default export. | ☑️⚠️ ⚠️ | | | | -| [no-unused-modules](docs/rules/no-unused-modules.md) | Forbid modules without exports, or exports without matching import in another module. | | | | | +| Name                       | Description | 💼 | 🔧 | 💡 | ❌ | +| :--------------------------------------------------------------------- | :------------------------------------------------------------------------------------ | :---------------------------------- | :- | :- | :- | +| [export](docs/rules/export.md) | Forbid any invalid exports, i.e. re-export of the same name. | ❗ ☑️ | | | | +| [no-deprecated](docs/rules/no-deprecated.md) | Forbid imported names marked with `@deprecated` documentation tag. | | | | | +| [no-empty-named-blocks](docs/rules/no-empty-named-blocks.md) | Forbid empty named import blocks. | | 🔧 | 💡 | | +| [no-extraneous-dependencies](docs/rules/no-extraneous-dependencies.md) | Forbid the use of extraneous packages. | | | | | +| [no-mutable-exports](docs/rules/no-mutable-exports.md) | Forbid the use of mutable exports with `var` or `let`. | | | | | +| [no-named-as-default](docs/rules/no-named-as-default.md) | Forbid use of exported name as identifier of default export. | ☑️⚠️
🚸⚠️ | | | | +| [no-named-as-default-member](docs/rules/no-named-as-default-member.md) | Forbid use of exported name as property of default export. | ☑️⚠️
🚸⚠️ | | | | +| [no-unused-modules](docs/rules/no-unused-modules.md) | Forbid modules without exports, or exports without matching import in another module. | | | | | ### Module systems @@ -69,26 +69,26 @@ This plugin intends to support linting of ES2015+ (ES6+) import/export syntax, a ### Style guide -| Name                            | Description | 💼 | 🔧 | 💡 | ❌ | -| :------------------------------------------------------------------------------- | :------------------------------------------------------------------------- | :----------------- | :- | :- | :- | -| [consistent-type-specifier-style](docs/rules/consistent-type-specifier-style.md) | Enforce or ban the use of inline type-only markers for named imports. | | 🔧 | | | -| [dynamic-import-chunkname](docs/rules/dynamic-import-chunkname.md) | Enforce a leading comment with the webpackChunkName for dynamic imports. | | | | | -| [exports-last](docs/rules/exports-last.md) | Ensure all exports appear after other statements. | | | | | -| [extensions](docs/rules/extensions.md) | Ensure consistent use of file extension within the import path. | | | | | -| [first](docs/rules/first.md) | Ensure all imports appear before other statements. | | 🔧 | | | -| [group-exports](docs/rules/group-exports.md) | Prefer named exports to be grouped together in a single export declaration | | | | | -| [imports-first](docs/rules/imports-first.md) | Replaced by `import/first`. | | 🔧 | | ❌ | -| [max-dependencies](docs/rules/max-dependencies.md) | Enforce the maximum number of dependencies a module can have. | | | | | -| [newline-after-import](docs/rules/newline-after-import.md) | Enforce a newline after import statements. | | 🔧 | | | -| [no-anonymous-default-export](docs/rules/no-anonymous-default-export.md) | Forbid anonymous values as default exports. | | | | | -| [no-default-export](docs/rules/no-default-export.md) | Forbid default exports. | | | | | -| [no-duplicates](docs/rules/no-duplicates.md) | Forbid repeated import of the same module in multiple places. | ☑️⚠️ ⚠️ | 🔧 | | | -| [no-named-default](docs/rules/no-named-default.md) | Forbid named default exports. | | | | | -| [no-named-export](docs/rules/no-named-export.md) | Forbid named exports. | | | | | -| [no-namespace](docs/rules/no-namespace.md) | Forbid namespace (a.k.a. "wildcard" `*`) imports. | | 🔧 | | | -| [no-unassigned-import](docs/rules/no-unassigned-import.md) | Forbid unassigned imports | | | | | -| [order](docs/rules/order.md) | Enforce a convention in module import order. | | 🔧 | | | -| [prefer-default-export](docs/rules/prefer-default-export.md) | Prefer a default export if module exports a single name. | | | | | +| Name                            | Description | 💼 | 🔧 | 💡 | ❌ | +| :------------------------------------------------------------------------------- | :------------------------------------------------------------------------- | :---------------------------------- | :- | :- | :- | +| [consistent-type-specifier-style](docs/rules/consistent-type-specifier-style.md) | Enforce or ban the use of inline type-only markers for named imports. | | 🔧 | | | +| [dynamic-import-chunkname](docs/rules/dynamic-import-chunkname.md) | Enforce a leading comment with the webpackChunkName for dynamic imports. | | | | | +| [exports-last](docs/rules/exports-last.md) | Ensure all exports appear after other statements. | | | | | +| [extensions](docs/rules/extensions.md) | Ensure consistent use of file extension within the import path. | | | | | +| [first](docs/rules/first.md) | Ensure all imports appear before other statements. | | 🔧 | | | +| [group-exports](docs/rules/group-exports.md) | Prefer named exports to be grouped together in a single export declaration | | | | | +| [imports-first](docs/rules/imports-first.md) | Replaced by `import/first`. | | 🔧 | | ❌ | +| [max-dependencies](docs/rules/max-dependencies.md) | Enforce the maximum number of dependencies a module can have. | | | | | +| [newline-after-import](docs/rules/newline-after-import.md) | Enforce a newline after import statements. | | 🔧 | | | +| [no-anonymous-default-export](docs/rules/no-anonymous-default-export.md) | Forbid anonymous values as default exports. | | | | | +| [no-default-export](docs/rules/no-default-export.md) | Forbid default exports. | | | | | +| [no-duplicates](docs/rules/no-duplicates.md) | Forbid repeated import of the same module in multiple places. | ☑️⚠️
🚸⚠️ | 🔧 | | | +| [no-named-default](docs/rules/no-named-default.md) | Forbid named default exports. | | | | | +| [no-named-export](docs/rules/no-named-export.md) | Forbid named exports. | | | | | +| [no-namespace](docs/rules/no-namespace.md) | Forbid namespace (a.k.a. "wildcard" `*`) imports. | | 🔧 | | | +| [no-unassigned-import](docs/rules/no-unassigned-import.md) | Forbid unassigned imports | | | | | +| [order](docs/rules/order.md) | Enforce a convention in module import order. | | 🔧 | | | +| [prefer-default-export](docs/rules/prefer-default-export.md) | Prefer a default export if module exports a single name. | | | | | diff --git a/docs/rules/no-duplicates.md b/docs/rules/no-duplicates.md index 4fd3ddfd2..0ade70e33 100644 --- a/docs/rules/no-duplicates.md +++ b/docs/rules/no-duplicates.md @@ -1,6 +1,6 @@ # import/no-duplicates -💼 This rule _warns_ in the following configs: ☑️ `recommended`, ⚠️ `warnings`. +💼 This rule _warns_ in the following configs: ☑️ `recommended`, 🚸 `warnings`. 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix). diff --git a/docs/rules/no-named-as-default-member.md b/docs/rules/no-named-as-default-member.md index efbb391a3..2e6d84710 100644 --- a/docs/rules/no-named-as-default-member.md +++ b/docs/rules/no-named-as-default-member.md @@ -1,6 +1,6 @@ # import/no-named-as-default-member -💼 This rule _warns_ in the following configs: ☑️ `recommended`, ⚠️ `warnings`. +💼 This rule _warns_ in the following configs: ☑️ `recommended`, 🚸 `warnings`. diff --git a/docs/rules/no-named-as-default.md b/docs/rules/no-named-as-default.md index dae0806f1..a88505c61 100644 --- a/docs/rules/no-named-as-default.md +++ b/docs/rules/no-named-as-default.md @@ -1,6 +1,6 @@ # import/no-named-as-default -💼 This rule _warns_ in the following configs: ☑️ `recommended`, ⚠️ `warnings`. +💼 This rule _warns_ in the following configs: ☑️ `recommended`, 🚸 `warnings`. diff --git a/package.json b/package.json index e41b216e7..208e761f9 100644 --- a/package.json +++ b/package.json @@ -33,7 +33,7 @@ "prepublishOnly": "safe-publish-latest && npm run build", "prepublish": "not-in-publish || npm run prepublishOnly", "preupdate:eslint-docs": "npm run build", - "update:eslint-docs": "eslint-doc-generator --rule-doc-title-format prefix-name --rule-doc-section-options false --split-by meta.docs.category --ignore-config stage-0 --config-emoji recommended,☑️" + "update:eslint-docs": "eslint-doc-generator --rule-doc-title-format prefix-name --rule-doc-section-options false --split-by meta.docs.category --ignore-config stage-0 --config-emoji recommended,☑️ --config-emoji warnings,🚸" }, "repository": { "type": "git",