Add no-symbol-* rules (#264)

ota-meshi · web-flow · commit 6fff93da0121 · 2025-06-27T15:41:56.000+09:00
diff --git a/.changeset/no-string-matchall.md b/.changeset/no-string-matchall.md
@@ -0,0 +1,5 @@
+---
+"eslint-plugin-es-x": minor
+---
+
+Add `no-string-matchall` config.
diff --git a/.changeset/no-symbol-asyncdispose.md b/.changeset/no-symbol-asyncdispose.md
@@ -0,0 +1,5 @@
+---
+"eslint-plugin-es-x": minor
+---
+
+Add `es-x/no-symbol-asyncdispose` rule
diff --git a/.changeset/no-symbol-dispose.md b/.changeset/no-symbol-dispose.md
@@ -0,0 +1,5 @@
+---
+"eslint-plugin-es-x": minor
+---
+
+Add `es-x/no-symbol-dispose` rule
diff --git a/.changeset/no-symbol-matchall.md b/.changeset/no-symbol-matchall.md
@@ -0,0 +1,5 @@
+---
+"eslint-plugin-es-x": minor
+---
+
+Add `es-x/no-symbol-matchall` rule
diff --git a/.changeset/real-kiwis-love.md b/.changeset/real-kiwis-love.md
@@ -0,0 +1,5 @@
+---
+"eslint-plugin-es-x": major
+---
+
+Update configs: `no-new-in-es2020`, and `restrict-to-es3` - `restrict-to-es2019`.
diff --git a/docs/configs/index.md b/docs/configs/index.md
@@ -1401,5 +1401,32 @@ export default [
 }
 ```
 
+## no-string-matchall
+
+disallow proposal ES2020 [String.prototype.matchAll](https://github.com/tc39/proposal-string-matchall)
+
+This configs includes rules for [es-x/no-string-prototype-matchall](../rules/no-string-prototype-matchall.md) and [es-x/no-symbol-matchall](../rules/no-symbol-matchall.md).
+
+### [Config (Flat Config)]
+
+eslint.config.js:
+
+```js
+import pluginESx from "eslint-plugin-es-x"
+export default [
+    pluginESx.configs['flat/no-string-matchall']
+]
+```
+
+### [Legacy Config]
+
+.eslintrc.*:
+
+```json
+{
+    "extends": ["plugin:es-x/no-string-matchall"],
+}
+```
+
 [Config (Flat Config)]: https://eslint.org/docs/latest/use/configure/configuration-files
 [Legacy Config]: https://eslint.org/docs/latest/use/configure/configuration-files-deprecated
diff --git a/docs/rules/index.md b/docs/rules/index.md
@@ -52,6 +52,8 @@ There are multiple configs that enable all rules in this category: [`no-new-in-e
 | [es-x/no-set-prototype-issupersetof](./no-set-prototype-issupersetof.md) | disallow the `Set.prototype.isSupersetOf` method. |  |
 | [es-x/no-set-prototype-symmetricdifference](./no-set-prototype-symmetricdifference.md) | disallow the `Set.prototype.symmetricDifference` method. |  |
 | [es-x/no-set-prototype-union](./no-set-prototype-union.md) | disallow the `Set.prototype.union` method. |  |
+| [es-x/no-symbol-asyncdispose](./no-symbol-asyncdispose.md) | disallow the `Symbol.asyncDispose` property. |  |
+| [es-x/no-symbol-dispose](./no-symbol-dispose.md) | disallow the `Symbol.dispose` property. |  |
 | [es-x/no-trailing-dynamic-import-commas](./no-trailing-dynamic-import-commas.md) | disallow trailing commas in `import()`. | 🔧 |
 
 ## ES2025 Intl API
@@ -171,6 +173,7 @@ There are multiple configs that enable all rules in this category: [`no-new-in-e
 | [es-x/no-promise-all-settled](./no-promise-all-settled.md) | disallow `Promise.allSettled` function. |  |
 | [es-x/no-regexp-unicode-property-escapes-2020](./no-regexp-unicode-property-escapes-2020.md) | disallow the new values of RegExp Unicode property escape sequences in ES2020. |  |
 | [es-x/no-string-prototype-matchall](./no-string-prototype-matchall.md) | disallow the `String.prototype.matchAll` method. |  |
+| [es-x/no-symbol-matchall](./no-symbol-matchall.md) | disallow the `Symbol.matchAll` property. |  |
 
 ## ES2020 Intl API
 
diff --git a/docs/rules/no-string-prototype-matchall.md b/docs/rules/no-string-prototype-matchall.md
@@ -7,7 +7,7 @@ since: "[eslint-plugin-es] v5.0.0"
 # es-x/no-string-prototype-matchall
 > disallow the `String.prototype.matchAll` method
 
-- ✅ The following configurations enable this rule: [no-new-in-es2020], [restrict-to-es3], [restrict-to-es5], [restrict-to-es2015], [restrict-to-es2016], [restrict-to-es2017], [restrict-to-es2018], and [restrict-to-es2019]
+- ✅ The following configurations enable this rule: [no-new-in-es2020], [no-string-matchall], [restrict-to-es3], [restrict-to-es5], [restrict-to-es2015], [restrict-to-es2016], [restrict-to-es2017], [restrict-to-es2018], and [restrict-to-es2019]
 
 This rule reports ES2020 [`String.prototype.matchAll` method](https://github.com/tc39/proposal-string-matchall) as errors.
 
@@ -66,6 +66,7 @@ This rule was introduced in [eslint-plugin-es] v5.0.0.
 - [Test source](https://github.com/eslint-community/eslint-plugin-es-x/blob/master/tests/lib/rules/no-string-prototype-matchall.js)
 
 [no-new-in-es2020]: ../configs/index.md#no-new-in-es2020
+[no-string-matchall]: ../configs/index.md#no-string-matchall
 [restrict-to-es3]: ../configs/index.md#restrict-to-es3
 [restrict-to-es5]: ../configs/index.md#restrict-to-es5
 [restrict-to-es2015]: ../configs/index.md#restrict-to-es2015
diff --git a/docs/rules/no-symbol-asyncdispose.md b/docs/rules/no-symbol-asyncdispose.md
@@ -0,0 +1,66 @@
+---
+title: "es-x/no-symbol-asyncdispose"
+description: "disallow the `Symbol.asyncDispose` property"
+---
+
+# es-x/no-symbol-asyncdispose
+> disallow the `Symbol.asyncDispose` property
+
+- ❗ <badge text="This rule has not been released yet." vertical="middle" type="error"> ***This rule has not been released yet.*** </badge>
+- ✅ The following configurations enable this rule: [no-new-in-es2025], [restrict-to-es3], [restrict-to-es5], [restrict-to-es2015], [restrict-to-es2016], [restrict-to-es2017], [restrict-to-es2018], [restrict-to-es2019], [restrict-to-es2020], [restrict-to-es2021], [restrict-to-es2022], [restrict-to-es2023], and [restrict-to-es2024]
+
+This rule reports ES2025 [`Symbol.asyncDispose` property]($$LINK$$) as errors.
+
+## 💡 Examples
+
+⛔ Examples of **incorrect** code for this rule:
+
+<eslint-playground type="bad">
+
+```js
+/*eslint es-x/no-symbol-asyncdispose: error */
+x[Symbol.asyncDispose];
+```
+
+</eslint-playground>
+
+## 🔧 Options
+
+This rule has an option.
+
+```jsonc
+{
+  "rules": {
+    "es-x/no-symbol-asyncdispose": [
+      "error",
+      {
+        "allowTestedProperty": false
+      }
+    ]
+  }
+}
+```
+
+### allowTestedProperty: boolean
+
+Configure the allowTestedProperty mode for only this rule.
+This is prior to the `settings['es-x'].allowTestedProperty` setting.
+
+## 📚 References
+
+- [Rule source](https://github.com/eslint-community/eslint-plugin-es-x/blob/master/lib/rules/no-symbol-asyncdispose.js)
+- [Test source](https://github.com/eslint-community/eslint-plugin-es-x/blob/master/tests/lib/rules/no-symbol-asyncdispose.js)
+
+[no-new-in-es2025]: ../configs/index.md#no-new-in-es2025
+[restrict-to-es3]: ../configs/index.md#restrict-to-es3
+[restrict-to-es5]: ../configs/index.md#restrict-to-es5
+[restrict-to-es2015]: ../configs/index.md#restrict-to-es2015
+[restrict-to-es2016]: ../configs/index.md#restrict-to-es2016
+[restrict-to-es2017]: ../configs/index.md#restrict-to-es2017
+[restrict-to-es2018]: ../configs/index.md#restrict-to-es2018
+[restrict-to-es2019]: ../configs/index.md#restrict-to-es2019
+[restrict-to-es2020]: ../configs/index.md#restrict-to-es2020
+[restrict-to-es2021]: ../configs/index.md#restrict-to-es2021
+[restrict-to-es2022]: ../configs/index.md#restrict-to-es2022
+[restrict-to-es2023]: ../configs/index.md#restrict-to-es2023
+[restrict-to-es2024]: ../configs/index.md#restrict-to-es2024
diff --git a/docs/rules/no-symbol-dispose.md b/docs/rules/no-symbol-dispose.md
@@ -0,0 +1,66 @@
+---
+title: "es-x/no-symbol-dispose"
+description: "disallow the `Symbol.dispose` property"
+---
+
+# es-x/no-symbol-dispose
+> disallow the `Symbol.dispose` property
+
+- ❗ <badge text="This rule has not been released yet." vertical="middle" type="error"> ***This rule has not been released yet.*** </badge>
+- ✅ The following configurations enable this rule: [no-new-in-es2025], [restrict-to-es3], [restrict-to-es5], [restrict-to-es2015], [restrict-to-es2016], [restrict-to-es2017], [restrict-to-es2018], [restrict-to-es2019], [restrict-to-es2020], [restrict-to-es2021], [restrict-to-es2022], [restrict-to-es2023], and [restrict-to-es2024]
+
+This rule reports ES2025 [`Symbol.dispose` property]($$LINK$$) as errors.
+
+## 💡 Examples
+
+⛔ Examples of **incorrect** code for this rule:
+
+<eslint-playground type="bad">
+
+```js
+/*eslint es-x/no-symbol-dispose: error */
+x[Symbol.dispose];
+```
+
+</eslint-playground>
+
+## 🔧 Options
+
+This rule has an option.
+
+```jsonc
+{
+  "rules": {
+    "es-x/no-symbol-dispose": [
+      "error",
+      {
+        "allowTestedProperty": false
+      }
+    ]
+  }
+}
+```
+
+### allowTestedProperty: boolean
+
+Configure the allowTestedProperty mode for only this rule.
+This is prior to the `settings['es-x'].allowTestedProperty` setting.
+
+## 📚 References
+
+- [Rule source](https://github.com/eslint-community/eslint-plugin-es-x/blob/master/lib/rules/no-symbol-dispose.js)
+- [Test source](https://github.com/eslint-community/eslint-plugin-es-x/blob/master/tests/lib/rules/no-symbol-dispose.js)
+
+[no-new-in-es2025]: ../configs/index.md#no-new-in-es2025
+[restrict-to-es3]: ../configs/index.md#restrict-to-es3
+[restrict-to-es5]: ../configs/index.md#restrict-to-es5
+[restrict-to-es2015]: ../configs/index.md#restrict-to-es2015
+[restrict-to-es2016]: ../configs/index.md#restrict-to-es2016
+[restrict-to-es2017]: ../configs/index.md#restrict-to-es2017
+[restrict-to-es2018]: ../configs/index.md#restrict-to-es2018
+[restrict-to-es2019]: ../configs/index.md#restrict-to-es2019
+[restrict-to-es2020]: ../configs/index.md#restrict-to-es2020
+[restrict-to-es2021]: ../configs/index.md#restrict-to-es2021
+[restrict-to-es2022]: ../configs/index.md#restrict-to-es2022
+[restrict-to-es2023]: ../configs/index.md#restrict-to-es2023
+[restrict-to-es2024]: ../configs/index.md#restrict-to-es2024
diff --git a/docs/rules/no-symbol-matchall.md b/docs/rules/no-symbol-matchall.md
@@ -0,0 +1,62 @@
+---
+title: "es-x/no-symbol-matchall"
+description: "disallow the `Symbol.matchAll` property"
+---
+
+# es-x/no-symbol-matchall
+> disallow the `Symbol.matchAll` property
+
+- ❗ <badge text="This rule has not been released yet." vertical="middle" type="error"> ***This rule has not been released yet.*** </badge>
+- ✅ The following configurations enable this rule: [no-new-in-es2020], [no-string-matchall], [restrict-to-es3], [restrict-to-es5], [restrict-to-es2015], [restrict-to-es2016], [restrict-to-es2017], [restrict-to-es2018], and [restrict-to-es2019]
+
+This rule reports ES2020 [`Symbol.matchAll` property](https://github.com/tc39/proposal-string-matchall) as errors.
+
+## 💡 Examples
+
+⛔ Examples of **incorrect** code for this rule:
+
+<eslint-playground type="bad">
+
+```js
+/*eslint es-x/no-symbol-matchall: error */
+x[Symbol.matchAll]
+```
+
+</eslint-playground>
+
+## 🔧 Options
+
+This rule has an option.
+
+```jsonc
+{
+  "rules": {
+    "es-x/no-symbol-matchall": [
+      "error",
+      {
+        "allowTestedProperty": false
+      }
+    ]
+  }
+}
+```
+
+### allowTestedProperty: boolean
+
+Configure the allowTestedProperty mode for only this rule.
+This is prior to the `settings['es-x'].allowTestedProperty` setting.
+
+## 📚 References
+
+- [Rule source](https://github.com/eslint-community/eslint-plugin-es-x/blob/master/lib/rules/no-symbol-matchall.js)
+- [Test source](https://github.com/eslint-community/eslint-plugin-es-x/blob/master/tests/lib/rules/no-symbol-matchall.js)
+
+[no-new-in-es2020]: ../configs/index.md#no-new-in-es2020
+[no-string-matchall]: ../configs/index.md#no-string-matchall
+[restrict-to-es3]: ../configs/index.md#restrict-to-es3
+[restrict-to-es5]: ../configs/index.md#restrict-to-es5
+[restrict-to-es2015]: ../configs/index.md#restrict-to-es2015
+[restrict-to-es2016]: ../configs/index.md#restrict-to-es2016
+[restrict-to-es2017]: ../configs/index.md#restrict-to-es2017
+[restrict-to-es2018]: ../configs/index.md#restrict-to-es2018
+[restrict-to-es2019]: ../configs/index.md#restrict-to-es2019
diff --git a/lib/configs/flat/no-new-in-es2020.js b/lib/configs/flat/no-new-in-es2020.js
@@ -21,5 +21,6 @@ module.exports = {
         "es-x/no-promise-all-settled": "error",
         "es-x/no-regexp-unicode-property-escapes-2020": "error",
         "es-x/no-string-prototype-matchall": "error",
+        "es-x/no-symbol-matchall": "error",
     },
 }
diff --git a/lib/configs/flat/no-new-in-es2025.js b/lib/configs/flat/no-new-in-es2025.js
@@ -40,6 +40,8 @@ module.exports = {
         "es-x/no-set-prototype-issupersetof": "error",
         "es-x/no-set-prototype-symmetricdifference": "error",
         "es-x/no-set-prototype-union": "error",
+        "es-x/no-symbol-asyncdispose": "error",
+        "es-x/no-symbol-dispose": "error",
         "es-x/no-trailing-dynamic-import-commas": "error",
     },
 }
diff --git a/lib/configs/flat/no-string-matchall.js b/lib/configs/flat/no-string-matchall.js
@@ -0,0 +1,17 @@
+/**
+ * DON'T EDIT THIS FILE.
+ * This file was generated by "scripts/update-lib-flat-configs.js" script.
+ */
+"use strict"
+
+module.exports = {
+    plugins: {
+        get "es-x"() {
+            return require("../../index.js")
+        },
+    },
+    rules: {
+        "es-x/no-string-prototype-matchall": "error",
+        "es-x/no-symbol-matchall": "error",
+    },
+}
diff --git a/lib/configs/no-new-in-es2020.js b/lib/configs/no-new-in-es2020.js
@@ -17,5 +17,6 @@ module.exports = {
         "es-x/no-promise-all-settled": "error",
         "es-x/no-regexp-unicode-property-escapes-2020": "error",
         "es-x/no-string-prototype-matchall": "error",
+        "es-x/no-symbol-matchall": "error",
     },
 }
diff --git a/lib/configs/no-new-in-es2025.js b/lib/configs/no-new-in-es2025.js
@@ -36,6 +36,8 @@ module.exports = {
         "es-x/no-set-prototype-issupersetof": "error",
         "es-x/no-set-prototype-symmetricdifference": "error",
         "es-x/no-set-prototype-union": "error",
+        "es-x/no-symbol-asyncdispose": "error",
+        "es-x/no-symbol-dispose": "error",
         "es-x/no-trailing-dynamic-import-commas": "error",
     },
 }
diff --git a/lib/configs/no-string-matchall.js b/lib/configs/no-string-matchall.js
@@ -0,0 +1,13 @@
+/**
+ * DON'T EDIT THIS FILE.
+ * This file was generated by "scripts/update-lib-configs.js" script.
+ */
+"use strict"
+
+module.exports = {
+    plugins: ["es-x"],
+    rules: {
+        "es-x/no-string-prototype-matchall": "error",
+        "es-x/no-symbol-matchall": "error",
+    },
+}
diff --git a/lib/index.js b/lib/index.js
@@ -46,6 +46,7 @@ module.exports = {
         "flat/no-new-in-esnext-intl-api": require("./configs/flat/no-new-in-esnext-intl-api"),
         "flat/no-relative-indexing-method": require("./configs/flat/no-relative-indexing-method"),
         "flat/no-set-methods": require("./configs/flat/no-set-methods"),
+        "flat/no-string-matchall": require("./configs/flat/no-string-matchall"),
         "flat/restrict-to-es-intl-api-1st-edition": require("./configs/flat/restrict-to-es-intl-api-1st-edition"),
         "flat/restrict-to-es3": require("./configs/flat/restrict-to-es3"),
         "flat/restrict-to-es5": require("./configs/flat/restrict-to-es5"),
@@ -105,6 +106,7 @@ module.exports = {
         "no-new-in-esnext-intl-api": require("./configs/no-new-in-esnext-intl-api"),
         "no-relative-indexing-method": require("./configs/no-relative-indexing-method"),
         "no-set-methods": require("./configs/no-set-methods"),
+        "no-string-matchall": require("./configs/no-string-matchall"),
         "restrict-to-es-intl-api-1st-edition": require("./configs/restrict-to-es-intl-api-1st-edition"),
         "restrict-to-es3": require("./configs/restrict-to-es3"),
         "restrict-to-es5": require("./configs/restrict-to-es5"),
@@ -462,6 +464,9 @@ module.exports = {
         "no-subclassing-builtins": require("./rules/no-subclassing-builtins"),
         "no-suppressederror": require("./rules/no-suppressederror"),
         "no-symbol": require("./rules/no-symbol"),
+        "no-symbol-asyncdispose": require("./rules/no-symbol-asyncdispose"),
+        "no-symbol-dispose": require("./rules/no-symbol-dispose"),
+        "no-symbol-matchall": require("./rules/no-symbol-matchall"),
         "no-symbol-prototype-description": require("./rules/no-symbol-prototype-description"),
         "no-template-literals": require("./rules/no-template-literals"),
         "no-top-level-await": require("./rules/no-top-level-await"),
diff --git a/lib/rules/no-string-prototype-matchall.js b/lib/rules/no-string-prototype-matchall.js
@@ -13,6 +13,7 @@ module.exports = {
         docs: {
             description: "disallow the `String.prototype.matchAll` method.",
             category: "ES2020",
+            proposal: "string-matchall",
             recommended: false,
             url: "http://eslint-community.github.io/eslint-plugin-es-x/rules/no-string-prototype-matchall.html",
         },
diff --git a/lib/rules/no-symbol-asyncdispose.js b/lib/rules/no-symbol-asyncdispose.js
diff --git a/lib/rules/no-symbol-dispose.js b/lib/rules/no-symbol-dispose.js
diff --git a/lib/rules/no-symbol-matchall.js b/lib/rules/no-symbol-matchall.js
diff --git a/scripts/new-rule.js b/scripts/new-rule.js
diff --git a/scripts/proposals.js b/scripts/proposals.js
diff --git a/tests/lib/rules/no-symbol-asyncdispose.js b/tests/lib/rules/no-symbol-asyncdispose.js
diff --git a/tests/lib/rules/no-symbol-dispose.js b/tests/lib/rules/no-symbol-dispose.js
diff --git a/tests/lib/rules/no-symbol-matchall.js b/tests/lib/rules/no-symbol-matchall.js

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"eslint-plugin-es-x": minor
 +---
++
 +Add `no-string-matchall` config.