Add support for flat config (#702)

ota-meshi · Mar 9, 2024 · 5a11e3c · 5a11e3c
1 parent eb3c724
commit 5a11e3c
Show file tree

Hide file tree

Showing 84 changed files with 518 additions and 384 deletions.
diff --git a/.changeset/honest-taxis-collect.md b/.changeset/honest-taxis-collect.md
@@ -0,0 +1,5 @@
+---
+"eslint-plugin-regexp": minor
+---
+
+Add support for flat config
diff --git a/.eslint-doc-generatorrc.js b/.eslint-doc-generatorrc.js
@@ -1,7 +1,10 @@
 /** @type {import('eslint-doc-generator').GenerateOptions} */
-const config = {
-  configFormat: 'plugin-colon-prefix-name',
-  ignoreConfig: ['all'],
+const config = {  
+  ignoreConfig: ['all', 'flat/all'],
+  configEmoji: [
+      ["recommended", "🔵"],
+      ["flat/recommended", "🟢"],
+  ],
   pathRuleList: ['README.md', 'docs/rules/index.md'],
   ruleDocSectionInclude: ['Rule Details', 'Version', 'Implementation'],
   ruleDocSectionOptions: false,

diff --git a/.eslintignore b/.eslintignore
@@ -10,3 +10,4 @@
 !/.vscode
 !/.github
 /tests/fixtures/integrations/eslint-plugin/test.js
+/tests/fixtures/integrations/eslint-plugin-legacy-config/test.js
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -101,6 +101,12 @@ module.exports = {
         "regexp/unicode-escape": "error",
     },
     overrides: [
+        {
+            files: ["*.mjs"],
+            parserOptions: {
+                sourceType: "module",
+            },
+        },
         {
             files: ["*.ts"],
             parser: "@typescript-eslint/parser",
@@ -127,6 +133,7 @@ module.exports = {
             rules: {
                 "require-jsdoc": "off",
                 "no-console": "off",
+                "n/file-extension-in-import": "off",
             },
         },
         {

diff --git a/.github/workflows/NodeCI.yml b/.github/workflows/NodeCI.yml
@@ -37,6 +37,8 @@ jobs:
               # run: npm ci
               # We use `npm i` because there is an error regarding dependencies when installing eslint v9-alpha.
               run: npm i -f
+            - name: Build
+              run: npm run build
             - name: Test
               run: npm test
     test-and-coverage:
@@ -46,6 +48,8 @@ jobs:
             - uses: actions/setup-node@v4
             - name: Install Packages
               run: npm ci
+            - name: Build
+              run: npm run build
             - name: Test
               run: npm run test:nyc
             - name: Coveralls GitHub Action

diff --git a/README.md b/README.md
diff --git a/docs/rules/confusing-quantifier.md b/docs/rules/confusing-quantifier.md
@@ -7,7 +7,7 @@ since: "v0.8.0"
 ---
 # regexp/confusing-quantifier
 
-⚠️ This rule _warns_ in the ✅ `plugin:regexp/recommended` config.
+⚠️ This rule _warns_ in the following configs: 🟢 `flat/recommended`, 🔵 `recommended`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/control-character-escape.md b/docs/rules/control-character-escape.md
@@ -7,7 +7,7 @@ since: "v0.9.0"
 ---
 # regexp/control-character-escape
 
-💼 This rule is enabled in the ✅ `plugin:regexp/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/index.md b/docs/rules/index.md
diff --git a/docs/rules/match-any.md b/docs/rules/match-any.md
@@ -7,7 +7,7 @@ since: "v0.1.0"
 ---
 # regexp/match-any
 
-💼 This rule is enabled in the ✅ `plugin:regexp/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/negation.md b/docs/rules/negation.md
@@ -7,7 +7,7 @@ since: "v0.4.0"
 ---
 # regexp/negation
 
-💼 This rule is enabled in the ✅ `plugin:regexp/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-contradiction-with-assertion.md b/docs/rules/no-contradiction-with-assertion.md
@@ -7,9 +7,9 @@ since: "v1.2.0"
 ---
 # regexp/no-contradiction-with-assertion
 
-💼 This rule is enabled in the ✅ `plugin:regexp/recommended` config.
+💼 This rule is enabled in the following configs: 🟢 `flat/recommended`, 🔵 `recommended`.
 
-💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-control-character.md b/docs/rules/no-control-character.md
@@ -7,7 +7,7 @@ since: "v1.2.0"
 ---
 # regexp/no-control-character
 
-💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-dupe-characters-character-class.md b/docs/rules/no-dupe-characters-character-class.md
@@ -7,7 +7,7 @@ since: "v0.1.0"
 ---
 # regexp/no-dupe-characters-character-class
 
-💼 This rule is enabled in the ✅ `plugin:regexp/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-dupe-disjunctions.md b/docs/rules/no-dupe-disjunctions.md
@@ -7,9 +7,9 @@ since: "v0.4.0"
 ---
 # regexp/no-dupe-disjunctions
 
-💼 This rule is enabled in the ✅ `plugin:regexp/recommended` config.
+💼 This rule is enabled in the following configs: 🟢 `flat/recommended`, 🔵 `recommended`.
 
-💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-empty-alternative.md b/docs/rules/no-empty-alternative.md
@@ -7,9 +7,9 @@ since: "v0.8.0"
 ---
 # regexp/no-empty-alternative
 
-⚠️ This rule _warns_ in the ✅ `plugin:regexp/recommended` config.
+⚠️ This rule _warns_ in the following configs: 🟢 `flat/recommended`, 🔵 `recommended`.
 
-💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-empty-capturing-group.md b/docs/rules/no-empty-capturing-group.md
@@ -7,7 +7,7 @@ since: "v0.12.0"
 ---
 # regexp/no-empty-capturing-group
 
-💼 This rule is enabled in the ✅ `plugin:regexp/recommended` config.
+💼 This rule is enabled in the following configs: 🟢 `flat/recommended`, 🔵 `recommended`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-empty-character-class.md b/docs/rules/no-empty-character-class.md
@@ -7,7 +7,7 @@ since: "v1.2.0"
 ---
 # regexp/no-empty-character-class
 
-💼 This rule is enabled in the ✅ `plugin:regexp/recommended` config.
+💼 This rule is enabled in the following configs: 🟢 `flat/recommended`, 🔵 `recommended`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-empty-group.md b/docs/rules/no-empty-group.md
@@ -7,7 +7,7 @@ since: "v0.1.0"
 ---
 # regexp/no-empty-group
 
-💼 This rule is enabled in the ✅ `plugin:regexp/recommended` config.
+💼 This rule is enabled in the following configs: 🟢 `flat/recommended`, 🔵 `recommended`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-empty-lookarounds-assertion.md b/docs/rules/no-empty-lookarounds-assertion.md
@@ -7,7 +7,7 @@ since: "v0.1.0"
 ---
 # regexp/no-empty-lookarounds-assertion
 
-💼 This rule is enabled in the ✅ `plugin:regexp/recommended` config.
+💼 This rule is enabled in the following configs: 🟢 `flat/recommended`, 🔵 `recommended`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-empty-string-literal.md b/docs/rules/no-empty-string-literal.md
@@ -7,7 +7,7 @@ since: "v2.0.0-next.11"
 ---
 # regexp/no-empty-string-literal
 
-💼 This rule is enabled in the ✅ `plugin:regexp/recommended` config.
+💼 This rule is enabled in the following configs: 🟢 `flat/recommended`, 🔵 `recommended`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-escape-backspace.md b/docs/rules/no-escape-backspace.md
@@ -7,9 +7,9 @@ since: "v0.1.0"
 ---
 # regexp/no-escape-backspace
 
-💼 This rule is enabled in the ✅ `plugin:regexp/recommended` config.
+💼 This rule is enabled in the following configs: 🟢 `flat/recommended`, 🔵 `recommended`.
 
-💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-extra-lookaround-assertions.md b/docs/rules/no-extra-lookaround-assertions.md
@@ -7,7 +7,7 @@ since: "v1.11.0"
 ---
 # regexp/no-extra-lookaround-assertions
 
-💼 This rule is enabled in the ✅ `plugin:regexp/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-invalid-regexp.md b/docs/rules/no-invalid-regexp.md
@@ -7,7 +7,7 @@ since: "v1.0.0"
 ---
 # regexp/no-invalid-regexp
 
-💼 This rule is enabled in the ✅ `plugin:regexp/recommended` config.
+💼 This rule is enabled in the following configs: 🟢 `flat/recommended`, 🔵 `recommended`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-invisible-character.md b/docs/rules/no-invisible-character.md
@@ -7,7 +7,7 @@ since: "v0.1.0"
 ---
 # regexp/no-invisible-character
 
-💼 This rule is enabled in the ✅ `plugin:regexp/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-lazy-ends.md b/docs/rules/no-lazy-ends.md
@@ -7,9 +7,9 @@ since: "v0.8.0"
 ---
 # regexp/no-lazy-ends
 
-⚠️ This rule _warns_ in the ✅ `plugin:regexp/recommended` config.
+⚠️ This rule _warns_ in the following configs: 🟢 `flat/recommended`, 🔵 `recommended`.
 
-💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-legacy-features.md b/docs/rules/no-legacy-features.md
@@ -7,7 +7,7 @@ since: "v0.6.0"
 ---
 # regexp/no-legacy-features
 
-💼 This rule is enabled in the ✅ `plugin:regexp/recommended` config.
+💼 This rule is enabled in the following configs: 🟢 `flat/recommended`, 🔵 `recommended`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-misleading-capturing-group.md b/docs/rules/no-misleading-capturing-group.md
@@ -7,9 +7,9 @@ since: "v1.12.0"
 ---
 # regexp/no-misleading-capturing-group
 
-💼 This rule is enabled in the ✅ `plugin:regexp/recommended` config.
+💼 This rule is enabled in the following configs: 🟢 `flat/recommended`, 🔵 `recommended`.
 
-💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-misleading-unicode-character.md b/docs/rules/no-misleading-unicode-character.md
@@ -7,9 +7,9 @@ since: "v1.2.0"
 ---
 # regexp/no-misleading-unicode-character
 
-💼 This rule is enabled in the ✅ `plugin:regexp/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) and manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+🔧💡 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-missing-g-flag.md b/docs/rules/no-missing-g-flag.md
@@ -7,7 +7,7 @@ since: "v1.10.0"
 ---
 # regexp/no-missing-g-flag
 
-💼 This rule is enabled in the ✅ `plugin:regexp/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-non-standard-flag.md b/docs/rules/no-non-standard-flag.md
@@ -7,7 +7,7 @@ since: "v0.9.0"
 ---
 # regexp/no-non-standard-flag
 
-💼 This rule is enabled in the ✅ `plugin:regexp/recommended` config.
+💼 This rule is enabled in the following configs: 🟢 `flat/recommended`, 🔵 `recommended`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-obscure-range.md b/docs/rules/no-obscure-range.md
@@ -7,7 +7,7 @@ since: "v0.9.0"
 ---
 # regexp/no-obscure-range
 
-💼 This rule is enabled in the ✅ `plugin:regexp/recommended` config.
+💼 This rule is enabled in the following configs: 🟢 `flat/recommended`, 🔵 `recommended`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-octal.md b/docs/rules/no-octal.md
@@ -7,7 +7,7 @@ since: "v0.1.0"
 ---
 # regexp/no-octal
 
-💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-optional-assertion.md b/docs/rules/no-optional-assertion.md
@@ -7,7 +7,7 @@ since: "v0.9.0"
 ---
 # regexp/no-optional-assertion
 
-💼 This rule is enabled in the ✅ `plugin:regexp/recommended` config.
+💼 This rule is enabled in the following configs: 🟢 `flat/recommended`, 🔵 `recommended`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-potentially-useless-backreference.md b/docs/rules/no-potentially-useless-backreference.md
@@ -7,7 +7,7 @@ since: "v0.9.0"
 ---
 # regexp/no-potentially-useless-backreference
 
-⚠️ This rule _warns_ in the ✅ `plugin:regexp/recommended` config.
+⚠️ This rule _warns_ in the following configs: 🟢 `flat/recommended`, 🔵 `recommended`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-super-linear-backtracking.md b/docs/rules/no-super-linear-backtracking.md
@@ -7,7 +7,7 @@ since: "v0.13.0"
 ---
 # regexp/no-super-linear-backtracking
 
-💼 This rule is enabled in the ✅ `plugin:regexp/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-trivially-nested-assertion.md b/docs/rules/no-trivially-nested-assertion.md
@@ -7,7 +7,7 @@ since: "v0.9.0"
 ---
 # regexp/no-trivially-nested-assertion
 
-💼 This rule is enabled in the ✅ `plugin:regexp/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-trivially-nested-quantifier.md b/docs/rules/no-trivially-nested-quantifier.md
@@ -7,7 +7,7 @@ since: "v0.9.0"
 ---
 # regexp/no-trivially-nested-quantifier
 
-💼 This rule is enabled in the ✅ `plugin:regexp/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-unused-capturing-group.md b/docs/rules/no-unused-capturing-group.md
@@ -7,9 +7,9 @@ since: "v0.6.0"
 ---
 # regexp/no-unused-capturing-group
 
-💼 This rule is enabled in the ✅ `plugin:regexp/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) and manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+🔧💡 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-useless-assertions.md b/docs/rules/no-useless-assertions.md
@@ -7,9 +7,9 @@ since: "v0.9.0"
 ---
 # regexp/no-useless-assertions
 
-💼 This rule is enabled in the ✅ `plugin:regexp/recommended` config.
+💼 This rule is enabled in the following configs: 🟢 `flat/recommended`, 🔵 `recommended`.
 
-💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-useless-backreference.md b/docs/rules/no-useless-backreference.md
@@ -7,7 +7,7 @@ since: "v0.1.0"
 ---
 # regexp/no-useless-backreference
 
-💼 This rule is enabled in the ✅ `plugin:regexp/recommended` config.
+💼 This rule is enabled in the following configs: 🟢 `flat/recommended`, 🔵 `recommended`.
 
 <!-- end auto-generated rule header -->