docs(eslint-plugin): change createRule usage to point to website (typescript-eslint#4369)

Josh Goldberg · web-flow · commit f8ad84813a4a · 2021-12-31T15:51:20.000-08:00
diff --git a/packages/eslint-plugin/src/util/createRule.ts b/packages/eslint-plugin/src/util/createRule.ts
@@ -1,10 +1,5 @@
 import { ESLintUtils } from '@typescript-eslint/experimental-utils';
 
-// note - cannot migrate this to an import statement because it will make TSC copy the package.json to the dist folder
-// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
-const version: string = require('../../package.json').version;
-
 export const createRule = ESLintUtils.RuleCreator(
-  name =>
-    `https://github.com/typescript-eslint/typescript-eslint/blob/v${version}/packages/eslint-plugin/docs/rules/${name}.md`,
+  name => `https://typescript-eslint.io/rules/${name}`,
 );
diff --git a/packages/eslint-plugin/tests/docs.test.ts b/packages/eslint-plugin/tests/docs.test.ts
@@ -118,9 +118,9 @@ describe('Validating rule metadata', () => {
       it('`name` field in rule must match the filename', () => {
         // validate if rule name is same as url
         // there is no way to access this field but its used only in generation of docs url
-        expect(
-          rule.meta.docs?.url?.endsWith(`rules/${ruleName}.md`),
-        ).toBeTruthy();
+        expect(rule.meta.docs?.url).toBe(
+          `https://typescript-eslint.io/rules/${ruleName}`,
+        );
       });
 
       it('`requiresTypeChecking` should be set if the rule uses type information', () => {
