Merge pull request #38 from nanookclaw/fix/evaluate-json-format

feat(cli): add JSON format for evaluate

Author: SaharPak

packages/cli/src/cli.ts

@@ -30,11 +30,18 @@ async function main() {
 
 async function handleEvaluate(args: string[]) {
   const cvPath = args[0];
-  const jdFlagIndex = args.indexOf("--jd");
-  const jdPath = jdFlagIndex !== -1 ? args[jdFlagIndex + 1] : undefined;
+  const jdPath = readOptionValue(args, "--jd");
+  const format = readOptionValue(args, "--format") ?? "text";
 
-  if (!cvPath) {
-    console.error("Usage: cv-builder evaluate <cv-file> [--jd <jd-file>]");
+  if (!cvPath || cvPath.startsWith("--")) {
+    console.error(
+      "Usage: cv-builder evaluate <cv-file> [--jd <jd-file>] [--format <text|json>]"
+    );
+    process.exit(1);
+  }
+
+  if (format !== "text" && format !== "json") {
+    console.error(`Unknown --format value: ${format}. Supported: text, json`);
     process.exit(1);
   }
 
@@ -46,6 +53,11 @@ async function handleEvaluate(args: string[]) {
     jd: jdContent ? { content: jdContent } : undefined,
   });
 
+  if (format === "json") {
+    console.log(JSON.stringify(result, null, 2));
+    return;
+  }
+
   console.log(`\n  CV Score: ${result.score}/5\n`);
   console.log(`  Archetype detected: ${result.archetype.name}\n`);
   console.log("  Dimensions:");
@@ -74,6 +86,21 @@ async function handleEvaluate(args: string[]) {
   console.log(`\n  ATS Compatible: ${result.atsCompatible ? "✓ Yes" : "✗ No"}\n`);
 }
 
+function readOptionValue(args: string[], option: string): string | undefined {
+  const index = args.indexOf(option);
+  if (index === -1) {
+    return undefined;
+  }
+
+  const value = args[index + 1];
+  if (!value || value.startsWith("--")) {
+    console.error(`Missing value for ${option}`);
+    process.exit(1);
+  }
+
+  return value;
+}
+
 function handleListArchetypes() {
   const archetypes = listArchetypes();
   console.log("\n  Available role archetypes:\n");
@@ -92,13 +119,16 @@ function printHelp() {
     cv-builder <command> [options]
 
   COMMANDS
-    evaluate <cv-file> [--jd <jd-file>]    Score your CV (optionally against a JD)
+    evaluate <cv-file> [--jd <jd-file>] [--format <text|json>]
+                                            Score your CV (optionally against a JD).
+                                            Use --format json for machine-readable output.
     archetypes                              List available role archetypes
     help                                    Show this help
 
   EXAMPLES
     cv-builder evaluate ./my-cv.md
     cv-builder evaluate ./my-cv.md --jd ./job-description.md
+    cv-builder evaluate ./my-cv.md --format json
     cv-builder archetypes
 
   More commands coming soon: tailor, export, suggest

packages/cli/tests/cli.test.ts

@@ -0,0 +1,108 @@
+import { spawnSync } from "node:child_process";
+import { existsSync, mkdtempSync, writeFileSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { dirname, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+import { beforeAll, describe, expect, it } from "vitest";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const cliEntry = resolve(__dirname, "../dist/cli.js");
+
+const CV = `# Jane Doe
+
+## Experience
+
+### Senior Engineer — Acme (2021 – 2024)
+
+- Shipped a payments service in Python on PostgreSQL handling 2M requests/day
+- Reduced p99 latency from 800ms to 120ms by rewriting the hot path in Rust
+- Led migration from Redis to Kafka, cutting infrastructure cost by 35%
+`;
+
+let cvPath: string;
+let jdPath: string;
+
+beforeAll(() => {
+  if (!existsSync(cliEntry)) {
+    throw new Error(
+      `CLI not built at ${cliEntry}. Run \`pnpm --filter @cv-builder/cli build\` first.`
+    );
+  }
+  const dir = mkdtempSync(resolve(tmpdir(), "cv-builder-cli-test-"));
+  cvPath = resolve(dir, "cv.md");
+  jdPath = resolve(dir, "jd.md");
+  writeFileSync(cvPath, CV, "utf-8");
+  writeFileSync(
+    jdPath,
+    "Looking for a Python engineer with PostgreSQL and Kafka experience.",
+    "utf-8"
+  );
+});
+
+function runCli(args: string[]) {
+  return spawnSync("node", [cliEntry, ...args], { encoding: "utf-8" });
+}
+
+describe("cv-builder evaluate --format json", () => {
+  it("emits a valid EvaluationResult JSON object on stdout", () => {
+    const result = runCli(["evaluate", cvPath, "--format", "json"]);
+
+    expect(result.status).toBe(0);
+    const parsed = JSON.parse(result.stdout);
+    expect(typeof parsed.score).toBe("number");
+    expect(Array.isArray(parsed.dimensions)).toBe(true);
+    expect(parsed.dimensions.length).toBeGreaterThan(0);
+    expect(Array.isArray(parsed.strengths)).toBe(true);
+    expect(Array.isArray(parsed.issues)).toBe(true);
+    expect(Array.isArray(parsed.rewrites)).toBe(true);
+    expect(parsed.archetype).toBeDefined();
+    expect(typeof parsed.atsCompatible).toBe("boolean");
+  });
+
+  it("works alongside --jd", () => {
+    const result = runCli(["evaluate", cvPath, "--jd", jdPath, "--format", "json"]);
+
+    expect(result.status).toBe(0);
+    const parsed = JSON.parse(result.stdout);
+    expect(typeof parsed.score).toBe("number");
+    expect(Array.isArray(parsed.dimensions)).toBe(true);
+    expect(parsed.dimensions.length).toBeGreaterThan(0);
+    expect(Array.isArray(parsed.strengths)).toBe(true);
+    expect(Array.isArray(parsed.issues)).toBe(true);
+    expect(Array.isArray(parsed.rewrites)).toBe(true);
+    expect(parsed.archetype).toBeDefined();
+    expect(typeof parsed.atsCompatible).toBe("boolean");
+  });
+
+  it("preserves human-readable output by default", () => {
+    const result = runCli(["evaluate", cvPath]);
+
+    expect(result.status).toBe(0);
+    expect(result.stdout).toContain("CV Score:");
+    expect(() => JSON.parse(result.stdout)).toThrow();
+  });
+
+  it("rejects unknown --format values", () => {
+    const result = runCli(["evaluate", cvPath, "--format", "yaml"]);
+
+    expect(result.status).not.toBe(0);
+    expect(result.stderr).toMatch(/format/i);
+  });
+
+  it("rejects missing option values", () => {
+    const missingFormat = runCli(["evaluate", cvPath, "--format"]);
+    const missingJd = runCli(["evaluate", cvPath, "--jd", "--format", "json"]);
+
+    expect(missingFormat.status).not.toBe(0);
+    expect(missingFormat.stderr).toContain("Missing value for --format");
+    expect(missingJd.status).not.toBe(0);
+    expect(missingJd.stderr).toContain("Missing value for --jd");
+  });
+
+  it("rejects an option token in place of the CV file", () => {
+    const result = runCli(["evaluate", "--format", "json"]);
+
+    expect(result.status).not.toBe(0);
+    expect(result.stderr).toContain("Usage: cv-builder evaluate <cv-file>");
+  });
+});