Skip to content

Commit 052c281

Browse files
warpdesignfiskersindresorhus
authored
Update deprecated docs (#2586)
Co-authored-by: fisker <[email protected]> Co-authored-by: Sindre Sorhus <[email protected]>
1 parent 056364d commit 052c281

File tree

3 files changed

+31
-28
lines changed

3 files changed

+31
-28
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,77 @@
11
# Deprecated/Removed Rules
22

3-
## import-index
3+
## Deprecated rules
44

5-
This rule is outdated. JavaScript modules (ESM) do not support importing a directory.
6-
7-
## no-array-instanceof
5+
### no-instanceof-array
86

97
Replaced by [`no-instanceof-builtins`](rules/no-instanceof-builtins.md) which covers more cases.
108

11-
## no-fn-reference-in-iterator
9+
## Deleted rules
1210

13-
This rule was renamed to [`no-array-callback-reference`](rules/no-array-callback-reference.md) to avoid using the abbreviation `fn` in the name.
11+
### ~import-index~
12+
13+
This rule is outdated. JavaScript modules (ESM) do not support importing a directory.
1414

15-
## no-instanceof-array
15+
### ~no-array-instanceof~
1616

1717
Replaced by [`no-instanceof-builtins`](rules/no-instanceof-builtins.md) which covers more cases.
1818

19-
## no-reduce
19+
### ~no-fn-reference-in-iterator~
20+
21+
This rule was renamed to [`no-array-callback-reference`](rules/no-array-callback-reference.md) to avoid using the abbreviation `fn` in the name.
22+
23+
### ~no-reduce~
2024

2125
This rule was renamed to [`no-array-reduce`](rules/no-array-reduce.md) to be more specific.
2226

23-
## no-unsafe-regex
27+
### ~no-unsafe-regex~
2428

2529
Removed due to bugs.
2630

27-
## prefer-dataset
31+
### ~prefer-dataset~
2832

2933
This rule was renamed to [`prefer-dom-node-dataset`](rules/prefer-dom-node-dataset.md) to be more specific.
3034

31-
## prefer-event-key
35+
### ~prefer-event-key~
3236

3337
This rule was renamed to [`prefer-keyboard-event-key`](rules/prefer-keyboard-event-key.md) to be more specific.
3438

35-
## prefer-exponentiation-operator
39+
### ~prefer-exponentiation-operator~
3640

3741
This rule was deprecated in favor of the built-in ESLint [`prefer-exponentiation-operator`](https://eslint.org/docs/rules/prefer-exponentiation-operator) rule.
3842

39-
## prefer-flat-map
43+
### ~prefer-flat-map~
4044

4145
This rule was renamed to [`prefer-array-flat-map`](rules/prefer-array-flat-map.md) to be more specific.
4246

43-
## prefer-node-append
47+
### ~prefer-node-append~
4448

4549
This rule was renamed to [`prefer-dom-node-append`](rules/prefer-dom-node-append.md) to be less ambiguous.
4650

47-
## prefer-node-remove
51+
### ~prefer-node-remove~
4852

4953
This rule was renamed to [`prefer-dom-node-remove`](rules/prefer-dom-node-remove.md) to be less ambiguous.
5054

51-
## prefer-object-has-own
55+
### ~prefer-object-has-own~
5256

5357
This rule was deprecated in favor of the built-in ESLint [`prefer-object-has-own`](https://eslint.org/docs/rules/prefer-object-has-own) rule.
5458

55-
## prefer-replace-all
59+
### ~prefer-replace-all~
5660

5761
This rule was renamed to [`prefer-string-replace-all`](rules/prefer-string-replace-all.md) to be more specific.
5862

59-
## prefer-starts-ends-with
63+
### ~prefer-starts-ends-with~
6064

6165
This rule was renamed to [`prefer-string-starts-ends-with`](rules/prefer-string-starts-ends-with.md) to be more specific.
6266

63-
## prefer-text-content
67+
### ~prefer-text-content~
6468

6569
This rule was renamed to [`prefer-dom-node-text-content`](rules/prefer-dom-node-text-content.md) to be more specific.
6670

67-
## prefer-trim-start-end
71+
### ~prefer-trim-start-end~
6872

6973
This rule was renamed to [`prefer-string-trim-start-end`](rules/prefer-string-trim-start-end.md) to be more specific.
7074

71-
## regex-shorthand
75+
### ~regex-shorthand~
7276

7377
This rule was renamed to [`better-regex`](rules/better-regex.md) as it does more than just preferring the shorthand.

readme.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -186,9 +186,9 @@ export default [
186186

187187
<!-- end auto-generated rules list -->
188188

189-
### Deprecated Rules
189+
### Deleted and deprecated rules
190190

191-
See [docs/deprecated-rules.md](docs/deprecated-rules.md)
191+
See [the list](docs/deleted-and-deprecated-rules.md).
192192

193193
## Preset configs
194194

test/package.js

+4-5
Original file line numberDiff line numberDiff line change
@@ -107,17 +107,16 @@ test('Every rule has valid meta.type', t => {
107107
}
108108
});
109109

110-
test('Every deprecated rules listed in docs/deprecated-rules.md', async t => {
111-
const content = await fsAsync.readFile('docs/deprecated-rules.md', 'utf8');
112-
const rulesInMarkdown = new Set(content.match(/(?<=^## ).*?$/gm));
113-
110+
test('Every deprecated rules listed in docs/deleted-and-deprecated-rules.md', async t => {
111+
const content = await fsAsync.readFile('docs/deleted-and-deprecated-rules.md', 'utf8');
114112
for (const name of deprecatedRules) {
115113
const rule = eslintPluginUnicorn.rules[name];
116114
t.is(typeof rule.create, 'function', `${name} create is not function`);
117115
t.deepEqual(rule.create(), {}, `${name} create should return empty object`);
118116
t.is(typeof rule.meta.deprecated.message, 'string', `${name} meta.deprecated.message should be string`);
119117
t.true(Array.isArray(rule.meta.deprecated.replacedBy), `${name} meta.deprecated.replacedBy should be array`);
120-
t.true(rulesInMarkdown.has(name));
118+
t.true(content.includes(`\n### ${name}\n`));
119+
t.false(content.includes(`\n### ~${name}~\n`));
121120
}
122121
});
123122

0 commit comments

Comments
 (0)