@shahmarasy/prodo 0.1.4 → 0.1.6

package/src/{paths.ts → core/paths.ts}

@@ -1,72 +1,76 @@
-import path from "node:path";
-import { defaultOutputDir, PRODO_DIR } from "./constants";
-import type { ArtifactType } from "./types";
-
-export function prodoPath(cwd: string): string {
-  return path.join(cwd, PRODO_DIR);
-}
-
-export function briefPath(cwd: string): string {
-  return path.join(cwd, "brief.md");
-}
-
-export function normalizedBriefPath(cwd: string): string {
-  return path.join(prodoPath(cwd), "briefs", "normalized-brief.json");
-}
-
-export function settingsPath(cwd: string): string {
-  return path.join(prodoPath(cwd), "settings.json");
-}
-
-export function registryPath(cwd: string): string {
-  return path.join(prodoPath(cwd), "registry.json");
-}
-
-export function promptPath(cwd: string, artifactType: ArtifactType): string {
-  return path.join(prodoPath(cwd), "prompts", `${artifactType}.md`);
-}
-
-export function templatePath(cwd: string, artifactType: ArtifactType): string {
-  return path.join(prodoPath(cwd), "templates", `${artifactType}.md`);
-}
-
-export function overrideTemplatePath(cwd: string, artifactType: ArtifactType): string {
-  return path.join(prodoPath(cwd), "templates", "overrides", `${artifactType}.md`);
-}
-
-function templateExtensionsForArtifact(artifactType: ArtifactType): string[] {
-  if (artifactType === "workflow") return ["md", "mmd"];
-  if (artifactType === "wireframe") return ["md", "html"];
-  return ["md"];
-}
-
-export function templateCandidatePaths(cwd: string, artifactType: ArtifactType): string[] {
-  const root = path.join(prodoPath(cwd), "templates");
-  return templateExtensionsForArtifact(artifactType).map((ext) => path.join(root, `${artifactType}.${ext}`));
-}
-
-export function overrideTemplateCandidatePaths(cwd: string, artifactType: ArtifactType): string[] {
-  const root = path.join(prodoPath(cwd), "templates", "overrides");
-  return templateExtensionsForArtifact(artifactType).map((ext) => path.join(root, `${artifactType}.${ext}`));
-}
-
-export function schemaPath(cwd: string, artifactType: ArtifactType): string {
-  return path.join(prodoPath(cwd), "schemas", `${artifactType}.yaml`);
-}
-
-export function outputDirPath(cwd: string, artifactType: ArtifactType, outputDirOverride?: string): string {
-  return path.join(cwd, "product-docs", outputDirOverride ?? defaultOutputDir(artifactType));
-}
-
-export function reportPath(cwd: string): string {
-  return path.join(cwd, "product-docs", "reports", "latest-validation.md");
-}
-
-export function outputIndexPath(cwd: string): string {
-  return path.join(prodoPath(cwd), "state", "index.json");
-}
-
-export function outputContextDirPath(cwd: string): string {
-  return path.join(prodoPath(cwd), "state", "context");
-}
+import path from "node:path";
+import { defaultOutputDir, PRODO_DIR } from "./constants";
+import type { ArtifactType } from "./types";
+
+export function prodoPath(cwd: string): string {
+  return path.join(cwd, PRODO_DIR);
+}
+
+export function briefPath(cwd: string): string {
+  return path.join(cwd, "brief.md");
+}
+
+export function normalizedBriefPath(cwd: string): string {
+  return path.join(prodoPath(cwd), "briefs", "normalized-brief.json");
+}
+
+export function settingsPath(cwd: string): string {
+  return path.join(prodoPath(cwd), "settings.json");
+}
+
+export function registryPath(cwd: string): string {
+  return path.join(prodoPath(cwd), "registry.json");
+}
+
+export function promptPath(cwd: string, artifactType: ArtifactType): string {
+  return path.join(prodoPath(cwd), "prompts", `${artifactType}.md`);
+}
+
+export function templatePath(cwd: string, artifactType: ArtifactType): string {
+  return path.join(prodoPath(cwd), "templates", `${artifactType}.md`);
+}
+
+export function overrideTemplatePath(cwd: string, artifactType: ArtifactType): string {
+  return path.join(prodoPath(cwd), "templates", "overrides", `${artifactType}.md`);
+}
+
+function templateExtensionsForArtifact(artifactType: ArtifactType): string[] {
+  if (artifactType === "workflow") return ["md", "mmd"];
+  if (artifactType === "wireframe") return ["md", "html"];
+  return ["md"];
+}
+
+export function templateCandidatePaths(cwd: string, artifactType: ArtifactType): string[] {
+  const root = path.join(prodoPath(cwd), "templates");
+  return templateExtensionsForArtifact(artifactType).map((ext) => path.join(root, `${artifactType}.${ext}`));
+}
+
+export function overrideTemplateCandidatePaths(cwd: string, artifactType: ArtifactType): string[] {
+  const root = path.join(prodoPath(cwd), "templates", "overrides");
+  return templateExtensionsForArtifact(artifactType).map((ext) => path.join(root, `${artifactType}.${ext}`));
+}
+
+export function schemaPath(cwd: string, artifactType: ArtifactType): string {
+  return path.join(prodoPath(cwd), "schemas", `${artifactType}.yaml`);
+}
+
+export function outputDirPath(cwd: string, artifactType: ArtifactType, outputDirOverride?: string): string {
+  return path.join(cwd, "product-docs", outputDirOverride ?? defaultOutputDir(artifactType));
+}
+
+export function reportPath(cwd: string): string {
+  return path.join(cwd, "product-docs", "reports", "latest-validation.md");
+}
+
+export function outputIndexPath(cwd: string): string {
+  return path.join(prodoPath(cwd), "state", "index.json");
+}
+
+export function outputContextDirPath(cwd: string): string {
+  return path.join(prodoPath(cwd), "state", "context");
+}
+
+export function normHistoryPath(cwd: string): string {
+  return path.join(prodoPath(cwd), "_norm_history.json");
+}
 

