feat: port compatibility table script to NodeJS

Author: Yoronex

.github/workflows/compatibility.yaml

@@ -25,13 +25,18 @@ jobs:
           path: dependency
           fetch-depth: 0
 
-      - name: Setup Python
-        uses: actions/setup-python@v5
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
-          python-version: '3.13'
+          node-version: "22.x"
+
+      - name: Install dependencies
+        uses: borales/actions-yarn@v5
+        with:
+          cmd: install
 
       - name: Update compatibility table
-        run: python ./source/compatibility-table.py --source-version v${{ needs.versioning.outputs.next-version }} -d ./dependency -r ./source/README.md
+        run: node ./source/compatibility-table.mjs --source-version v${{ needs.versioning.outputs.next-version }} -d ./dependency -r ./source/README.md
 
       - name: Commit changes
         working-directory: ./source

compatibility-table.mjs

@@ -0,0 +1,103 @@
+#!/usr/bin/env node
+
+import fs from 'fs';
+import path from 'path';
+import { execSync } from 'child_process';
+import { Command } from 'commander';
+
+const program = new Command();
+
+program
+  .description('Update the compatibility table in a README file by adding a new row based on repo versions')
+  .option('-s, --source-repo <path>', 'Source git repository')
+  .option('--source-version <version>', 'Source version')
+  .option('-r, --readme <file>', 'Readme file to update', './README.md')
+  .option('-d, --dependency-repo <path>', 'Dependency git repository')
+  .option('--dependency-version <version>', 'Dependency version');
+
+program.parse();
+
+const options = program.opts();
+
+if (!options.sourceRepo && !options.sourceVersion && !options.dependencyRepo && !options.dependencyVersion) {
+  program.help();
+}
+
+if (!fs.existsSync(options.readme)) {
+  console.error(`Cannot find readme file: "${options.readme}"`);
+  process.exit(1);
+}
+
+function getVersionFromGitRepo(repoPath) {
+  if (!fs.existsSync(repoPath)) {
+    console.error('Source repo cannot be found');
+    process.exit(1);
+  }
+  if (!fs.statSync(repoPath).isDirectory()) {
+    console.error('Source repo is not a directory');
+    process.exit(1);
+  }
+  if (!fs.existsSync(path.join(repoPath, '.git'))) {
+    console.error('Source repo does not contain a .git directory');
+    process.exit(1);
+  }
+
+  try {
+    const output = execSync('git describe --tags --abbrev=0', { cwd: repoPath, encoding: 'utf8' });
+    return output.trim();
+  } catch (error) {
+    console.error(`Getting latest tag from git repo "${repoPath}" failed:`, error.message);
+    process.exit(1);
+  }
+}
+
+let sourceVersion = options.sourceVersion;
+if (!sourceVersion) {
+  sourceVersion = getVersionFromGitRepo(options.sourceRepo);
+}
+console.log(`Source version: ${sourceVersion}`);
+
+let dependencyVersion = options.dependencyVersion;
+if (!dependencyVersion) {
+  dependencyVersion = getVersionFromGitRepo(options.dependencyRepo);
+}
+console.log(`Dependency version: ${dependencyVersion}`);
+
+const readmeLines = fs.readFileSync(options.readme, 'utf-8').split(/\r?\n/);
+
+const tableLineIndex = readmeLines.findIndex((line) => /<!-- COMPATIBILITY_TABLE skip:\d+ -->/.test(line));
+
+if (tableLineIndex === -1) {
+  console.error('Compatibility table marker not found in the README.');
+  process.exit(1);
+}
+
+console.log(`Found compatibility marker on line ${tableLineIndex + 1} in ${options.readme}`);
+
+const markerLine = readmeLines[tableLineIndex];
+const markerMatch = markerLine.match(/<!-- COMPATIBILITY_TABLE skip:(\d+)/);
+
+if (!markerMatch) {
+  console.error('Failed to parse compatibility table marker.');
+  process.exit(1);
+}
+
+const skipLines = parseInt(markerMatch[1], 10);
+const addLineIndex = tableLineIndex + skipLines + 1;
+
+const lastLine = readmeLines[addLineIndex];
+if (lastLine && lastLine.startsWith('|')) {
+  const lastVersion = lastLine.slice(2).split(' | ')[0];
+  if (lastVersion === sourceVersion) {
+    console.log(`Most recent version in compatibility table is already ${lastVersion}`);
+    process.exit(1);
+  }
+}
+
+const newLine = `| ${sourceVersion} | ${dependencyVersion}+ |`;
+console.log(`Insert "${newLine}" at line ${addLineIndex} in ${options.readme}`);
+
+readmeLines.splice(addLineIndex, 0, newLine);
+fs.writeFileSync(options.readme, readmeLines.join('\n'), 'utf-8');
+
+console.log('Finish');

package.json

@@ -22,6 +22,7 @@
     "@primevue/themes": "^4.3.2",
     "@tailwindcss/postcss": "^4.1.4",
     "@vee-validate/yup": "^4.15.0",
+    "commander": "^14.0.0",
     "cronstrue": "^2.59.0",
     "dotenv": "^16.5.0",
     "pinia": "^3.0.2",

yarn.lock

@@ -1676,6 +1676,11 @@ commander@^13.1.0:
   resolved "https://registry.yarnpkg.com/commander/-/commander-13.1.0.tgz#776167db68c78f38dcce1f9b8d7b8b9a488abf46"
   integrity sha512-/rFeCpNJQbhSZjGVwO9RFV3xPqbnERS8MmIQzCtD/zl6gpJuV/bMLuN92oG3F7d8oDEHHRrujSXNUr8fpjntKw==
 
+commander@^14.0.0:
+  version "14.0.0"
+  resolved "https://registry.yarnpkg.com/commander/-/commander-14.0.0.tgz#f244fc74a92343514e56229f16ef5c5e22ced5e9"
+  integrity sha512-2uM9rYjPvyq39NwLRqaiLtWHyDC1FvryJDa2ATTVims5YAS4PupsEQsDvP14FqhFr0P49CYDugi59xaxJlTXRA==
+
 commands-events@1.0.4:
   version "1.0.4"
   resolved "https://registry.yarnpkg.com/commands-events/-/commands-events-1.0.4.tgz#772123d7f175b2984474bce37a722f4c2d3d2830"