From e99740d239af13f6bfe09691b37c0266348d96d1 Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Thu, 30 Dec 2021 12:52:31 -0500 Subject: [PATCH 1/2] docs: change createRule usage to point to website --- packages/eslint-plugin/src/util/createRule.ts | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/packages/eslint-plugin/src/util/createRule.ts b/packages/eslint-plugin/src/util/createRule.ts index 8e69adb95659..3d2f75aeba91 100644 --- 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}`, ); From 019f34bdea97a79ef6213ba205824d405ed356fa Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Thu, 30 Dec 2021 16:45:52 -0500 Subject: [PATCH 2/2] chore: fix unit tests too --- packages/eslint-plugin/tests/docs.test.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/eslint-plugin/tests/docs.test.ts b/packages/eslint-plugin/tests/docs.test.ts index 61487b5169f0..5200bb5f3ba8 100644 --- 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', () => {