@spekn/cli 1.0.0

package/dist/spec-frontmatter.js

@@ -0,0 +1,219 @@
+#!/usr/bin/env node
+"use strict";
+/**
+ * spec-frontmatter CLI Tool
+ *
+ * Parse and validate YAML frontmatter from a specification file.
+ *
+ * Usage: spekn spec frontmatter <spec-file-path> [OPTIONS]
+ * Example: spekn spec frontmatter specs/SPECIFICATION.md
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = main;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const shared_1 = require("@spekn/shared");
+const cli_runtime_1 = require("./utils/cli-runtime");
+function parseArgs(args) {
+    const options = {};
+    let filePath;
+    for (let i = 0; i < args.length; i++) {
+        const arg = args[i];
+        if (arg === "--verbose" || arg === "-v") {
+            options.verbose = true;
+        }
+        else if (arg === "--json" || arg === "-j") {
+            options.json = true;
+        }
+        else if (arg === "--validate-only") {
+            options.validateOnly = true;
+        }
+        else if (arg === "--auto-generate") {
+            options.autoGenerate = true;
+        }
+        else if (!arg.startsWith("-")) {
+            filePath = arg;
+        }
+    }
+    if (!filePath) {
+        throw new Error("missing required argument: <spec-file-path>");
+    }
+    return { filePath, options };
+}
+function printHelp() {
+    console.log(`
+spec-frontmatter - Parse and validate specification frontmatter
+
+USAGE:
+  spekn spec frontmatter <spec-file-path> [OPTIONS]
+
+ARGUMENTS:
+  <spec-file-path>      Path to the specification markdown file
+
+OPTIONS:
+  -v, --verbose         Show detailed output including all fields
+  -j, --json            Output in JSON format
+  --validate-only       Only validate, don't display parsed result
+  --auto-generate       Generate minimal frontmatter if missing
+  -h, --help            Show this help message
+
+EXAMPLES:
+  spekn spec frontmatter specs/SPECIFICATION.md
+  spekn spec frontmatter specs/SPECIFICATION.md --json
+  spekn spec frontmatter specs/SPECIFICATION.md --validate-only
+  spekn spec frontmatter specs/SPECIFICATION.md --auto-generate
+`);
+}
+function main(argv) {
+    const args = argv ?? process.argv.slice(2);
+    if ((0, cli_runtime_1.hasHelpFlag)(args)) {
+        printHelp();
+        return 0;
+    }
+    let filePath;
+    let options;
+    try {
+        ({ filePath, options } = parseArgs(args));
+    }
+    catch {
+        console.error("Error: Missing required argument <spec-file-path>");
+        printHelp();
+        return 1;
+    }
+    const resolvedPath = path.resolve(process.cwd(), filePath);
+    if (!fs.existsSync(resolvedPath)) {
+        console.error(`Error: File not found: ${resolvedPath}`);
+        return 1;
+    }
+    let content;
+    try {
+        content = fs.readFileSync(resolvedPath, "utf-8");
+    }
+    catch (error) {
+        console.error(`Error reading file: ${(0, cli_runtime_1.errorMessage)(error)}`);
+        return 1;
+    }
+    const result = (0, shared_1.parseSpecificationFrontmatter)(content);
+    // Auto-generate if requested and no frontmatter found
+    if (!result.hasFrontmatter && options.autoGenerate) {
+        const generated = (0, shared_1.autoGenerateFrontmatter)(content);
+        const yamlStr = (0, shared_1.serializeFrontmatter)(generated);
+        if (options.json) {
+            console.log(JSON.stringify({ frontmatter: generated, autoGenerated: true }, null, 2));
+        }
+        else {
+            console.log("\nNo frontmatter found. Auto-generated minimal frontmatter:\n");
+            console.log(yamlStr);
+            console.log();
+        }
+        return 0;
+    }
+    // Handle validation errors
+    if (result.errors?.length) {
+        if (options.json) {
+            console.log(JSON.stringify({ errors: result.errors, valid: false }, null, 2));
+        }
+        else {
+            console.error(`\nFrontmatter validation failed for ${path.basename(filePath)}:\n`);
+            for (const error of result.errors) {
+                console.error(`  - ${error}`);
+            }
+            console.error();
+        }
+        return 1;
+    }
+    // No frontmatter found
+    if (!result.hasFrontmatter) {
+        if (options.json) {
+            console.log(JSON.stringify({ hasFrontmatter: false, valid: false }, null, 2));
+        }
+        else {
+            console.error(`\nError: No frontmatter found in ${path.basename(filePath)}`);
+            console.error("  Specifications require YAML frontmatter delimited by --- markers.");
+            console.error("  Use --auto-generate to create minimal frontmatter.\n");
+        }
+        return 1;
+    }
+    // Validate-only mode
+    if (options.validateOnly) {
+        if (options.json) {
+            console.log(JSON.stringify({ valid: true }, null, 2));
+        }
+        else {
+            console.log(`\nFrontmatter valid in ${path.basename(filePath)}\n`);
+        }
+        return 0;
+    }
+    // Display parsed frontmatter
+    if (options.json) {
+        console.log(JSON.stringify(result, null, 2));
+    }
+    else {
+        const fm = result.frontmatter;
+        console.log(`\nFrontmatter for ${path.basename(filePath)}:\n`);
+        console.log(`  Title:   ${fm.title}`);
+        console.log(`  Type:    ${fm.type}`);
+        console.log(`  Version: ${fm.version}`);
+        if (fm.status)
+            console.log(`  Status:  ${fm.status}`);
+        if (fm.author)
+            console.log(`  Author:  ${fm.author}`);
+        if (fm.specRef)
+            console.log(`  SpecRef: ${fm.specRef}`);
+        if (fm.tags?.length)
+            console.log(`  Tags:    ${fm.tags.join(", ")}`);
+        if (fm.hints && options.verbose) {
+            console.log("\n  Content Hints:");
+            for (const [layer, hints] of Object.entries(fm.hints)) {
+                if (hints?.length) {
+                    console.log(`    ${layer}:`);
+                    for (const hint of hints) {
+                        console.log(`      - ${hint}`);
+                    }
+                }
+            }
+        }
+        if (fm.dependsOn?.length)
+            console.log(`\n  Dependencies: ${fm.dependsOn.join(", ")}`);
+        if (fm.extends)
+            console.log(`  Extends: ${fm.extends}`);
+        console.log();
+    }
+    return 0;
+}
+if (require.main === module) {
+    void (0, cli_runtime_1.runCliMain)(main, { errorPrefix: "spec-frontmatter failed" });
+}

package/dist/spec-lint.d.ts

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+/**
+ * spec-lint CLI Tool
+ *
+ * Validate specification markdown quality and structure.
+ *
+ * Usage: npm run spec-lint <spec-file-path>
+ * Example: npm run spec-lint specs/DECISIONS.md
+ */
+declare function main(argv?: string[]): number;
+export { main };