Meta: Verify features meta on CI (refined-github#4699)

gamemaker1 · yakov116 · fregante · web-flow · commit e8ec186217ff · 2021-08-24T11:05:03.000-04:00
Co-authored-by: yakov116 &lt;16872793+yakov116@users.noreply.github.com&gt;
Co-authored-by: Federico Brigante &lt;me@fregante.com&gt;
diff --git a/.github/workflows/features.yml b/.github/workflows/features.yml
@@ -1,37 +1,22 @@
-name: Feature
+name: Features
 
 on:
   pull_request:
-    types:
-      - opened
-      - edited
-      - synchronize # push
-    path:
-      - source/refined-github.ts
+    branches:
+      - '*'
+  push:
+    branches:
+      - main
+      - 'test/*'
 
 jobs:
-  New:
-    outputs:
-      name: ${{ steps.name.outputs.first_match }}
+  Verify:
     runs-on: ubuntu-latest
-    if: startsWith(github.event.pull_request.title, 'Add') && endsWith(github.event.pull_request.title, 'feature')
     steps:
       - uses: actions/checkout@v2
-      - name: Find feature name
-        id: name
-        uses: AsasInnab/regex-action@v1
+      - uses: actions/setup-node@v2
         with:
-          regex_pattern: '(?<=Add `)[a-z-]+(?=` feature)'
-          regex_flags: g
-          search_string: ${{ github.event.pull_request.title }}
-
-      - name: Has `${{ steps.name.outputs.first_match }}.tsx` been created?
-        uses: mudlabs/simple-diff@v1.2.0
-        with:
-          path: source/features/${{ steps.name.outputs.first_match }}.tsx
-
-      - name: Has `${{ steps.name.outputs.first_match }}` been imported?
-        run: grep "import './features/${{ steps.name.outputs.first_match }}';" source/refined-github.ts -q
-
-      - name: Has `${{ steps.name.outputs.first_match }}` been documented?
-        run: grep '"${{ steps.name.outputs.first_match }}"' readme.md -q
+          node-version: 16
+          cache: npm
+      - run: npm ci
+      - run: npm run test:features
diff --git a/build/readme-parser.ts b/build/readme-parser.ts
@@ -1,5 +1,5 @@
 /// <reference types="../source/globals" />
-import path from 'node:path';
+
 import regexJoin from 'regex-join';
 import {readFileSync} from 'node:fs';
 import {parse as parseMarkdown} from 'markdown-wasm/dist/markdown.node.js';
@@ -38,7 +38,7 @@ function searchInHighlights(readmeContent: string, id: FeatureID): FeatureMeta |
 }
 
 export function getFeaturesMeta(): FeatureMeta[] {
-	const readmeContent = readFileSync(path.join(__dirname, '../readme.md'), 'utf-8');
+	const readmeContent = readFileSync('readme.md', 'utf-8');
 	const features = [];
 	for (const id of getFeatures()) {
 		if (!id.startsWith('rgh-')) {
@@ -53,7 +53,7 @@ export function getFeaturesMeta(): FeatureMeta[] {
 }
 
 export function getFeatures(): FeatureID[] {
-	const contents = readFileSync(path.join(__dirname, '../source/refined-github.ts'), 'utf-8');
+	const contents = readFileSync('source/refined-github.ts', 'utf-8');
 	return [...contents.matchAll(/^import '\.\/features\/([^.]+)';/gm)]
 		.map(match => match[1] as FeatureID)
 		.sort();
diff --git a/build/verify-features.ts b/build/verify-features.ts
@@ -0,0 +1,45 @@
+#!/usr/bin/env -S TS_NODE_COMPILER_OPTIONS='{"module":"es2020"}' node --loader ts-node/esm
+
+import {readdirSync} from 'node:fs';
+
+import {getFeatures, getFeaturesMeta} from './readme-parser.js'; // Must import as `.js`
+
+const featuresDirContents = readdirSync('source/features/');
+const importedFeatures = getFeatures();
+const featuresInReadme = getFeaturesMeta();
+
+const errors: string[] = [];
+
+for (const fileName of featuresDirContents) {
+	if (fileName === 'index.tsx' || fileName.endsWith('.css')) {
+		continue;
+	}
+
+	if (!fileName.endsWith('.tsx')) {
+		errors.push(`ERR: The \`/source/features\` folder should only contain .css and .tsx files. File \`${fileName}\` violates that rule`);
+		continue;
+	}
+
+	const featureId = fileName.replace('.tsx', '');
+	if (!importedFeatures.includes(featureId as FeatureID)) {
+		errors.push(`ERR: ${featureId} should be imported by \`/sources/refined-github.ts\``);
+	}
+
+	if (fileName.startsWith('rgh-')) {
+		continue;
+	}
+
+	const featureMeta = featuresInReadme.find(feature => feature.id === featureId);
+	if (!featureMeta) {
+		errors.push(`ERR: The feature ${featureId} should be described in the readme`);
+		continue;
+	}
+
+	if (featureMeta.description.length < 20) {
+		errors.push(`ERR: ${featureId} should be described better in the readme (at least 20 characters)`);
+	}
+}
+
+console.error(errors.join('\n'));
+
+process.exitCode = errors.length;
diff --git a/package.json b/package.json
@@ -12,7 +12,8 @@
 		"lint:js": "xo",
 		"pack:safari": "xcodebuild -project 'safari/Refined GitHub.xcodeproj'",
 		"start:safari": "open 'safari/build/Release/Refined GitHub.app'",
-		"test": "run-p ava lint:* build:*",
+		"test": "run-p ava lint:* build:* test:features",
+		"test:features": "./build/verify-features.ts",
 		"watch": "run-p watch:* --continue-on-error",
 		"watch:typescript": "tsc --noEmit --watch --preserveWatchOutput",
 		"watch:webpack": "webpack --mode=development --watch"
