Skip to content

Commit 5091816

Browse files
committed
docs: use 🚸 for warnings config
1 parent b1fef26 commit 5091816

File tree

5 files changed

+35
-35
lines changed

5 files changed

+35
-35
lines changed

README.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,24 @@ This plugin intends to support linting of ES2015+ (ES6+) import/export syntax, a
1919
☑️ Enabled in the `recommended` configuration.\
2020
☑️<sup>⚠️</sup> Warns in the `recommended` configuration.\
2121
❗ Enabled in the `errors` configuration.\
22-
⚠️ Warns in the `warnings` configuration.\
22+
🚸<sup>⚠️</sup> Warns in the `warnings` configuration.\
2323
⌨️<sup>🚫</sup> Disabled in the `typescript` configuration.\
2424
🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
2525
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).\
2626
❌ Deprecated.
2727

2828
### Helpful warnings
2929

30-
| Name                       | Description | 💼 | 🔧 | 💡 ||
31-
| :--------------------------------------------------------------------- | :------------------------------------------------------------------------------------ | :----------------- | :- | :- | :- |
32-
| [export](docs/rules/export.md) | Forbid any invalid exports, i.e. re-export of the same name. | ❗ ☑️ | | | |
33-
| [no-deprecated](docs/rules/no-deprecated.md) | Forbid imported names marked with `@deprecated` documentation tag. | | | | |
34-
| [no-empty-named-blocks](docs/rules/no-empty-named-blocks.md) | Forbid empty named import blocks. | | 🔧 | 💡 | |
35-
| [no-extraneous-dependencies](docs/rules/no-extraneous-dependencies.md) | Forbid the use of extraneous packages. | | | | |
36-
| [no-mutable-exports](docs/rules/no-mutable-exports.md) | Forbid the use of mutable exports with `var` or `let`. | | | | |
37-
| [no-named-as-default](docs/rules/no-named-as-default.md) | Forbid use of exported name as identifier of default export. | ☑️<sup>⚠️</sup> ⚠️ | | | |
38-
| [no-named-as-default-member](docs/rules/no-named-as-default-member.md) | Forbid use of exported name as property of default export. | ☑️<sup>⚠️</sup> ⚠️ | | | |
39-
| [no-unused-modules](docs/rules/no-unused-modules.md) | Forbid modules without exports, or exports without matching import in another module. | | | | |
30+
| Name                       | Description | 💼 | 🔧 | 💡 ||
31+
| :--------------------------------------------------------------------- | :------------------------------------------------------------------------------------ | :---------------------------------- | :- | :- | :- |
32+
| [export](docs/rules/export.md) | Forbid any invalid exports, i.e. re-export of the same name. | ❗ ☑️ | | | |
33+
| [no-deprecated](docs/rules/no-deprecated.md) | Forbid imported names marked with `@deprecated` documentation tag. | | | | |
34+
| [no-empty-named-blocks](docs/rules/no-empty-named-blocks.md) | Forbid empty named import blocks. | | 🔧 | 💡 | |
35+
| [no-extraneous-dependencies](docs/rules/no-extraneous-dependencies.md) | Forbid the use of extraneous packages. | | | | |
36+
| [no-mutable-exports](docs/rules/no-mutable-exports.md) | Forbid the use of mutable exports with `var` or `let`. | | | | |
37+
| [no-named-as-default](docs/rules/no-named-as-default.md) | Forbid use of exported name as identifier of default export. | ☑️<sup>⚠️</sup> <br>🚸<sup>⚠️</sup> | | | |
38+
| [no-named-as-default-member](docs/rules/no-named-as-default-member.md) | Forbid use of exported name as property of default export. | ☑️<sup>⚠️</sup> <br>🚸<sup>⚠️</sup> | | | |
39+
| [no-unused-modules](docs/rules/no-unused-modules.md) | Forbid modules without exports, or exports without matching import in another module. | | | | |
4040

4141
### Module systems
4242

@@ -69,26 +69,26 @@ This plugin intends to support linting of ES2015+ (ES6+) import/export syntax, a
6969

7070
### Style guide
7171

