Merge pull request #3 from CarlosGamezSynergy/feat/add-automatic-CLI-version-control

Feat/add automatic cli version control

Author: CarlosGamez-Nova

package.json

@@ -41,10 +41,11 @@
     "./package.json": "./package.json"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "node ./scripts/generate-version.js && tsc",
     "prepublishOnly": "pnpm build",
-    "test": "vitest --run",
-    "watch": "tsc --watch"
+    "test": "node ./scripts/generate-version.js && vitest --run",
+    "watch": "tsc --watch",
+    "clean:generated": "rm -rf src/generated"
   },
   "keywords": [
     "zod",

scripts/generate-version.js

@@ -0,0 +1,37 @@
+
+import fs from 'node:fs';
+import path from 'node:path';
+import url from 'node:url';
+
+function generate() {
+  const repoRoot = path.resolve(url.fileURLToPath(new URL('..', import.meta.url)));
+  const pkgPath = path.join(repoRoot, 'package.json');
+  const outDir = path.join(repoRoot, 'src', 'generated');
+  const outFile = path.join(outDir, 'version.ts');
+
+  if (!fs.existsSync(pkgPath)) {
+    console.error('package.json not found at', pkgPath);
+    process.exit(1);
+  }
+
+  const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
+  const version = pkg.version || '0.0.0';
+
+  if (!fs.existsSync(outDir)) {
+    fs.mkdirSync(outDir, { recursive: true });
+  }
+
+  const contents = `// THIS FILE IS AUTO-GENERATED. DO NOT EDIT.\nexport const VERSION = '${version}';\n`;
+
+  fs.writeFileSync(outFile, contents, 'utf8');
+  // Make the file readable
+  try {
+    fs.chmodSync(outFile, 0o644);
+  } catch (e) {
+    // ignore on platforms that don't support chmod in this way
+  }
+  // Log lightly for visibility in CI
+  console.log('Wrote', outFile);
+}
+
+generate();

src/cli/cli.ts

@@ -4,14 +4,42 @@ import chalk from "chalk";
 import { program } from "commander";
 import process from "node:process";
 import path from "path";
+import fs from "node:fs";
+import url from "node:url";
 import type { ZodToD2Config } from "../types/ZodToD2Config.type.js";
 import { ensureDirectoryExists } from "../utils/ensureDirectoryExists.js";
 import { zodToD2 } from "./zodToD2.js";
 
+// Read version from package.json so the CLI stays in sync with the package
+// Prefer the generated VERSION at build time. If missing (for local dev without running the
+// generator), fall back to reading package.json at runtime.
+let CLI_VERSION = "0.0.0";
+try {
+  // Attempt to import generated version (TypeScript source will be compiled to dist)
+  // Use require-like dynamic handling because ts-node or tests may run without build step
+  // Importing the TS file directly via import will be done by the compiler in production.
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  // Try require first (works in node when transpiled to JS)
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  const generated = require("../generated/version");
+  CLI_VERSION = generated?.VERSION ?? CLI_VERSION;
+} catch (err) {
+  // Fallback: read package.json synchronously
+  try {
+    const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
+    const pkgPath = path.resolve(__dirname, "../../package.json");
+    const pkgRaw = fs.readFileSync(pkgPath, "utf8");
+    const pkg = JSON.parse(pkgRaw) as { version?: string };
+    CLI_VERSION = pkg.version ?? CLI_VERSION;
+  } catch (e) {
+    // final fallback already set
+  }
+}
+
 program
   .name("zod2d2")
   .description("CLI tool to convert Zod schemas to D2 diagrams")
-  .version("0.0.22")
+  .version(CLI_VERSION)
   .helpOption("-h, --help", chalk.blue("Display help for command"));
 
 program

src/generated/version.ts

@@ -0,0 +1,2 @@
+// THIS FILE IS AUTO-GENERATED. DO NOT EDIT.
+export const VERSION = '0.0.21';

test/cli/version.test.ts

@@ -0,0 +1,21 @@
+import { test, expect } from 'vitest';
+import { execSync } from 'node:child_process';
+import path from 'node:path';
+import fs from 'node:fs';
+
+test('CLI generated version matches package.json', async () => {
+  const repoRoot = path.resolve(__dirname, '..', '..');
+  // Run generator to ensure generated file is up-to-date
+  execSync('node ./scripts/generate-version.js', { cwd: repoRoot, stdio: 'ignore' });
+
+  // Dynamically import the generated version module
+  const generatedPath = path.join(repoRoot, 'src', 'generated', 'version');
+  const generated = await import(generatedPath);
+  const generatedVersion = generated.VERSION;
+
+  // Read package.json
+  const pkgRaw = fs.readFileSync(path.join(repoRoot, 'package.json'), 'utf8');
+  const pkg = JSON.parse(pkgRaw) as { version?: string };
+
+  expect(generatedVersion).toBe(pkg.version);
+});