package/src/{project-config.ts → core/project-config.ts}

@@ -1,78 +1,78 @@
-import fs from "node:fs/promises";
-import path from "node:path";
-import type { ContractCoverage } from "./types";
-import { UserError } from "./errors";
-import { fileExists } from "./utils";
-
-export type ArtifactConfig = {
-  name: string;
-  output_dir?: string;
-  required_headings?: string[];
-  upstream?: string[];
-  required_contracts?: Array<keyof ContractCoverage>;
-};
-
-export type ProdoProjectConfig = {
-  presets?: string[];
-  artifacts?: ArtifactConfig[];
-  command_packs?: string[];
-};
-
-function sanitizeStringArray(value: unknown): string[] {
-  if (!Array.isArray(value)) return [];
-  return value
-    .filter((item): item is string => typeof item === "string")
-    .map((item) => item.trim())
-    .filter((item) => item.length > 0);
-}
-
-function sanitizeArtifact(raw: unknown): ArtifactConfig | null {
-  if (!raw || typeof raw !== "object") return null;
-  const rec = raw as Record<string, unknown>;
-  const name = typeof rec.name === "string" ? rec.name.trim() : "";
-  if (!name) return null;
-  const outputDir = typeof rec.output_dir === "string" ? rec.output_dir.trim() : undefined;
-  const requiredHeadings = sanitizeStringArray(rec.required_headings);
-  const upstream = sanitizeStringArray(rec.upstream);
-  const requiredContracts = sanitizeStringArray(rec.required_contracts)
-    .filter((value): value is keyof ContractCoverage =>
-      value === "goals" || value === "core_features" || value === "constraints");
-  return {
-    name,
-    ...(outputDir ? { output_dir: outputDir } : {}),
-    ...(requiredHeadings.length > 0 ? { required_headings: requiredHeadings } : {}),
-    ...(upstream.length > 0 ? { upstream } : {}),
-    ...(requiredContracts.length > 0 ? { required_contracts: requiredContracts } : {})
-  };
-}
-
-function sanitizeConfig(raw: unknown): ProdoProjectConfig {
-  if (!raw || typeof raw !== "object") return {};
-  const rec = raw as Record<string, unknown>;
-  const artifacts = Array.isArray(rec.artifacts)
-    ? rec.artifacts.map(sanitizeArtifact).filter((item): item is ArtifactConfig => item !== null)
-    : [];
-  return {
-    presets: sanitizeStringArray(rec.presets),
-    command_packs: sanitizeStringArray(rec.command_packs),
-    ...(artifacts.length > 0 ? { artifacts } : {})
-  };
-}
-
-export async function readProjectConfig(cwd: string): Promise<ProdoProjectConfig> {
-  const candidates = [
-    path.join(cwd, ".prodo", "config.json"),
-    path.join(cwd, "prodo.config.json")
-  ];
-  for (const candidate of candidates) {
-    if (!(await fileExists(candidate))) continue;
-    try {
-      const parsed = JSON.parse(await fs.readFile(candidate, "utf8")) as unknown;
-      return sanitizeConfig(parsed);
-    } catch {
-      throw new UserError(`Invalid project config JSON: ${candidate}`);
-    }
-  }
-  return {};
-}
-
+import fs from "node:fs/promises";
+import path from "node:path";
+import type { ContractCoverage } from "./types";
+import { UserError } from "./errors";
+import { fileExists } from "./utils";
+
+export type ArtifactConfig = {
+  name: string;
+  output_dir?: string;
+  required_headings?: string[];
+  upstream?: string[];
+  required_contracts?: Array<keyof ContractCoverage>;
+};
+
+export type ProdoProjectConfig = {
+  presets?: string[];
+  artifacts?: ArtifactConfig[];
+  command_packs?: string[];
+};
+
+function sanitizeStringArray(value: unknown): string[] {
+  if (!Array.isArray(value)) return [];
+  return value
+    .filter((item): item is string => typeof item === "string")
+    .map((item) => item.trim())
+    .filter((item) => item.length > 0);
+}
+
+function sanitizeArtifact(raw: unknown): ArtifactConfig | null {
+  if (!raw || typeof raw !== "object") return null;
+  const rec = raw as Record<string, unknown>;
+  const name = typeof rec.name === "string" ? rec.name.trim() : "";
+  if (!name) return null;
+  const outputDir = typeof rec.output_dir === "string" ? rec.output_dir.trim() : undefined;
+  const requiredHeadings = sanitizeStringArray(rec.required_headings);
+  const upstream = sanitizeStringArray(rec.upstream);
+  const requiredContracts = sanitizeStringArray(rec.required_contracts)
+    .filter((value): value is keyof ContractCoverage =>
+      value === "goals" || value === "core_features" || value === "constraints");
+  return {
+    name,
+    ...(outputDir ? { output_dir: outputDir } : {}),
+    ...(requiredHeadings.length > 0 ? { required_headings: requiredHeadings } : {}),
+    ...(upstream.length > 0 ? { upstream } : {}),
+    ...(requiredContracts.length > 0 ? { required_contracts: requiredContracts } : {})
+  };
+}
+
+function sanitizeConfig(raw: unknown): ProdoProjectConfig {
+  if (!raw || typeof raw !== "object") return {};
+  const rec = raw as Record<string, unknown>;
+  const artifacts = Array.isArray(rec.artifacts)
+    ? rec.artifacts.map(sanitizeArtifact).filter((item): item is ArtifactConfig => item !== null)
+    : [];
+  return {
+    presets: sanitizeStringArray(rec.presets),
+    command_packs: sanitizeStringArray(rec.command_packs),
+    ...(artifacts.length > 0 ? { artifacts } : {})
+  };
+}
+
+export async function readProjectConfig(cwd: string): Promise<ProdoProjectConfig> {
+  const candidates = [
+    path.join(cwd, ".prodo", "config.json"),
+    path.join(cwd, "prodo.config.json")
+  ];
+  for (const candidate of candidates) {
+    if (!(await fileExists(candidate))) continue;
+    try {
+      const parsed = JSON.parse(await fs.readFile(candidate, "utf8")) as unknown;
+      return sanitizeConfig(parsed);
+    } catch {
+      throw new UserError(`Invalid project config JSON: ${candidate}`);
+    }
+  }
+  return {};
+}
+