72-
| Name                            | Description | 💼 | 🔧 | 💡 ||
73-
| :------------------------------------------------------------------------------- | :------------------------------------------------------------------------- | :----------------- | :- | :- | :- |
74-
| [consistent-type-specifier-style](docs/rules/consistent-type-specifier-style.md) | Enforce or ban the use of inline type-only markers for named imports. | | 🔧 | | |
75-
| [dynamic-import-chunkname](docs/rules/dynamic-import-chunkname.md) | Enforce a leading comment with the webpackChunkName for dynamic imports. | | | | |
76-
| [exports-last](docs/rules/exports-last.md) | Ensure all exports appear after other statements. | | | | |
77-
| [extensions](docs/rules/extensions.md) | Ensure consistent use of file extension within the import path. | | | | |
78-
| [first](docs/rules/first.md) | Ensure all imports appear before other statements. | | 🔧 | | |
79-
| [group-exports](docs/rules/group-exports.md) | Prefer named exports to be grouped together in a single export declaration | | | | |
80-
| [imports-first](docs/rules/imports-first.md) | Replaced by `import/first`. | | 🔧 | ||
81-
| [max-dependencies](docs/rules/max-dependencies.md) | Enforce the maximum number of dependencies a module can have. | | | | |
82-
| [newline-after-import](docs/rules/newline-after-import.md) | Enforce a newline after import statements. | | 🔧 | | |
83-
| [no-anonymous-default-export](docs/rules/no-anonymous-default-export.md) | Forbid anonymous values as default exports. | | | | |
84-
| [no-default-export](docs/rules/no-default-export.md) | Forbid default exports. | | | | |
85-
| [no-duplicates](docs/rules/no-duplicates.md) | Forbid repeated import of the same module in multiple places. | ☑️<sup>⚠️</sup> ⚠️ | 🔧 | | |
86-
| [no-named-default](docs/rules/no-named-default.md) | Forbid named default exports. | | | | |
87-
| [no-named-export](docs/rules/no-named-export.md) | Forbid named exports. | | | | |
88-
| [no-namespace](docs/rules/no-namespace.md) | Forbid namespace (a.k.a. "wildcard" `*`) imports. | | 🔧 | | |
89-
| [no-unassigned-import](docs/rules/no-unassigned-import.md) | Forbid unassigned imports | | | | |
90-
| [order](docs/rules/order.md) | Enforce a convention in module import order. | | 🔧 | | |
91-
| [prefer-default-export](docs/rules/prefer-default-export.md) | Prefer a default export if module exports a single name. | | | | |
72+
| Name                            | Description | 💼 | 🔧 | 💡 ||
73+
| :------------------------------------------------------------------------------- | :------------------------------------------------------------------------- | :---------------------------------- | :- | :- | :- |
74+
| [consistent-type-specifier-style](docs/rules/consistent-type-specifier-style.md) | Enforce or ban the use of inline type-only markers for named imports. | | 🔧 | | |
75+
| [dynamic-import-chunkname](docs/rules/dynamic-import-chunkname.md) | Enforce a leading comment with the webpackChunkName for dynamic imports. | | | | |
76+
| [exports-last](docs/rules/exports-last.md) | Ensure all exports appear after other statements. | | | | |
77+
| [extensions](docs/rules/extensions.md) | Ensure consistent use of file extension within the import path. | | | | |
78+
| [first](docs/rules/first.md) | Ensure all imports appear before other statements. | | 🔧 | | |
79+
| [group-exports](docs/rules/group-exports.md) | Prefer named exports to be grouped together in a single export declaration | | | | |
80+
| [imports-first](docs/rules/imports-first.md) | Replaced by `import/first`. | | 🔧 | ||
81+
| [max-dependencies](docs/rules/max-dependencies.md) | Enforce the maximum number of dependencies a module can have. | | | | |
82+
| [newline-after-import](docs/rules/newline-after-import.md) | Enforce a newline after import statements. | | 🔧 | | |
83+
| [no-anonymous-default-export](docs/rules/no-anonymous-default-export.md) | Forbid anonymous values as default exports. | | | | |
84+
| [no-default-export](docs/rules/no-default-export.md) | Forbid default exports. | | | | |
85+
| [no-duplicates](docs/rules/no-duplicates.md) | Forbid repeated import of the same module in multiple places. | ☑️<sup>⚠️</sup> <br>🚸<sup>⚠️</sup> | 🔧 | | |
86+
| [no-named-default](docs/rules/no-named-default.md) | Forbid named default exports. | | | | |
87+
| [no-named-export](docs/rules/no-named-export.md) | Forbid named exports. | | | | |
88+
| [no-namespace](docs/rules/no-namespace.md) | Forbid namespace (a.k.a. "wildcard" `*`) imports. | | 🔧 | | |
89+
| [no-unassigned-import](docs/rules/no-unassigned-import.md) | Forbid unassigned imports | | | | |
90+
| [order](docs/rules/order.md) | Enforce a convention in module import order. | | 🔧 | | |
91+
| [prefer-default-export](docs/rules/prefer-default-export.md) | Prefer a default export if module exports a single name. | | | | |
9292

9393
<!-- end auto-generated rules list -->
9494

docs/rules/no-duplicates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# import/no-duplicates
22

3-
💼 This rule _warns_ in the following configs: ☑️ `recommended`, ⚠️ `warnings`.
3+
💼 This rule _warns_ in the following configs: ☑️ `recommended`, 🚸 `warnings`.
44

55
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
66

docs/rules/no-named-as-default-member.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# import/no-named-as-default-member
22

3-
💼 This rule _warns_ in the following configs: ☑️ `recommended`, ⚠️ `warnings`.
3+
💼 This rule _warns_ in the following configs: ☑️ `recommended`, 🚸 `warnings`.
44

55
<!-- end auto-generated rule header -->
66

docs/rules/no-named-as-default.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# import/no-named-as-default
22

3-
💼 This rule _warns_ in the following configs: ☑️ `recommended`, ⚠️ `warnings`.
3+
💼 This rule _warns_ in the following configs: ☑️ `recommended`, 🚸 `warnings`.
44

55
<!-- end auto-generated rule header -->
66

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
"prepublishOnly": "safe-publish-latest && npm run build",
3434
"prepublish": "not-in-publish || npm run prepublishOnly",
3535
"preupdate:eslint-docs": "npm run build",
36-
"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,☑️"
36+
"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,🚸"
3737
},
3838
"repository": {
3939
"type": "git",

0 commit comments

Comments
 (0)