Move Test URL check to Vitest (refined-github#7694)

fregante · web-flow · commit ba1bdbf14000 · 2024-08-27T14:41:27.000+07:00
diff --git a/.github/workflows/features.yml b/.github/workflows/features.yml
@@ -20,21 +20,3 @@ jobs:
           cache: npm
       - run: npm ci
       - run: npm run vitest -- build/features
-
-  TestURLs:
-    runs-on: ubuntu-latest
-    # Exclude commit pushes, there's no need there
-    if: github.event_name == 'pull_request'
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0 # Must
-
-      - name: Get changed files
-        id: changed-files
-        uses: tj-actions/changed-files@v44
-        with:
-          files: source/features/*.{tsx,css}
-
-      - name: Every new/edited file must have a test URL
-        run: bash build/verify-test-urls.sh ${{steps.changed-files.outputs.all_changed_files}}
diff --git a/.gitignore b/.gitignore
@@ -6,5 +6,7 @@ test/web-ext-profile
 .cache
 .parcel-cache
 artifacts
+.DS_Store
+desktop.ini
 
 LocalOverrides.xcconfig
diff --git a/build/features.test.ts b/build/features.test.ts
@@ -1,6 +1,6 @@
-import {test, describe, assert} from 'vitest';
-import {parse, join} from 'node:path';
 import {existsSync, readdirSync, readFileSync} from 'node:fs';
+import path from 'node:path';
+import {test, describe, assert} from 'vitest';
 import regexJoin from 'regex-join';
 import fastIgnore from 'fast-ignore';
 
@@ -55,8 +55,8 @@ class FeatureFile {
 	readonly id: FeatureID;
 	readonly path: string;
 	constructor(readonly name: string) {
-		this.id = parse(name).name as FeatureID;
-		this.path = join('source/features', name);
+		this.id = path.parse(name).name as FeatureID;
+		this.path = path.join('source/features', name);
 	}
 
 	exists(): boolean {
@@ -91,6 +91,8 @@ function validateCss(file: FeatureFile): void {
 			isImportedByEntrypoint,
 			`Should be imported by \`${entryPoint}\` or removed if it is not needed`,
 		);
+
+		assert(/test url/i.test(file.contents().toString()), 'Should have test URLs');
 		return;
 	}
 
@@ -103,6 +105,8 @@ function validateCss(file: FeatureFile): void {
 		!isImportedByEntrypoint,
 		`Should only be imported by \`${file.tsx.name}\`, not by \`${entryPoint}\``,
 	);
+
+	assert(!/test url/i.test(file.contents().toString()), 'Only TSX files and *lone* CSS files should have test URLs');
 }
 
 function validateGql(file: FeatureFile): void {
@@ -141,11 +145,11 @@ function validateTsx(file: FeatureFile): void {
 		`Should be imported by \`${entryPoint}\``,
 	);
 
-	const fileContents = readFileSync(`source/features/${file.name}`);
+	assert(/test url/i.test(file.contents().toString()), 'Should have test URLs');
 
-	if (fileContents.includes('.addCssFeature')) {
+	if (file.contents().includes('.addCssFeature')) {
 		assert(
-			!fileContents.includes('.add('),
+			!file.contents().includes('.add('),
 			`${file.id} should use either \`addCssFeature\` or \`add\`, not both`,
 		);
 
diff --git a/build/verify-test-urls.sh b/build/verify-test-urls.sh
diff --git a/source/features/align-issue-labels.css b/source/features/align-issue-labels.css
@@ -32,15 +32,3 @@
 	margin-top: 4px;
 	font-size: 11px !important;
 }
-
-/* TODO: Remove links from CSS+JS features after https://github.com/refined-github/refined-github/issues/7656 or https://github.com/refined-github/refined-github/issues/7132 */
-/*
-
-# Test URLs
-
-https://github.com/pulls
-https://github.com/bmish/eslint-doc-generator/pulls
-https://github.com/bmish/eslint-doc-generator/issues
-https://github.com/bmish/eslint-doc-generator/milestone/1
-
-*/
diff --git a/source/features/deep-reblame.css b/source/features/deep-reblame.css
@@ -7,11 +7,3 @@ button.rgh-deep-reblame .octicon-versions {
 	color: var(--color-scale-pink-7, #800080);
 	opacity: 70%;
 }
-
-/*
-
-Test URLs:
-
-https://github.com/refined-github/refined-github/blame/main/source/refined-github.ts
-
-*/
diff --git a/source/features/github-bugs.css b/source/features/github-bugs.css
@@ -73,3 +73,11 @@
 div.markdown-body {
 	min-height: 2em !important;
 }
+
+/*
+
+Test URLs:
+
+MAKE SURE TO ADD A ISSUE REFERENCE + TEST URL FOR EACH NEW RULE
+
+*/
diff --git a/source/features/hide-diff-signs.css b/source/features/hide-diff-signs.css
@@ -7,14 +7,3 @@
 	)::before {
 	visibility: hidden;
 }
-
-/*
-
-Test URLs
-
-Any commits on https://github.com/sindresorhus/refined-github/commits/main
-Any reviewed block on https://github.com/sindresorhus/refined-github/pull/1783
-Full diff on https://github.com/sindresorhus/refined-github/pull/1783/files
-The preview tab, after editing: https://github.com/refined-github/refined-github/edit/main/source/features/hide-diff-signs.css
-
-*/
diff --git a/source/features/suggest-commit-title-limit.css b/source/features/suggest-commit-title-limit.css
@@ -35,13 +35,3 @@
 		inset 0 1px 2px rgb(35 27 27 / 7.5%),
 		0 0 0 0.2em color-mix(in srgb, var(--rgh-limit-color) 30%, transparent);
 }
-
-/*
-
-## Test URLs
-
-- File edit: https://github.com/refined-github/refined-github/edit/fix-commit-title-limit/source/refined-github.css
-- Workflow edit: https://github.com/refined-github/refined-github/edit/fix-commit-title-limit/.github/workflows/features.yml
-- Any mergeable PR
-
-*/
diff --git a/source/features/suggest-commit-title-limit.tsx b/source/features/suggest-commit-title-limit.tsx
@@ -53,8 +53,9 @@ void features.add(import.meta.url, {
 ## Test URLs
 
 - Any mergeable PR
-- https://github.com/refined-github/sandbox/pull/8
+	- https://github.com/refined-github/sandbox/pull/8
 - Any editable file
-- https://github.com/refined-github/refined-github/edit/main/readme.md
+	- Markown: https://github.com/refined-github/refined-github/edit/main/readme.md
+	- Workflow: https://github.com/refined-github/refined-github/edit/fix-commit-title-limit/.github/workflows/features.yml
 
 */
