docspec 0.2.0 → 0.4.0

package/dist/path-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"path-utils.js","sourceRoot":"","sources":["../src/path-utils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAYA,sDAKC;AAMD,sDASC;AAKD,sCAKC;AA1CD,2CAA6B;AAE7B,MAAM,WAAW,GAAG,UAAU,CAAC;AAC/B,MAAM,WAAW,GAAG,aAAa,CAAC;AAClC,MAAM,MAAM,GAAG,KAAK,CAAC;AAErB;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAC,MAAc;IAClD,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC9D,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;IAClF,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAChF,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,GAAG,WAAW,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AAC9E,CAAC;AAED;;;GAGG;AACH,SAAgB,qBAAqB,CAAC,WAAmB;IACvD,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACnE,MAAM,aAAa,GAAG,UAAU,CAAC,UAAU,CAAC,WAAW,GAAG,GAAG,CAAC;QAC5D,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,WAAW,GAAG,GAAG,CAAC,CAAC,MAAM,CAAC;QAC9C,CAAC,CAAC,UAAU,CAAC;IACf,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;QACzC,OAAO,UAAU,CAAC,CAAC,mCAAmC;IACxD,CAAC;IACD,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;AAC9D,CAAC;AAED;;GAEG;AACH,SAAgB,aAAa,CAAC,QAAgB;IAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAChE,OAAO,CACL,UAAU,CAAC,UAAU,CAAC,WAAW,GAAG,GAAG,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,WAAW,CAAC,CAC7E,CAAC;AACJ,CAAC"}

package/dist/{format-parser.d.ts → template.d.ts}

