paqad-ai

Version:
Spec-driven development framework — AI agents that think before they type
80 lines (70 loc) • 2.35 kB
JavaScript
#!/usr/bin/env node

import { createHash } from 'node:crypto';
import { readFileSync } from 'node:fs';

const MAX_ERRORS = 100;

function stopWith(code, message) {
  process.stderr.write(`check-plan.mjs: ${message}\n`);
  process.exitCode = code;
}

function readInput(file, expected) {
  try {
    return readFileSync(file, 'utf8');
  } catch {
    stopWith(2, `file not found: ${file}. Expected ${expected}.`);
    return null;
  }
}

function parseJson(text) {
  try {
    const value = JSON.parse(text);
    if (value !== null && typeof value === 'object' && !Array.isArray(value)) return value;
  } catch {
    stopWith(1, 'the input is not valid JSON.');
    return null;
  }
  stopWith(1, 'the input is not a JSON object.');
  return null;
}

function finish(input, errors, extra = {}) {
  const hash = createHash('sha256')
    .update(JSON.stringify({ input, errors, ...extra }))
    .digest('hex');
  const shown =
    errors.length > MAX_ERRORS
      ? [...errors.slice(0, MAX_ERRORS), `and ${errors.length - MAX_ERRORS} more`]
      : errors;
  process.stdout.write(
    `${JSON.stringify({ ok: errors.length === 0, errors: shown, hash, ...extra })}\n`,
  );
  process.exitCode = errors.length === 0 ? 0 : 1;
}

const VERDICTS = new Set(['ac-satisfying', 'necessary-setup', 'scaffolding', 'over-build']);

function check(plan) {
  const errors = [];
  const reuse = plan.reuse;
  if (!reuse || typeof reuse !== 'object' || !Array.isArray(reuse.consulted)) {
    errors.push('the plan has no reuse section with a consulted list');
  }
  if (!Array.isArray(plan.steps) || plan.steps.length === 0) {
    errors.push('the plan has no steps');
    return errors;
  }
  plan.steps.forEach((step, index) => {
    const name = step?.id ?? `step ${index + 1}`;
    if (!VERDICTS.has(step?.classification)) {
      errors.push(
        `${name} has no keep-or-drop verdict: set classification to one of ${[...VERDICTS].join(', ')}`,
      );
    }
  });
  return errors;
}

const file = process.argv[2];
if (!file || file === '--help') {
  process.stdout.write('usage: check-plan.mjs <plan-template.json>\nprints { ok, errors, hash }\n');
  process.exitCode = file ? 0 : 2;
} else {
  const text = readInput(file, 'a plan template JSON file');
  const plan = text === null ? null : parseJson(text);
  if (plan !== null) finish(text, check(plan));
}