ci: check component spec generation (#114)

Author: ultmaster

.github/workflows/test.yml

@@ -45,6 +45,8 @@ jobs:
       - run: npm run build-webview
       - run: npm run build-cli
       - run: npm run lint
+      - run: npm run validate-component-spec
+        if: matrix.os == 'ubuntu-latest'
       - run: npm run package:win
         if: matrix.platform == 'win32-x64'
       - run: npm run package -- --target ${{ matrix.platform }}

package.json

@@ -348,6 +348,7 @@
     "build-webview": "webpack-cli --config webpack.config.webview.js",
     "build-cli": "webpack-cli --config webpack.config.cli.js",
     "generate-component-spec": "npm run compile && node ./out/poml-vscode/lsp/parseComments.js && npm run compile && node ./out/poml-vscode/lsp/parseComments.js",
+    "validate-component-spec": "npm run compile && node ./out/poml-vscode/lsp/parseComments.js --check && npm run compile && node ./out/poml-vscode/lsp/parseComments.js --check",
     "generate-vscodeignore": "node ./vscodeignore.js",
     "compile": "tspc -p ./",
     "watch": "tspc -watch -p ./",

packages/poml-vscode/lsp/parseComments.ts

@@ -1,10 +1,32 @@
 import 'poml';
 import { ComponentSpec, Parameter } from 'poml/base';
 
-import { readFileSync, readdirSync, writeFile, writeFileSync } from 'fs';
+import { readFileSync, readdirSync, writeFileSync } from 'fs';
 import { join } from 'path';
 import { formatComponentDocumentation } from './documentFormatter';
 
+const checkMode = process.argv.includes('--check');
+let hasChanges = false;
+
+function writeOrCheck(filePath: string, content: string) {
+  let existing: string | undefined;
+  try {
+    existing = readFileSync(filePath, 'utf8');
+  } catch {
+    existing = undefined;
+  }
+
+  if (existing !== content) {
+    if (checkMode) {
+      console.error(`${filePath} is out of date.`);
+      hasChanges = true;
+    } else {
+      writeFileSync(filePath, content);
+      console.log(`Updated ${filePath}`);
+    }
+  }
+}
+
 const basicComponents: string[] = [];
 const intentions: string[] = [];
 const dataDisplays: string[] = [];
@@ -287,7 +309,17 @@ class _TagLib:
 
 const allDocs = scanComponentDocs('packages/poml');
 const pythonCode = generatePythonFile(allDocs);
-writeFileSync('packages/poml/assets/componentDocs.json', JSON.stringify(allDocs, null, 2));
-writeFileSync('docs/language/components.md', docsToMarkdown(allDocs));
-writeFileSync('python/poml/_tags.py', pythonCode);
-console.log('Component documentation generated successfully!');
+writeOrCheck('packages/poml/assets/componentDocs.json', JSON.stringify(allDocs, null, 2));
+writeOrCheck('docs/language/components.md', docsToMarkdown(allDocs));
+writeOrCheck('python/poml/_tags.py', pythonCode);
+
+if (checkMode) {
+  if (hasChanges) {
+    console.error('Component documentation is out of date. Run `npm run generate-component-spec` to update.');
+    process.exit(1);
+  } else {
+    console.log('Component documentation is up to date.');
+  }
+} else {
+  console.log('Component documentation generated successfully!');
+}