package/src/{registry.ts → core/registry.ts}

@@ -1,119 +1,119 @@
-import fs from "node:fs/promises";
-import path from "node:path";
-import { createHash } from "node:crypto";
-import { registryPath } from "./paths";
-import { ensureDir, fileExists } from "./utils";
-
-export type OverrideRegistryEntry = {
-  artifact_type: string;
-  file: string;
-  sha256: string;
-};
-
-export type ProdoRegistry = {
-  schema_version: "1.0";
-  updated_at: string;
-  installed_presets: string[];
-  installed_overrides: OverrideRegistryEntry[];
-};
-
-const EMPTY_REGISTRY: ProdoRegistry = {
-  schema_version: "1.0",
-  updated_at: new Date(0).toISOString(),
-  installed_presets: [],
-  installed_overrides: []
-};
-
-async function sha256(filePath: string): Promise<string> {
-  const raw = await fs.readFile(filePath);
-  return createHash("sha256").update(raw).digest("hex");
-}
-
-function sanitizeRegistry(input: unknown): ProdoRegistry {
-  if (!input || typeof input !== "object") return { ...EMPTY_REGISTRY };
-  const raw = input as Record<string, unknown>;
-  const installedPresets = Array.isArray(raw.installed_presets)
-    ? raw.installed_presets
-      .filter((value): value is string => typeof value === "string")
-      .map((value) => value.trim())
-      .filter((value) => value.length > 0)
-    : [];
-  const installedOverrides = Array.isArray(raw.installed_overrides)
-    ? raw.installed_overrides
-      .filter((item): item is Record<string, unknown> => !!item && typeof item === "object")
-      .map((item) => ({
-        artifact_type: typeof item.artifact_type === "string" ? item.artifact_type.trim() : "",
-        file: typeof item.file === "string" ? item.file.trim() : "",
-        sha256: typeof item.sha256 === "string" ? item.sha256.trim() : ""
-      }))
-      .filter((item) => item.artifact_type && item.file && item.sha256)
-    : [];
-  return {
-    schema_version: "1.0",
-    updated_at: typeof raw.updated_at === "string" && raw.updated_at.trim() ? raw.updated_at : EMPTY_REGISTRY.updated_at,
-    installed_presets: Array.from(new Set(installedPresets)),
-    installed_overrides: installedOverrides
-  };
-}
-
-export async function readRegistry(cwd: string): Promise<ProdoRegistry> {
-  const file = registryPath(cwd);
-  if (!(await fileExists(file))) return { ...EMPTY_REGISTRY };
-  try {
-    const parsed = JSON.parse(await fs.readFile(file, "utf8")) as unknown;
-    return sanitizeRegistry(parsed);
-  } catch {
-    return { ...EMPTY_REGISTRY };
-  }
-}
-
-async function readInstalledPresetsFromFile(cwd: string): Promise<string[]> {
-  const file = path.join(cwd, ".prodo", "presets", "installed.json");
-  if (!(await fileExists(file))) return [];
-  try {
-    const parsed = JSON.parse(await fs.readFile(file, "utf8")) as unknown;
-    if (!Array.isArray(parsed)) return [];
-    return parsed
-      .filter((value): value is string => typeof value === "string")
-      .map((value) => value.trim())
-      .filter((value) => value.length > 0);
-  } catch {
-    return [];
-  }
-}
-
-async function discoverOverrides(cwd: string): Promise<OverrideRegistryEntry[]> {
-  const overridesDir = path.join(cwd, ".prodo", "templates", "overrides");
-  if (!(await fileExists(overridesDir))) return [];
-  const entries = await fs.readdir(overridesDir, { withFileTypes: true });
-  const out: OverrideRegistryEntry[] = [];
-  for (const entry of entries) {
-    if (!entry.isFile()) continue;
-    if (!entry.name.endsWith(".md")) continue;
-    const fullPath = path.join(overridesDir, entry.name);
-    out.push({
-      artifact_type: entry.name.replace(/\.md$/, ""),
-      file: fullPath,
-      sha256: await sha256(fullPath)
-    });
-  }
-  out.sort((a, b) => a.artifact_type.localeCompare(b.artifact_type));
-  return out;
-}
-
-export async function syncRegistry(cwd: string): Promise<ProdoRegistry> {
-  const existing = await readRegistry(cwd);
-  const discoveredPresets = await readInstalledPresetsFromFile(cwd);
-  const discoveredOverrides = await discoverOverrides(cwd);
-  const mergedPresets = Array.from(new Set([...existing.installed_presets, ...discoveredPresets])).sort();
-  const merged: ProdoRegistry = {
-    schema_version: "1.0",
-    updated_at: new Date().toISOString(),
-    installed_presets: mergedPresets,
-    installed_overrides: discoveredOverrides
-  };
-  const file = registryPath(cwd);
-  await ensureDir(path.dirname(file));
-  await fs.writeFile(file, `${JSON.stringify(merged, null, 2)}\n`, "utf8");
-  return merged;
-}
+import fs from "node:fs/promises";
+import path from "node:path";
+import { createHash } from "node:crypto";
+import { registryPath } from "./paths";
+import { ensureDir, fileExists } from "./utils";
+
+export type OverrideRegistryEntry = {
+  artifact_type: string;
+  file: string;
+  sha256: string;
+};
+
+export type ProdoRegistry = {
+  schema_version: "1.0";
+  updated_at: string;
+  installed_presets: string[];
+  installed_overrides: OverrideRegistryEntry[];
+};
+
+const EMPTY_REGISTRY: ProdoRegistry = {
+  schema_version: "1.0",
+  updated_at: new Date(0).toISOString(),
+  installed_presets: [],
+  installed_overrides: []
+};
+
+async function sha256(filePath: string): Promise<string> {
+  const raw = await fs.readFile(filePath);
+  return createHash("sha256").update(raw).digest("hex");
+}
+
+function sanitizeRegistry(input: unknown): ProdoRegistry {
+  if (!input || typeof input !== "object") return { ...EMPTY_REGISTRY };
+  const raw = input as Record<string, unknown>;
+  const installedPresets = Array.isArray(raw.installed_presets)
+    ? raw.installed_presets
+      .filter((value): value is string => typeof value === "string")
+      .map((value) => value.trim())
+      .filter((value) => value.length > 0)
+    : [];
+  const installedOverrides = Array.isArray(raw.installed_overrides)
+    ? raw.installed_overrides
+      .filter((item): item is Record<string, unknown> => !!item && typeof item === "object")
+      .map((item) => ({
+        artifact_type: typeof item.artifact_type === "string" ? item.artifact_type.trim() : "",
+        file: typeof item.file === "string" ? item.file.trim() : "",
+        sha256: typeof item.sha256 === "string" ? item.sha256.trim() : ""
+      }))
+      .filter((item) => item.artifact_type && item.file && item.sha256)
+    : [];
+  return {
+    schema_version: "1.0",
+    updated_at: typeof raw.updated_at === "string" && raw.updated_at.trim() ? raw.updated_at : EMPTY_REGISTRY.updated_at,
+    installed_presets: Array.from(new Set(installedPresets)),
+    installed_overrides: installedOverrides
+  };
+}
+
+export async function readRegistry(cwd: string): Promise<ProdoRegistry> {
+  const file = registryPath(cwd);
+  if (!(await fileExists(file))) return { ...EMPTY_REGISTRY };
+  try {
+    const parsed = JSON.parse(await fs.readFile(file, "utf8")) as unknown;
+    return sanitizeRegistry(parsed);
+  } catch {
+    return { ...EMPTY_REGISTRY };
+  }
+}
+
+async function readInstalledPresetsFromFile(cwd: string): Promise<string[]> {
+  const file = path.join(cwd, ".prodo", "presets", "installed.json");
+  if (!(await fileExists(file))) return [];
+  try {
+    const parsed = JSON.parse(await fs.readFile(file, "utf8")) as unknown;
+    if (!Array.isArray(parsed)) return [];
+    return parsed
+      .filter((value): value is string => typeof value === "string")
+      .map((value) => value.trim())
+      .filter((value) => value.length > 0);
+  } catch {
+    return [];
+  }
+}
+
+async function discoverOverrides(cwd: string): Promise<OverrideRegistryEntry[]> {
+  const overridesDir = path.join(cwd, ".prodo", "templates", "overrides");
+  if (!(await fileExists(overridesDir))) return [];
+  const entries = await fs.readdir(overridesDir, { withFileTypes: true });
+  const out: OverrideRegistryEntry[] = [];
+  for (const entry of entries) {
+    if (!entry.isFile()) continue;
+    if (!entry.name.endsWith(".md")) continue;
+    const fullPath = path.join(overridesDir, entry.name);
+    out.push({
+      artifact_type: entry.name.replace(/\.md$/, ""),
+      file: fullPath,
+      sha256: await sha256(fullPath)
+    });
+  }
+  out.sort((a, b) => a.artifact_type.localeCompare(b.artifact_type));
+  return out;
+}
+
+export async function syncRegistry(cwd: string): Promise<ProdoRegistry> {
+  const existing = await readRegistry(cwd);
+  const discoveredPresets = await readInstalledPresetsFromFile(cwd);
+  const discoveredOverrides = await discoverOverrides(cwd);
+  const mergedPresets = Array.from(new Set([...existing.installed_presets, ...discoveredPresets])).sort();
+  const merged: ProdoRegistry = {
+    schema_version: "1.0",
+    updated_at: new Date().toISOString(),
+    installed_presets: mergedPresets,
+    installed_overrides: discoveredOverrides
+  };
+  const file = registryPath(cwd);
+  await ensureDir(path.dirname(file));
+  await fs.writeFile(file, `${JSON.stringify(merged, null, 2)}\n`, "utf8");
+  return merged;
+}