@@ -1,4 +1,4 @@
-export interface ParsedSection {
+interface ParsedSection {
     name: string;
     boilerplate: string;
     number: number;
@@ -9,15 +9,12 @@ export interface ParsedFormat {
     agentInstructions?: string;
 }
 /**
- * Parse the docspec format file
+ * Parse the docspec template file (.docspec/docspec.md) into structure and sections.
  */
 export declare function parseFormatFile(formatFilePath: string): ParsedFormat;
 /**
- * Parse format content from a string
- */
-export declare function parseFormatContent(content: string): ParsedFormat;
-/**
- * Get the path to the format file
+ * Path to the template file (.docspec/docspec.md). Seeds from bundled default if missing.
  */
 export declare function getFormatFilePath(): string;
-//# sourceMappingURL=format-parser.d.ts.map
+export {};
+//# sourceMappingURL=template.d.ts.map

package/dist/template.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"template.d.ts","sourceRoot":"","sources":["../src/template.ts"],"names":[],"mappings":"AAGA,UAAU,aAAa;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,cAAc,EAAE,MAAM,GAAG,YAAY,CAGpE;AA4GD;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,MAAM,CAK1C"}

package/dist/{format-parser.js → template.js}

@@ -34,20 +34,16 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseFormatFile = parseFormatFile;
-exports.parseFormatContent = parseFormatContent;
 exports.getFormatFilePath = getFormatFilePath;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 /**
- * Parse the docspec format file
+ * Parse the docspec template file (.docspec/docspec.md) into structure and sections.
  */
 function parseFormatFile(formatFilePath) {
     const content = fs.readFileSync(formatFilePath, "utf-8");
     return parseFormatContent(content);
 }
-/**
- * Parse format content from a string
- */
 function parseFormatContent(content) {
     const lines = content.split("\n");
     // Look for AGENT INSTRUCTIONS section first
@@ -60,42 +56,32 @@ function parseFormatContent(content) {
             break;
         }
     }
-    // If AGENT INSTRUCTIONS section found, extract it
     if (agentInstructionsStart >= 0) {
-        // Find the end of the AGENT INSTRUCTIONS section
-        // It ends at the next section header (##) or end of file
         for (let i = agentInstructionsStart + 1; i < lines.length; i++) {
             const trimmedLine = lines[i].trim();
-            // Check if this is a section header (starts with ##)
             if (trimmedLine.match(/^##\s+/)) {
                 agentInstructionsEnd = i;
                 break;
             }
         }
-        if (agentInstructionsEnd < 0) {
+        if (agentInstructionsEnd < 0)
             agentInstructionsEnd = lines.length;
-        }
-        // Extract content between header and next section
         const agentLines = lines.slice(agentInstructionsStart + 1, agentInstructionsEnd);
         let agentContent = agentLines.join("\n");
-        // Remove separator lines (---) from the content
         agentContent = agentContent
             .split("\n")
-            .filter(line => line.trim() !== "---")
+            .filter((line) => line.trim() !== "---")
             .join("\n")
             .trim();
-        if (agentContent) {
+        if (agentContent)
             agentInstructions = agentContent;
-        }
     }
     // Find all section headers: ## N. Section Name
     const sectionHeaderRegex = /^##\s+(\d+)\.\s+(.+)$/;
     const sectionHeaders = [];
     for (let i = 0; i < lines.length; i++) {
-        // Skip the AGENT INSTRUCTIONS header if it exists
-        if (lines[i].trim() === "## AGENT INSTRUCTIONS") {
+        if (lines[i].trim() === "## AGENT INSTRUCTIONS")
             continue;
-        }
         const match = lines[i].match(sectionHeaderRegex);
         if (match) {
             sectionHeaders.push({
@@ -106,36 +92,22 @@ function parseFormatContent(content) {
         }
     }
     if (sectionHeaders.length === 0) {
-        throw new Error("No section headers found in format file. Expected format: ## N. Section Name");
+        throw new Error("No section headers found in template. Expected format: ## N. Section Name");
     }
-    // Extract template: everything before the first numbered section header
-    // But exclude the AGENT INSTRUCTIONS section if it exists
     const firstSectionLine = sectionHeaders[0].lineIndex;
-    let templateBeforeSections;
-    if (agentInstructionsStart >= 0 && agentInstructionsStart < firstSectionLine) {
-        // AGENT INSTRUCTIONS is between title and first section
-        // Template is everything before AGENT INSTRUCTIONS
-        templateBeforeSections = lines.slice(0, agentInstructionsStart).join("\n").trim();
-    }
-    else {
-        // No AGENT INSTRUCTIONS, use everything before first section
-        templateBeforeSections = lines.slice(0, firstSectionLine).join("\n").trim();
-    }
+    const templateBeforeSections = agentInstructionsStart >= 0 && agentInstructionsStart < firstSectionLine
+        ? lines.slice(0, agentInstructionsStart).join("\n").trim()
+        : lines.slice(0, firstSectionLine).join("\n").trim();
     const template = templateBeforeSections + "\n\n{{AGENT_INSTRUCTIONS}}\n\n{{SECTIONS}}\n";
-    // Extract sections
     const sections = [];
     for (let i = 0; i < sectionHeaders.length; i++) {
         const header = sectionHeaders[i];
-        const nextHeaderLine = i < sectionHeaders.length - 1
-            ? sectionHeaders[i + 1].lineIndex
-            : lines.length;
-        // Extract content between this header and the next header
+        const nextHeaderLine = i < sectionHeaders.length - 1 ? sectionHeaders[i + 1].lineIndex : lines.length;
         const sectionLines = lines.slice(header.lineIndex + 1, nextHeaderLine);
         let sectionContent = sectionLines.join("\n");
-        // Remove separator lines (---) from the content
         sectionContent = sectionContent
             .split("\n")
-            .filter(line => line.trim() !== "---")
+            .filter((line) => line.trim() !== "---")
             .join("\n")
             .trim();
         sections.push({
@@ -144,7 +116,6 @@ function parseFormatContent(content) {
             number: header.number,
         });
     }
-    // Sort sections by number to ensure correct order
     sections.sort((a, b) => a.number - b.number);
     return {
         sections,
@@ -153,23 +124,28 @@ function parseFormatContent(content) {
     };
 }
 /**
- * Get the path to the format file
+ * Seed .docspec/docspec.md from the bundled docspec-format.md if it doesn't exist.
  */
-function getFormatFilePath() {
-    // In development: use src/docspec-format.md
-    // In built package: use dist/docspec-format.md or root docspec-format.md
-    // Try multiple locations
-    const possiblePaths = [
-        path.join(__dirname, "..", "docspec-format.md"), // Root of project
-        path.join(__dirname, "docspec-format.md"), // In dist/ if copied there
-        path.join(process.cwd(), "docspec-format.md"), // Current working directory
-    ];
-    for (const formatPath of possiblePaths) {
-        if (fs.existsSync(formatPath)) {
-            return formatPath;
-        }
+function seedDefaultFormatFile() {
+    const cwd = process.cwd();
+    const userPath = path.join(cwd, ".docspec", "docspec.md");
+    const defaultPath = path.join(__dirname, "..", "docspec-format.md");
+    if (!fs.existsSync(defaultPath)) {
+        throw new Error(`Default template not found at ${defaultPath}. ` +
+            `Create .docspec/docspec.md in your project or ensure the docspec package is installed correctly.`);
     }
-    // Default to root if none found (will throw error if file doesn't exist)
-    return possiblePaths[0];
+    fs.mkdirSync(path.join(cwd, ".docspec"), { recursive: true });
+    fs.copyFileSync(defaultPath, userPath);
+    return userPath;
+}
+/**
+ * Path to the template file (.docspec/docspec.md). Seeds from bundled default if missing.
+ */
+function getFormatFilePath() {
+    const cwd = process.cwd();
+    const userPath = path.join(cwd, ".docspec", "docspec.md");
+    if (fs.existsSync(userPath))
+        return userPath;
+    return seedDefaultFormatFile();
 }
-//# sourceMappingURL=format-parser.js.map
+//# sourceMappingURL=template.js.map

package/dist/template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template.js","sourceRoot":"","sources":["../src/template.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkBA,0CAGC;AA+GD,8CAKC;AAzID,uCAAyB;AACzB,2CAA6B;AAc7B;;GAEG;AACH,SAAgB,eAAe,CAAC,cAAsB;IACpD,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACzD,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC;AACrC,CAAC;AAED,SAAS,kBAAkB,CAAC,OAAe;IACzC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAElC,4CAA4C;IAC5C,IAAI,iBAAqC,CAAC;IAC1C,IAAI,sBAAsB,GAAG,CAAC,CAAC,CAAC;IAChC,IAAI,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAE9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,uBAAuB,EAAE,CAAC;YAChD,sBAAsB,GAAG,CAAC,CAAC;YAC3B,MAAM;QACR,CAAC;IACH,CAAC;IAED,IAAI,sBAAsB,IAAI,CAAC,EAAE,CAAC;QAChC,KAAK,IAAI,CAAC,GAAG,sBAAsB,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC/D,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YACpC,IAAI,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAChC,oBAAoB,GAAG,CAAC,CAAC;gBACzB,MAAM;YACR,CAAC;QACH,CAAC;QACD,IAAI,oBAAoB,GAAG,CAAC;YAAE,oBAAoB,GAAG,KAAK,CAAC,MAAM,CAAC;QAClE,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,sBAAsB,GAAG,CAAC,EAAE,oBAAoB,CAAC,CAAC;QACjF,IAAI,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzC,YAAY,GAAG,YAAY;aACxB,KAAK,CAAC,IAAI,CAAC;aACX,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,KAAK,CAAC;aACvC,IAAI,CAAC,IAAI,CAAC;aACV,IAAI,EAAE,CAAC;QACV,IAAI,YAAY;YAAE,iBAAiB,GAAG,YAAY,CAAC;IACrD,CAAC;IAED,+CAA+C;IAC/C,MAAM,kBAAkB,GAAG,uBAAuB,CAAC;IACnD,MAAM,cAAc,GAA+D,EAAE,CAAC;IAEtF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,uBAAuB;YAAE,SAAS;QAC1D,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACjD,IAAI,KAAK,EAAE,CAAC;YACV,cAAc,CAAC,IAAI,CAAC;gBAClB,SAAS,EAAE,CAAC;gBACZ,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;gBAC9B,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;aACtB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAC;IAC/F,CAAC;IAED,MAAM,gBAAgB,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACrD,MAAM,sBAAsB,GAC1B,sBAAsB,IAAI,CAAC,IAAI,sBAAsB,GAAG,gBAAgB;QACtE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE;QAC1D,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;IACzD,MAAM,QAAQ,GAAG,sBAAsB,GAAG,8CAA8C,CAAC;IAEzF,MAAM,QAAQ,GAAoB,EAAE,CAAC;IACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC/C,MAAM,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,cAAc,GAClB,CAAC,GAAG,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC;QACjF,MAAM,YAAY,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,EAAE,cAAc,CAAC,CAAC;QACvE,IAAI,cAAc,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7C,cAAc,GAAG,cAAc;aAC5B,KAAK,CAAC,IAAI,CAAC;aACX,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,KAAK,CAAC;aACvC,IAAI,CAAC,IAAI,CAAC;aACV,IAAI,EAAE,CAAC;QACV,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,WAAW,EAAE,cAAc;YAC3B,MAAM,EAAE,MAAM,CAAC,MAAM;SACtB,CAAC,CAAC;IACL,CAAC;IACD,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;IAE7C,OAAO;QACL,QAAQ;QACR,QAAQ;QACR,iBAAiB;KAClB,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAS,qBAAqB;IAC5B,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAC1B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;IAC1D,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,mBAAmB,CAAC,CAAC;IACpE,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CACb,iCAAiC,WAAW,IAAI;YAC9C,kGAAkG,CACrG,CAAC;IACJ,CAAC;IACD,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC9D,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IACvC,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;GAEG;AACH,SAAgB,iBAAiB;IAC/B,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAC1B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;IAC1D,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;QAAE,OAAO,QAAQ,CAAC;IAC7C,OAAO,qBAAqB,EAAE,CAAC;AACjC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docspec",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Docspec is a specification format and toolchain for documentation that is maintained by agents.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/README.docspec.md

@@ -1,180 +0,0 @@
-# DOCSPEC: [README.md](/README.md)
-
-> A specification that defines how the target document should be maintained by agents.
-
-## AGENT INSTRUCTIONS
-
-**Target document:** `README.md`
-
-**Your task:**
-
-* Compare the target document against this docspec.  
-* Update the target document to satisfy this docspec.  
-* Make the smallest changes necessary.  
-* Preserve existing content that already complies.  
-* Do not invent content, sections, or facts not implied by this docspec or the repository.
-
-
-
-## 1. Document Purpose
-
-This README serves as the primary entry point and comprehensive documentation for the docspec project. It is a technical project overview that must answer:
-
-- **What is docspec?** - A specification format and toolchain for agent-maintained documentation
-- **How do I install it?** - npm installation methods (local and global)
-- **How do I use it?** - CLI commands (`validate`, `generate`) and TypeScript API usage
-- **How do I integrate it?** - Pre-commit hooks, GitHub Actions (post-merge sync, manual audit)
-- **What is the docspec format?** - High-level overview and reference to docspec-format.md
-- **How do I develop with it?** - Test and build commands
-
-**Target audiences:**
-- End-users using the CLI for validation and generation
-- Library consumers using the TypeScript API in their projects
-- GitHub Actions users integrating automated documentation workflows
-- CI/CD integrators adding docspec validation to their pipelines
-- Contributors developing and testing the project
-
-**Document type:** Technical project documentation (README/overview)
-
-## 2. Update Triggers
-
-**Changes that SHOULD trigger updates:**
-
-- **CLI changes** (src/cli.ts): New commands, modified command arguments, changed command behavior
-- **Validation logic** (src/validator.ts): New validation rules, changed error messages, modified validation behavior
-- **Docspec format definition** (docspec-format.md): Changes to required sections, section names, validation rules
-- **GitHub Action configuration** (action.yml): New inputs/outputs, changed defaults, modified descriptions
-- **Workflow files** (.github/workflows/docspec-check.yml, docspec-generate.yml): Workflow name changes, trigger changes, new steps or configuration
-- **Installation method** (package.json): Package name changes, new installation requirements
-- **File naming convention**: Changes to how .docspec.md maps to .md files
-- **Required sections** (src/constants.ts): Changes to REQUIRED_SECTIONS array or section definitions
-- **Pre-commit hook configuration** (.pre-commit-config.yaml): Changes to hook setup or usage
-- **Library API exports** (src/index.ts): New exported functions, types, or constants; removed exports; changed function signatures
-
-**Changes that SHOULD NOT trigger updates:**
-
-- Internal implementation details that don't affect public APIs (validator internals, generator internals, format-parser internals)
-- Test file changes (src/__tests__/*) unless they reveal new documented behavior
-- Build system changes (tsconfig.json, package build scripts) that don't affect installation or usage
-- Python script implementation details (docspec_update.py, improve_docspec.py) - these are internal to GitHub Actions
-- Dependency version updates that don't change user-facing functionality
-- Code refactoring that preserves the same external behavior
-
-## 3. Expected Structure
-
-The README must contain these sections in order:
-
-1. **Title and Description**: Package name (`# docspec`) and one-sentence description of what docspec is
-
-2. **The Docspec Format**: High-level overview of the format
-   - Link to docspec-format.md as the definitive format specification
-   - List the 5 required sections by name
-   - Explain validation requirements (non-boilerplate content, 50-character minimum)
-   - Constraint: Do NOT duplicate the full format specification; link to docspec-format.md instead
-
-3. **Installation**: npm installation instructions
-   - Local installation (`npm install docspec`)
-   - Global installation (`npm install -g docspec`)
-   - Constraint: Keep concise, no version-specific details
-
-4. **Usage**: How to use docspec with subsections:
-   - **CLI Commands**: Document `validate` and `generate` commands with examples matching src/cli.ts exactly
-   - **Library Usage**: TypeScript import examples showing exported functions and types from src/index.ts
-   - Constraint: Code examples must be actual working commands from the codebase
-
-5. **Pre-commit Integration**: How to use with pre-commit hooks
-   - Reference .pre-commit-config.yaml
-   - Installation command (`pre-commit install`)
-   - Brief explanation of how validation works
-   - Constraint: High-level only, link to actual config file
-
-6. **GitHub Action Integration**: How to use the GitHub Actions
-   - Overview of the two workflows (post-merge sync, manual audit)
-   - **Post-Merge Documentation Updates** subsection:
-     - Setup instructions (add workflow, configure secrets)
-     - How it works (discovery strategy, Claude Code CLI invocation, PR creation)
-     - File naming convention (filename.docspec.md → filename.md)
-     - Configuration options (reference action.yml inputs)
-     - Safety features (list specific guardrails)
-   - **Manual Docspec Audit** subsection:
-     - What it's for (audit, discover gaps, regenerate)
-     - How it works (two-phase approach: discovery and implementation)
-     - Usage instructions (how to trigger workflow)
-   - Constraint: Link to actual workflow files instead of duplicating YAML; configuration options must match action.yml exactly
-
-7. **Development**: Commands for contributors
-   - Running tests (`npm test`, `npm run test:watch`)
-   - Building (`npm run build`)
-   - Constraint: Keep minimal, only essential commands
-
-8. **License**: License type (MIT)
-
-## 4. Editing Guidelines
-
-**Tone and audience:**
-- Use technical but accessible language
-- Target developers familiar with Node.js/npm, GitHub Actions, and CI/CD concepts
-- Be concise and direct; avoid marketing language
-
-**Code examples and accuracy:**
-- CLI command documentation must match src/cli.ts exactly
-- Library API examples must only show functions/types exported from src/index.ts
-- Action inputs/outputs must match action.yml exactly
-- File paths in examples must use the actual naming convention (.docspec.md → .md)
-- Workflow references should use actual file names (.github/workflows/docspec-check.yml, docspec-generate.yml)
-
-**Level of detail:**
-- Keep workflow configuration sections high-level; link to actual YAML files instead of duplicating content
-- Reference the 5 required sections by name when describing validation
-- Link to docspec-format.md for the full format specification; don't duplicate it in the README
-- Safety features should list specific guardrails without implementation details
-- Pre-commit integration should be high-level; link to .pre-commit-config.yaml
-
-**DO:**
-- Use actual command examples that work: `docspec validate`, `docspec generate path/to/README.docspec.md`
-- Reference source files when describing behavior: "matches src/cli.ts", "exported from src/index.ts"
-- Link to definitive sources: action.yml for configuration options, docspec-format.md for format details
-- Mention that docspec-format.md is included in the published package
-- Note that validation handles permission errors gracefully
-
-**DON'T:**
-- Invent CLI flags or options that don't exist in src/cli.ts
-- Document internal APIs not exported from src/index.ts
-- Include version-specific information (except referencing package.json)
-- Repeat YAML workflow content verbatim; link to files instead
-- Duplicate the docspec format specification from docspec-format.md
-- Add exhaustive lists of every possible feature or edge case
-
-## 5. Intentional Omissions
-
-This README deliberately excludes:
-
-**Internal implementation details:**
-- TypeScript implementation internals (src/validator.ts, src/generator.ts, src/format-parser.ts, src/constants.ts)
-- Validation algorithm implementation details
-- Template rendering and substitution logic
-- How the format file is parsed and cached
-
-**GitHub Action internals:**
-- Python script implementation (docspec_update.py, improve_docspec.py) - these are internal automation scripts
-- Claude Code CLI prompt templates (.github/actions/*/templates/*.md)
-- Action step-by-step implementation details
-- How unified diff patches are generated and applied
-
-**Development and build details:**
-- Test implementation and test file structure (src/__tests__/)
-- Build configuration (tsconfig.json, build scripts)
-- Package.json configuration details beyond installation
-- Pre-commit hook internal implementation
-
-**Docspec format specification:**
-- The detailed format specification lives in docspec-format.md
-- Section definitions, boilerplate text, validation rules are defined there
-- The README provides only a high-level overview and links to the format file
-
-**Where to find this information:**
-- Format specification: docspec-format.md
-- API implementation: src/ directory TypeScript files
-- GitHub Action implementation: .github/actions/ directory
-- Tests: src/__tests__/ directory
-- Build configuration: tsconfig.json, package.json

package/dist/__tests__/generator.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=generator.test.d.ts.map

package/dist/__tests__/generator.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generator.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/generator.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/generator.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"generator.test.js","sourceRoot":"","sources":["../../src/__tests__/generator.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gDAAkC;AAClC,2CAA6B;AAC7B,uCAAyB;AACzB,4CAAuE;AACvE,4CAAiD;AAEjD,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,IAAI,OAAe,CAAC;IAEpB,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,OAAO,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,eAAe,CAAC,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;QACtC,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,OAAO,GAAG,IAAA,kCAAsB,EAAC,WAAW,CAAC,CAAC;YACpD,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,oCAAoC,CAAC,CAAC;QAClE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;YAC9C,MAAM,OAAO,GAAG,IAAA,kCAAsB,EAAC,SAAS,CAAC,CAAC;YAClD,6BAAiB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBACpC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;QAC/B,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;YAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;YACvD,MAAM,IAAA,2BAAe,EAAC,QAAQ,CAAC,CAAC;YAEhC,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;YAC7E,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;YAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;YACvD,MAAM,IAAA,2BAAe,EAAC,QAAQ,CAAC,CAAC;YAEhC,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACrD,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,gCAAgC,CAAC,CAAC;QAC9D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;YAChE,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,2BAA2B,CAAC,CAAC;YACjE,MAAM,IAAA,2BAAe,EAAC,QAAQ,CAAC,CAAC;YAEhC,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACrD,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,oDAAoD,CAAC,CAAC;QAClF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;YAClD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,0BAA0B,CAAC,CAAC;YAChE,MAAM,IAAA,2BAAe,EAAC,QAAQ,CAAC,CAAC;YAEhC,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACrD,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,kDAAkD,CAAC,CAAC;QAChF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;YAClD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC;YAC7D,MAAM,IAAA,2BAAe,EAAC,QAAQ,CAAC,CAAC;YAEhC,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACrD,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,4CAA4C,CAAC,CAAC;QAC1E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;YACpE,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,iBAAiB,CAAC,CAAC;YACzE,MAAM,IAAA,2BAAe,EAAC,QAAQ,CAAC,CAAC;YAEhC,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;YAC7E,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;YACtD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;YACvD,MAAM,IAAA,2BAAe,EAAC,QAAQ,CAAC,CAAC;YAEhC,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YAErD,kBAAkB;YAClB,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YACxC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YACnC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YACnC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;YACtE,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;YACvD,MAAM,IAAA,2BAAe,EAAC,QAAQ,CAAC,CAAC;YAEhC,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACrD,6BAAiB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBACpC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/__tests__/validator.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=validator.test.d.ts.map

package/dist/__tests__/validator.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"validator.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/validator.test.ts"],"names":[],"mappings":""}