Deprecate no-instanceof-array (#2534)

Author: fisker

docs/deprecated-rules.md

@@ -12,6 +12,10 @@ This rule was renamed to [`no-instanceof-array`](rules/no-instanceof-array.md) t
 
 This rule was renamed to [`no-array-callback-reference`](rules/no-array-callback-reference.md) to avoid using the abbreviation `fn` in the name.
 
+## no-instanceof-array
+
+Replaced by [`no-instanceof-builtin-object`](rules/no-instanceof-builtin-object) which covers more cases.
+
 ## no-reduce
 
 This rule was renamed to [`no-array-reduce`](rules/no-array-reduce.md) to be more specific.

docs/rules/no-instanceof-array.md

@@ -5,23 +5,7 @@ import packageJson from './package.json' with {type: 'json'};
 
 const deprecatedRules = createDeprecatedRules({
 	// {ruleId: ReplacementRuleId | ReplacementRuleId[]}, if no replacement, use `{ruleId: []}`
-	'import-index': [],
-	'no-array-instanceof': 'unicorn/no-instanceof-array',
-	'no-fn-reference-in-iterator': 'unicorn/no-array-callback-reference',
-	'no-reduce': 'unicorn/no-array-reduce',
-	'no-unsafe-regex': [],
-	'prefer-dataset': 'unicorn/prefer-dom-node-dataset',
-	'prefer-event-key': 'unicorn/prefer-keyboard-event-key',
-	'prefer-exponentiation-operator': 'prefer-exponentiation-operator',
-	'prefer-flat-map': 'unicorn/prefer-array-flat-map',
-	'prefer-node-append': 'unicorn/prefer-dom-node-append',
-	'prefer-node-remove': 'unicorn/prefer-dom-node-remove',
-	'prefer-object-has-own': 'prefer-object-has-own',
-	'prefer-replace-all': 'unicorn/prefer-string-replace-all',
-	'prefer-starts-ends-with': 'unicorn/prefer-string-starts-ends-with',
-	'prefer-text-content': 'unicorn/prefer-dom-node-text-content',
-	'prefer-trim-start-end': 'unicorn/prefer-string-trim-start-end',
-	'regex-shorthand': 'unicorn/better-regex',
+	'no-instanceof-array': 'unicorn/no-instanceof-builtin-object',
 });
 
 const externalRules = {

index.js

@@ -85,7 +85,6 @@ export default [
 | [no-empty-file](docs/rules/no-empty-file.md)                                                     | Disallow empty files.                                                                                                                                                                                             | ✅  |    |    |
 | [no-for-loop](docs/rules/no-for-loop.md)                                                         | Do not use a `for` loop that can be replaced with a `for-of` loop.                                                                                                                                                | ✅  | 🔧 | 💡 |
 | [no-hex-escape](docs/rules/no-hex-escape.md)                                                     | Enforce the use of Unicode escapes instead of hexadecimal escapes.                                                                                                                                                | ✅  | 🔧 |    |
-| [no-instanceof-array](docs/rules/no-instanceof-array.md)                                         | Require `Array.isArray()` instead of `instanceof Array`.                                                                                                                                                          | ✅  | 🔧 |    |
 | [no-instanceof-builtin-object](docs/rules/no-instanceof-builtin-object.md)                       | Disallow `instanceof` with built-in objects                                                                                                                                                                       | ✅  | 🔧 |    |
 | [no-invalid-fetch-options](docs/rules/no-invalid-fetch-options.md)                               | Disallow invalid options in `fetch()` and `new Request()`.                                                                                                                                                        | ✅  |    |    |
 | [no-invalid-remove-event-listener](docs/rules/no-invalid-remove-event-listener.md)               | Prevent calling `EventTarget#removeEventListener()` with the result of an expression.                                                                                                                             | ✅  |    |    |

readme.md

@@ -30,7 +30,6 @@ import noDocumentCookie from './no-document-cookie.js';
 import noEmptyFile from './no-empty-file.js';
 import noForLoop from './no-for-loop.js';
 import noHexEscape from './no-hex-escape.js';
-import noInstanceofArray from './no-instanceof-array.js';
 import noInstanceofBuiltinObject from './no-instanceof-builtin-object.js';
 import noInvalidFetchOptions from './no-invalid-fetch-options.js';
 import noInvalidRemoveEventListener from './no-invalid-remove-event-listener.js';
@@ -156,7 +155,6 @@ const rules = {
 	'no-empty-file': createRule(noEmptyFile, 'no-empty-file'),
 	'no-for-loop': createRule(noForLoop, 'no-for-loop'),
 	'no-hex-escape': createRule(noHexEscape, 'no-hex-escape'),
-	'no-instanceof-array': createRule(noInstanceofArray, 'no-instanceof-array'),
 	'no-instanceof-builtin-object': createRule(noInstanceofBuiltinObject, 'no-instanceof-builtin-object'),
 	'no-invalid-fetch-options': createRule(noInvalidFetchOptions, 'no-invalid-fetch-options'),
 	'no-invalid-remove-event-listener': createRule(noInvalidRemoveEventListener, 'no-invalid-remove-event-listener'),

rules/index.js

@@ -106,14 +106,14 @@ test('Every rule has valid meta.type', t => {
 
 test('Every deprecated rules listed in docs/deprecated-rules.md', async t => {
 	const content = await fsAsync.readFile('docs/deprecated-rules.md', 'utf8');
-	const rulesInMarkdown = content.match(/(?<=^## ).*?$/gm);
-	t.deepEqual(deprecatedRules, rulesInMarkdown);
+	const rulesInMarkdown = new Set(content.match(/(?<=^## ).*?$/gm));
 
 	for (const name of deprecatedRules) {
 		const rule = eslintPluginUnicorn.rules[name];
 		t.is(typeof rule.create, 'function', `${name} create is not function`);
 		t.deepEqual(rule.create(), {}, `${name} create should return empty object`);
 		t.true(rule.meta.deprecated, `${name} meta.deprecated should be true`);
+		t.true(rulesInMarkdown.has(name));
 	}
 });