package/src/{settings.ts → core/settings.ts}

@@ -6,6 +6,7 @@ export type ProdoSettings = {
   lang: string;
   ai?: string;
   author?: string;
+  provider?: string;
 };
 
 const DEFAULT_SETTINGS: ProdoSettings = {
@@ -21,7 +22,8 @@ export async function readSettings(cwd: string): Promise<ProdoSettings> {
     return {
       lang: typeof parsed.lang === "string" && parsed.lang.trim() ? parsed.lang.trim() : "en",
       ai: typeof parsed.ai === "string" && parsed.ai.trim() ? parsed.ai.trim() : undefined,
-      author: typeof parsed.author === "string" && parsed.author.trim() ? parsed.author.trim() : undefined
+      author: typeof parsed.author === "string" && parsed.author.trim() ? parsed.author.trim() : undefined,
+      provider: typeof parsed.provider === "string" && parsed.provider.trim() ? parsed.provider.trim() : undefined
     };
   } catch {
     return { ...DEFAULT_SETTINGS };
@@ -30,6 +32,10 @@ export async function readSettings(cwd: string): Promise<ProdoSettings> {
 
 export async function writeSettings(cwd: string, settings: ProdoSettings): Promise<string> {
   const path = settingsPath(cwd);
-  await fs.writeFile(path, `${JSON.stringify(settings, null, 2)}\n`, "utf8");
+  const clean: Record<string, unknown> = { lang: settings.lang };
+  if (settings.ai) clean.ai = settings.ai;
+  if (settings.author) clean.author = settings.author;
+  if (settings.provider) clean.provider = settings.provider;
+  await fs.writeFile(path, `${JSON.stringify(clean, null, 2)}\n`, "utf8");
   return path;
 }

package/src/core/template-engine.ts

@@ -0,0 +1,45 @@
+import nunjucks from "nunjucks";
+
+const env = new nunjucks.Environment(null, {
+  autoescape: false,
+  throwOnUndefined: false,
+  trimBlocks: false,
+  lstripBlocks: false
+});
+
+env.addFilter("slug", (value: string): string => {
+  return (value || "")
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, "-")
+    .replace(/^-+|-+$/g, "") || "item";
+});
+
+env.addFilter("bold", (value: string): string => {
+  return `**${value ?? ""}**`;
+});
+
+env.addFilter("dateFormat", (value: string | Date | undefined): string => {
+  if (!value) return new Date().toISOString().split("T")[0];
+  const d = typeof value === "string" ? new Date(value) : value;
+  return d.toISOString().split("T")[0];
+});
+
+env.addFilter("upper", (value: string): string => {
+  return (value ?? "").toUpperCase();
+});
+
+env.addFilter("default", (value: unknown, fallback: string): string => {
+  if (value === null || value === undefined || value === "") return fallback;
+  return String(value);
+});
+
+export function renderTemplate(
+  content: string,
+  context: Record<string, unknown>
+): string {
+  return env.renderString(content, context);
+}
+
+export function getTemplateEnv(): nunjucks.Environment {
+  return env;
+}