Fix meta.deprecated.replacedBy to use ReplacedByInfo objects per ESLint schema (#2860)

Author: sindresorhus

index.js

@@ -7,7 +7,6 @@ import packageJson from './package.json' with {type: 'json'};
 const rules = toEslintRules(rawRules);
 
 const deprecatedRules = createDeprecatedRules({
-	// {ruleId: {message: string, replacedBy: string[]}}
 	'no-instanceof-array': {
 		message: 'Replaced by `unicorn/no-instanceof-builtins` which covers more cases.',
 		replacedBy: ['unicorn/no-instanceof-builtins'],

rules/utils/create-deprecated-rules.js

@@ -1,3 +1,4 @@
+import getDocumentationUrl from './get-documentation-url.js';
 import packageJson from '../../package.json' with {type: 'json'};
 
 const repoUrl = 'https://github.com/sindresorhus/eslint-plugin-unicorn';
@@ -20,7 +21,12 @@ export default function createDeprecatedRules(rules) {
 						deprecated: {
 							message: deprecatedInfo.message,
 							url,
-							replacedBy: deprecatedInfo.replacedBy,
+							replacedBy: deprecatedInfo.replacedBy.map(replacementRuleId => ({
+								rule: {
+									name: replacementRuleId,
+									url: getDocumentationUrl(replacementRuleId),
+								},
+							})),
 						},
 					},
 				},

test/package.js

@@ -104,6 +104,12 @@ test('Every deprecated rules listed in docs/deleted-and-deprecated-rules.md', as
 		t.deepEqual(rule.create(), {}, `${name} create should return empty object`);
 		t.is(typeof rule.meta.deprecated.message, 'string', `${name} meta.deprecated.message should be string`);
 		t.true(Array.isArray(rule.meta.deprecated.replacedBy), `${name} meta.deprecated.replacedBy should be array`);
+
+		for (const replacement of rule.meta.deprecated.replacedBy) {
+			t.is(typeof replacement.rule.name, 'string', `${name} meta.deprecated.replacedBy[].rule.name should be string`);
+			t.is(typeof replacement.rule.url, 'string', `${name} meta.deprecated.replacedBy[].rule.url should be string`);
+		}
+
 		t.true(content.includes(`\n### ${name}\n`));
 		t.false(content.includes(`\n### ~${name}~\n`));
 	}