feat: add support for flat config (#479)

ota-meshi · web-flow · commit ecbce9faef0c · 2024-07-01T09:59:47.000+08:00
diff --git a/.eslint-doc-generatorrc.js b/.eslint-doc-generatorrc.js
@@ -0,0 +1,10 @@
+/** @type {import('eslint-doc-generator').GenerateOptions} */
+module.exports = {
+  configEmoji: [
+    ['recommended', '✅'],
+    ['flat/recommended', '✅'],
+  ],
+  postprocess: (doc) => {
+    return doc.replace(/✅\s*✅/gu, '✅')
+  },
+}
diff --git a/README.md b/README.md
@@ -68,11 +68,23 @@ Then configure the rules you want to use under the rules section.
 
 or start with the recommended rule set:
 
-```json
-{
-  "extends": ["plugin:promise/recommended"]
-}
-```
+- `eslint.config.js`:
+
+  ```js
+  import pluginPromise from 'eslint-plugin-promise'
+  export default [
+    // ...
+    pluginPromise.configs['flat/recommended'],
+  ]
+  ```
+
+- `.eslintrc.*`:
+
+  ```json
+  {
+    "extends": ["plugin:promise/recommended"]
+  }
+  ```
 
 ## Rules
 
@@ -81,9 +93,9 @@ or start with the recommended rule set:
 💼 Configurations enabled in.\
 ⚠️ Configurations set to warn in.\
 🚫 Configurations disabled in.\
+✅ Set in the `flat/recommended` configuration.\
 ✅ Set in the `recommended` configuration.\
-🔧 Automatically fixable by the
-[`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
+🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
 
 | Name                                                                 | Description                                                                            | 💼  | ⚠️  | 🚫  | 🔧  |
 | :------------------------------------------------------------------- | :------------------------------------------------------------------------------------- | :-- | :-- | :-- | :-- |
diff --git a/__tests__/index.js b/__tests__/index.js
@@ -3,3 +3,11 @@
 test('can require index file', () => {
   expect(require('../index')).toBeInstanceOf(Object)
 })
+
+test('rule set', () => {
+  const plugin = require('../index')
+  expect(plugin.configs.recommended.rules).toEqual(
+    plugin.configs['flat/recommended'].rules
+  )
+  expect(plugin.configs['flat/recommended'].plugins.promise).toBe(plugin)
+})
diff --git a/docs/rules/always-return.md b/docs/rules/always-return.md
@@ -1,6 +1,7 @@
 # Require returning inside each `then()` to create readable and reusable Promise chains (`promise/always-return`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ✅ `flat/recommended`, ✅
+`recommended`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/avoid-new.md b/docs/rules/avoid-new.md
@@ -1,6 +1,7 @@
 # Disallow creating `new` promises outside of utility libs (use [pify][] instead) (`promise/avoid-new`)
 
-🚫 This rule is _disabled_ in the ✅ `recommended` config.
+🚫 This rule is _disabled_ in the following configs: ✅ `flat/recommended`, ✅
+`recommended`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/catch-or-return.md b/docs/rules/catch-or-return.md
@@ -1,6 +1,7 @@
 # Enforce the use of `catch()` on un-returned promises (`promise/catch-or-return`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ✅ `flat/recommended`, ✅
+`recommended`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/no-callback-in-promise.md b/docs/rules/no-callback-in-promise.md
@@ -1,6 +1,7 @@
 # Disallow calling `cb()` inside of a `then()` (use [nodeify][] instead) (`promise/no-callback-in-promise`)
 
-⚠️ This rule _warns_ in the ✅ `recommended` config.
+⚠️ This rule _warns_ in the following configs: ✅ `flat/recommended`, ✅
+`recommended`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/no-native.md b/docs/rules/no-native.md
@@ -1,6 +1,7 @@
 # Require creating a `Promise` constructor before using it in an ES5 environment (`promise/no-native`)
 
-🚫 This rule is _disabled_ in the ✅ `recommended` config.
+🚫 This rule is _disabled_ in the following configs: ✅ `flat/recommended`, ✅
+`recommended`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/no-nesting.md b/docs/rules/no-nesting.md
@@ -1,6 +1,7 @@
 # Disallow nested `then()` or `catch()` statements (`promise/no-nesting`)
 
-⚠️ This rule _warns_ in the ✅ `recommended` config.
+⚠️ This rule _warns_ in the following configs: ✅ `flat/recommended`, ✅
+`recommended`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/no-new-statics.md b/docs/rules/no-new-statics.md
@@ -1,6 +1,7 @@
 # Disallow calling `new` on a Promise static method (`promise/no-new-statics`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ✅ `flat/recommended`, ✅
+`recommended`.
 
 🔧 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-promise-in-callback.md b/docs/rules/no-promise-in-callback.md
@@ -1,5 +1,6 @@
 # Disallow using promises inside of callbacks (`promise/no-promise-in-callback`)
 
-⚠️ This rule _warns_ in the ✅ `recommended` config.
+⚠️ This rule _warns_ in the following configs: ✅ `flat/recommended`, ✅
+`recommended`.
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/no-return-in-finally.md b/docs/rules/no-return-in-finally.md
@@ -1,6 +1,7 @@
 # Disallow return statements in `finally()` (`promise/no-return-in-finally`)
 
-⚠️ This rule _warns_ in the ✅ `recommended` config.
+⚠️ This rule _warns_ in the following configs: ✅ `flat/recommended`, ✅
+`recommended`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/no-return-wrap.md b/docs/rules/no-return-wrap.md
@@ -1,6 +1,7 @@
 # Disallow wrapping values in `Promise.resolve` or `Promise.reject` when not needed (`promise/no-return-wrap`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ✅ `flat/recommended`, ✅
+`recommended`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/param-names.md b/docs/rules/param-names.md
@@ -1,6 +1,7 @@
 # Enforce consistent param names and ordering when creating new promises (`promise/param-names`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ✅ `flat/recommended`, ✅
+`recommended`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/valid-params.md b/docs/rules/valid-params.md
@@ -1,6 +1,7 @@
 # Enforces the proper number of arguments are passed to Promise functions (`promise/valid-params`)
 
-⚠️ This rule _warns_ in the ✅ `recommended` config.
+⚠️ This rule _warns_ in the following configs: ✅ `flat/recommended`, ✅
+`recommended`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/index.js b/index.js
@@ -1,6 +1,21 @@
 'use strict'
 
-module.exports = {
+const recommendedRules = {
+  'promise/always-return': 'error',
+  'promise/no-return-wrap': 'error',
+  'promise/param-names': 'error',
+  'promise/catch-or-return': 'error',
+  'promise/no-native': 'off',
+  'promise/no-nesting': 'warn',
+  'promise/no-promise-in-callback': 'warn',
+  'promise/no-callback-in-promise': 'warn',
+  'promise/avoid-new': 'off',
+  'promise/no-new-statics': 'error',
+  'promise/no-return-in-finally': 'warn',
+  'promise/valid-params': 'warn',
+}
+
+const pluginPromise = {
   rules: {
     'param-names': require('./rules/param-names'),
     'no-return-wrap': require('./rules/no-return-wrap'),
@@ -25,23 +40,15 @@ module.exports = {
     'no-native': 0,
     'catch-or-return': 1,
   },
-  configs: {
-    recommended: {
-      plugins: ['promise'],
-      rules: {
-        'promise/always-return': 'error',
-        'promise/no-return-wrap': 'error',
-        'promise/param-names': 'error',
-        'promise/catch-or-return': 'error',
-        'promise/no-native': 'off',
-        'promise/no-nesting': 'warn',
-        'promise/no-promise-in-callback': 'warn',
-        'promise/no-callback-in-promise': 'warn',
-        'promise/avoid-new': 'off',
-        'promise/no-new-statics': 'error',
-        'promise/no-return-in-finally': 'warn',
-        'promise/valid-params': 'warn',
-      },
-    },
+}
+pluginPromise.configs = {
+  recommended: {
+    plugins: ['promise'],
+    rules: recommendedRules,
+  },
+  'flat/recommended': {
+    plugins: { promise: pluginPromise },
+    rules: recommendedRules,
   },
 }
+module.exports = pluginPromise
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
