✨ es/no-array-prototype-copywithin

docs/rules/no-array-prototype-copywithin.md

@@ -0,0 +1,35 @@
+# es/no-array-prototype-copywithin
+> disallow the `Array.prototype.copyWithin` method
+
+- ✅ The following configurations enable this rule: `plugin:es/no-new-in-es2015`, `plugin:es/restrict-to-es3`, and `plugin:es/restrict-to-es5`
+
+This rule reports ES2015 `Array.prototype.copyWithin` method as errors.
+
+This rule is silent by default because it's hard to know types. You need to configure [the aggressive mode](../#the-aggressive-mode) or TypeScript in order to enable this rule.
+
+## 💡 Examples
+
+⛔ Examples of **incorrect** code for this rule:
+
+<eslint-playground type="bad" code="/*eslint es/no-array-prototype-copywithin: [error, { aggressive: true }] */
+foo.copyWithin(0, 1, 2)
+" />
+
+## 🔧 Options
+
+This rule has an option.
+
+```yml
+rules:
+  es/no-array-prototype-copywithin: [error, { aggressive: false }]
+```
+
+### aggressive: boolean
+
+Configure the aggressive mode for only this rule.
+This is prior to the `settings.es.aggressive` setting.
+
+## 📚 References
+
+- [Rule source](https://github.com/mysticatea/eslint-plugin-es/blob/v4.1.0/lib/rules/no-array-prototype-copywithin.js)
+- [Test source](https://github.com/mysticatea/eslint-plugin-es/blob/v4.1.0/tests/lib/rules/no-array-prototype-copywithin.js)

lib/rules/no-array-prototype-copywithin.js

@@ -0,0 +1,40 @@
+/**
+ * @author Toru Nagashima <https://github.com/mysticatea>
+ * See LICENSE file in root directory for full license.
+ */
+"use strict"
+
+const {
+    definePrototypeMethodHandler,
+} = require("../util/define-prototype-method-handler")
+
+module.exports = {
+    meta: {
+        docs: {
+            description: "disallow the `Array.prototype.copyWithin` method.",
+            category: "ES2015",
+            recommended: false,
+            url:
+                "http://mysticatea.github.io/eslint-plugin-es/rules/no-array-prototype-copywithin.html",
+        },
+        fixable: null,
+        messages: {
+            forbidden: "ES2015 '{{name}}' method is forbidden.",
+        },
+        schema: [
+            {
+                type: "object",
+                properties: {
+                    aggressive: { type: "boolean" },
+                },
+                additionalProperties: false,
+            },
+        ],
+        type: "problem",
+    },
+    create(context) {
+        return definePrototypeMethodHandler(context, {
+            Array: ["copyWithin"],
+        })
+    },
+}

tests/lib/rules/no-array-prototype-copywithin.js

@@ -0,0 +1,202 @@
+/**
+ * @author Toru Nagashima <https://github.com/mysticatea>
+ * See LICENSE file in root directory for full license.
+ */
+"use strict"
+
+const path = require("path")
+const RuleTester = require("../../tester")
+const rule = require("../../../lib/rules/no-array-prototype-copywithin.js")
+const ruleId = "no-array-prototype-copywithin"
+
+new RuleTester().run(ruleId, rule, {
+    valid: [
+        "copyWithin(0, 1, 2)",
+        "foo.reverse()",
+        "foo.copyWithin(0, 1, 2)",
+        { code: "copyWithin(0, 1, 2)", settings: { es: { aggressive: true } } },
+        { code: "foo.reverse()", settings: { es: { aggressive: true } } },
+        {
+            code: "foo.copyWithin(0, 1, 2)",
+            options: [{ aggressive: false }],
+            settings: { es: { aggressive: true } },
+        },
+    ],
+    invalid: [
+        {
+            code: "foo.copyWithin(0, 1, 2)",
+            errors: [
+                "ES2015 'Array.prototype.copyWithin' method is forbidden.",
+            ],
+            settings: { es: { aggressive: true } },
+        },
+        {
+            code: "foo.copyWithin(0, 1, 2)",
+            options: [{ aggressive: true }],
+            errors: [
+                "ES2015 'Array.prototype.copyWithin' method is forbidden.",
+            ],
+            settings: { es: { aggressive: false } },
+        },
+    ],
+})
+
+// -----------------------------------------------------------------------------
+// TypeScript
+// -----------------------------------------------------------------------------
+const parser = require.resolve("@typescript-eslint/parser")
+const tsconfigRootDir = path.resolve(__dirname, "../../fixtures")
+const project = "tsconfig.json"
+const filename = path.join(tsconfigRootDir, "test.ts")
+
+new RuleTester({ parser }).run(`${ruleId} TS`, rule, {
+    valid: [
+        { filename, code: "copyWithin(0, 1, 2)" },
+        { filename, code: "foo.reverse()" },
+        { filename, code: "foo.copyWithin(0, 1, 2)" },
+        { filename, code: "let foo = {}; foo.copyWithin(0, 1, 2)" },
+        {
+            filename,
+            code: "copyWithin(0, 1, 2)",
+            settings: { es: { aggressive: true } },
+        },
+        {
+            filename,
+            code: "foo.reverse()",
+            settings: { es: { aggressive: true } },
+        },
+
+        // `Array` is unknown type if tsconfig.json is not configured.
+        { filename, code: "let foo = []; foo.copyWithin(0, 1, 2)" },
+        { filename, code: "let foo = Array(); foo.copyWithin(0, 1, 2)" },
+        {
+            filename,
+            code: "function f<T extends any[]>(a: T) { a.copyWithin(0, 1, 2) }",
+        },
+        {
+            filename,
+            code:
+                "function f<T extends string[] | number[]>(a: T) { a.copyWithin(0, 1, 2) }",
+        },
+    ],
+    invalid: [
+        {
+            filename,
+            code: "[a, b, c].copyWithin(0, 1, 2)",
+            errors: [
+                "ES2015 'Array.prototype.copyWithin' method is forbidden.",
+            ],
+        },
+        {
+            filename,
+            code: "let foo = []; foo.copyWithin(0, 1, 2)",
+            errors: [
+                "ES2015 'Array.prototype.copyWithin' method is forbidden.",
+            ],
+            settings: { es: { aggressive: true } },
+        },
+        {
+            filename,
+            code: "let foo = Array(); foo.copyWithin(0, 1, 2)",
+            errors: [
+                "ES2015 'Array.prototype.copyWithin' method is forbidden.",
+            ],
+            settings: { es: { aggressive: true } },
+        },
+        {
+            filename,
+            code: "function f<T extends any[]>(a: T) { a.copyWithin(0, 1, 2) }",
+            errors: [
+                "ES2015 'Array.prototype.copyWithin' method is forbidden.",
+            ],
+            settings: { es: { aggressive: true } },
+        },
+        {
+            filename,
+            code:
+                "function f<T extends string[] | number[]>(a: T) { a.copyWithin(0, 1, 2) }",
+            errors: [
+                "ES2015 'Array.prototype.copyWithin' method is forbidden.",
+            ],
+            settings: { es: { aggressive: true } },
+        },
+        {
+            filename,
+            code: "foo.copyWithin(0, 1, 2)",
+            errors: [
+                "ES2015 'Array.prototype.copyWithin' method is forbidden.",
+            ],
+            settings: { es: { aggressive: true } },
+        },
+    ],
+})
+
+new RuleTester({ parser, parserOptions: { tsconfigRootDir, project } }).run(
+    `${ruleId} TS Full Type Information`,
+    rule,
+    {
+        valid: [
+            { filename, code: "copyWithin(0, 1, 2)" },
+            { filename, code: "foo.reverse()" },
+            { filename, code: "foo.copyWithin(0, 1, 2)" },
+            { filename, code: "let foo = {}; foo.copyWithin(0, 1, 2)" },
+            {
+                filename,
+                code: "copyWithin(0, 1, 2)",
+                settings: { es: { aggressive: true } },
+            },
+            {
+                filename,
+                code: "foo.reverse()",
+                settings: { es: { aggressive: true } },
+            },
+        ],
+        invalid: [
+            {
+                filename,
+                code: "[a, b, c].copyWithin(0, 1, 2)",
+                errors: [
+                    "ES2015 'Array.prototype.copyWithin' method is forbidden.",
+                ],
+            },
+            {
+                filename,
+                code: "let foo = []; foo.copyWithin(0, 1, 2)",
+                errors: [
+                    "ES2015 'Array.prototype.copyWithin' method is forbidden.",
+                ],
+            },
+            {
+                filename,
+                code: "let foo = Array(); foo.copyWithin(0, 1, 2)",
+                errors: [
+                    "ES2015 'Array.prototype.copyWithin' method is forbidden.",
+                ],
+            },
+            {
+                filename,
+                code:
+                    "function f<T extends any[]>(a: T) { a.copyWithin(0, 1, 2) }",
+                errors: [
+                    "ES2015 'Array.prototype.copyWithin' method is forbidden.",
+                ],
+            },
+            {
+                filename,
+                code:
+                    "function f<T extends string[] | number[]>(a: T) { a.copyWithin(0, 1, 2) }",
+                errors: [
+                    "ES2015 'Array.prototype.copyWithin' method is forbidden.",
+                ],
+            },
+            {
+                filename,
+                code: "foo.copyWithin(0, 1, 2)",
+                errors: [
+                    "ES2015 'Array.prototype.copyWithin' method is forbidden.",
+                ],
+                settings: { es: { aggressive: true } },
+            },
+        ],
+    },
+)