Skip to content

Commit 9ddd7a5

Browse files
committed
fix docs
1 parent 7ed4246 commit 9ddd7a5

16 files changed

+226
-87
lines changed

β€Ž.eslint-doc-generatorrc.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
/** @type {import('eslint-doc-generator').GenerateOptions} */
2+
module.exports = {
3+
configEmoji: [
4+
['recommended', 'βœ…'],
5+
['flat/recommended', 'βœ…'],
6+
],
7+
postprocess: (doc) => {
8+
return doc.replace(/βœ…\s*βœ…/gu, 'βœ…')
9+
},
10+
}

β€ŽREADME.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,9 @@ or start with the recommended rule set:
9393
πŸ’Ό Configurations enabled in.\
9494
⚠️ Configurations set to warn in.\
9595
🚫 Configurations disabled in.\
96+
βœ… Set in the `flat/recommended` configuration.\
9697
βœ… Set in the `recommended` configuration.\
97-
πŸ”§ Automatically fixable by the
98-
[`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
98+
πŸ”§ Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
9999

100100
| NameΒ Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β  | Description | πŸ’Ό | ⚠️ | 🚫 | πŸ”§ |
101101
| :------------------------------------------------------------------- | :------------------------------------------------------------------------------------- | :-- | :-- | :-- | :-- |

β€Ždocs/rules/always-return.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Require returning inside each `then()` to create readable and reusable Promise chains (`promise/always-return`)
22

3-
πŸ’Ό This rule is enabled in the βœ… `recommended` config.
3+
πŸ’Ό This rule is enabled in the following configs: βœ… `flat/recommended`, βœ…
4+
`recommended`.
45

56
<!-- end auto-generated rule header -->
67

β€Ždocs/rules/avoid-new.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Disallow creating `new` promises outside of utility libs (use [pify][] instead) (`promise/avoid-new`)
22

3-
🚫 This rule is _disabled_ in the βœ… `recommended` config.
3+
🚫 This rule is _disabled_ in the following configs: βœ… `flat/recommended`, βœ…
4+
`recommended`.
45

56
<!-- end auto-generated rule header -->
67

β€Ždocs/rules/catch-or-return.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Enforce the use of `catch()` on un-returned promises (`promise/catch-or-return`)
22

3-
πŸ’Ό This rule is enabled in the βœ… `recommended` config.
3+
πŸ’Ό This rule is enabled in the following configs: βœ… `flat/recommended`, βœ…
4+
`recommended`.
45

56
<!-- end auto-generated rule header -->
67

β€Ždocs/rules/no-callback-in-promise.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Disallow calling `cb()` inside of a `then()` (use [nodeify][] instead) (`promise/no-callback-in-promise`)
22

3-
⚠️ This rule _warns_ in the βœ… `recommended` config.
3+
⚠️ This rule _warns_ in the following configs: βœ… `flat/recommended`, βœ…
4+
`recommended`.
45

56
<!-- end auto-generated rule header -->
67

β€Ždocs/rules/no-native.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Require creating a `Promise` constructor before using it in an ES5 environment (`promise/no-native`)
22

3-
🚫 This rule is _disabled_ in the βœ… `recommended` config.
3+
🚫 This rule is _disabled_ in the following configs: βœ… `flat/recommended`, βœ…
4+
`recommended`.
45

56
<!-- end auto-generated rule header -->
67

β€Ždocs/rules/no-nesting.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Disallow nested `then()` or `catch()` statements (`promise/no-nesting`)
22

3-
⚠️ This rule _warns_ in the βœ… `recommended` config.
3+
⚠️ This rule _warns_ in the following configs: βœ… `flat/recommended`, βœ…
4+
`recommended`.
45

56
<!-- end auto-generated rule header -->
67

β€Ždocs/rules/no-new-statics.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Disallow calling `new` on a Promise static method (`promise/no-new-statics`)
22

3-
πŸ’Ό This rule is enabled in the βœ… `recommended` config.
3+
πŸ’Ό This rule is enabled in the following configs: βœ… `flat/recommended`, βœ…
4+
`recommended`.
45

56
πŸ”§ This rule is automatically fixable by the
67
[`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Disallow using promises inside of callbacks (`promise/no-promise-in-callback`)
22

3-
⚠️ This rule _warns_ in the βœ… `recommended` config.
3+
⚠️ This rule _warns_ in the following configs: βœ… `flat/recommended`, βœ…
4+
`recommended`.
45

56
<!-- end auto-generated rule header -->

β€Ždocs/rules/no-return-in-finally.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Disallow return statements in `finally()` (`promise/no-return-in-finally`)
22

3-
⚠️ This rule _warns_ in the βœ… `recommended` config.
3+
⚠️ This rule _warns_ in the following configs: βœ… `flat/recommended`, βœ…
4+
`recommended`.
45

56
<!-- end auto-generated rule header -->
67

β€Ždocs/rules/no-return-wrap.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Disallow wrapping values in `Promise.resolve` or `Promise.reject` when not needed (`promise/no-return-wrap`)
22

3-
πŸ’Ό This rule is enabled in the βœ… `recommended` config.
3+
πŸ’Ό This rule is enabled in the following configs: βœ… `flat/recommended`, βœ…
4+
`recommended`.
45

56
<!-- end auto-generated rule header -->
67

β€Ždocs/rules/param-names.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Enforce consistent param names and ordering when creating new promises (`promise/param-names`)
22

3-
πŸ’Ό This rule is enabled in the βœ… `recommended` config.
3+
πŸ’Ό This rule is enabled in the following configs: βœ… `flat/recommended`, βœ…
4+
`recommended`.
45

56
<!-- end auto-generated rule header -->
67

β€Ždocs/rules/valid-params.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Enforces the proper number of arguments are passed to Promise functions (`promise/valid-params`)
22

3-
⚠️ This rule _warns_ in the βœ… `recommended` config.
3+
⚠️ This rule _warns_ in the following configs: βœ… `flat/recommended`, βœ…
4+
`recommended`.
45

56
<!-- end auto-generated rule header -->
67

0 commit comments

Comments
Β (0)