@specmind/format 0.1.2 → 0.1.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 specmind
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@specmind/format",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": ".sm file format parser and writer",
   "type": "module",
   "main": "./dist/index.js",
@@ -15,13 +15,6 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "tsc",
-    "test": "vitest",
-    "lint": "tsc --noEmit",
-    "clean": "rm -rf dist",
-    "validate-fixtures": "node test-fixtures/validate-fixtures.mjs"
-  },
   "keywords": [
     "specmind",
     "architecture",
@@ -46,5 +39,12 @@
   },
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest",
+    "lint": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "validate-fixtures": "node test-fixtures/validate-fixtures.mjs"
   }
 }

package/dist/writer.d.ts

@@ -1,37 +0,0 @@
-import { SmFile } from './schemas.js';
-/**
- * Converts a SmFile object to markdown format
- *
- * Generates .sm file content according to CONSTITUTION.md Section 4.2 format:
- * - Feature name as # heading
- * - Overview section with markdown content
- * - Requirements as bulleted list
- * - Architecture with mermaid code block
- * - Design decisions as markdown
- * - Integration points as bulleted list
- * - Notes as markdown
- */
-export interface WriteResult {
-    success: boolean;
-    content?: string;
-    error?: string;
-}
-export declare function writeSmFile(smFile: SmFile): WriteResult;
-/**
- * Formats a SmFile for display with metadata
- *
- * @param smFile SmFile object
- * @returns Formatted content with metadata comments
- */
-export declare function writeSmFileWithMetadata(smFile: SmFile): WriteResult;
-/**
- * Validates that a SmFile can be written without data loss
- *
- * @param smFile SmFile to validate
- * @returns Validation result
- */
-export declare function validateSmFileForWriting(smFile: SmFile): {
-    valid: boolean;
-    issues: string[];
-};
-//# sourceMappingURL=writer.d.ts.map

package/dist/writer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"writer.d.ts","sourceRoot":"","sources":["../src/writer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAErC;;;;;;;;;;;GAWG;AAEH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,WAAW,CA8EvD;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,WAAW,CA2BnE;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG;IAAE,KAAK,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CAgC7F"}

package/dist/writer.js

@@ -1,135 +0,0 @@
-export function writeSmFile(smFile) {
-    try {
-        const sections = [];
-        // Feature name as main heading
-        sections.push(`# ${smFile.name}`);
-        sections.push('');
-        // Overview section
-        if (smFile.overview) {
-            sections.push('## Overview');
-            sections.push('');
-            sections.push(smFile.overview);
-            sections.push('');
-        }
-        // Requirements section
-        if (smFile.requirements.length > 0) {
-            sections.push('## Requirements');
-            sections.push('');
-            for (const requirement of smFile.requirements) {
-                sections.push(`- ${requirement}`);
-            }
-            sections.push('');
-        }
-        // Architecture section
-        if (smFile.architecture) {
-            sections.push('## Architecture');
-            sections.push('');
-            sections.push('```mermaid');
-            sections.push(smFile.architecture);
-            sections.push('```');
-            sections.push('');
-        }
-        // Design decisions section
-        if (smFile.designDecisions) {
-            sections.push('## Design Decisions');
-            sections.push('');
-            sections.push(smFile.designDecisions);
-            sections.push('');
-        }
-        // Integration points section
-        if (smFile.integrationPoints.length > 0) {
-            sections.push('## Integration Points');
-            sections.push('');
-            for (const point of smFile.integrationPoints) {
-                sections.push(`- ${point}`);
-            }
-            sections.push('');
-        }
-        // Notes section
-        if (smFile.notes) {
-            sections.push('## Notes');
-            sections.push('');
-            sections.push(smFile.notes);
-        }
-        // Remove trailing empty lines
-        while (sections.length > 0 && sections[sections.length - 1] === '') {
-            sections.pop();
-        }
-        const content = sections.join('\n');
-        return {
-            success: true,
-            content
-        };
-    }
-    catch (error) {
-        return {
-            success: false,
-            error: error instanceof Error ? error.message : 'Unknown writing error'
-        };
-    }
-}
-/**
- * Formats a SmFile for display with metadata
- *
- * @param smFile SmFile object
- * @returns Formatted content with metadata comments
- */
-export function writeSmFileWithMetadata(smFile) {
-    try {
-        const result = writeSmFile(smFile);
-        if (!result.success || !result.content) {
-            return result;
-        }
-        const metadata = [
-            `<!-- Generated by SpecMind -->`,
-            `<!-- Type: ${smFile.type} -->`,
-            `<!-- Created: ${smFile.createdAt.toISOString()} -->`,
-            `<!-- Updated: ${smFile.updatedAt.toISOString()} -->`,
-            ''
-        ];
-        const content = metadata.join('\n') + result.content;
-        return {
-            success: true,
-            content
-        };
-    }
-    catch (error) {
-        return {
-            success: false,
-            error: error instanceof Error ? error.message : 'Unknown writing error'
-        };
-    }
-}
-/**
- * Validates that a SmFile can be written without data loss
- *
- * @param smFile SmFile to validate
- * @returns Validation result
- */
-export function validateSmFileForWriting(smFile) {
-    const issues = [];
-    if (!smFile.name.trim()) {
-        issues.push('Feature name is required');
-    }
-    if (smFile.architecture && !smFile.architecture.trim()) {
-        issues.push('Architecture section is empty but present');
-    }
-    if (smFile.requirements.some(req => !req.trim())) {
-        issues.push('One or more requirements are empty');
-    }
-    if (smFile.integrationPoints.some(point => !point.trim())) {
-        issues.push('One or more integration points are empty');
-    }
-    // Check for potentially problematic content
-    if (smFile.name.includes('\n')) {
-        issues.push('Feature name contains newlines');
-    }
-    if (smFile.architecture.includes('```')) {
-        issues.push('Architecture contains code block markers (``` will be added automatically)');
-    }
-    return {
-        valid: issues.length === 0,
-        issues
-    };
-}
-//# sourceMappingURL=writer.js.map

package/dist/writer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"writer.js","sourceRoot":"","sources":["../src/writer.ts"],"names":[],"mappings":"AAqBA,MAAM,UAAU,WAAW,CAAC,MAAc;IACxC,IAAI,CAAC;QACH,MAAM,QAAQ,GAAa,EAAE,CAAA;QAE7B,+BAA+B;QAC/B,QAAQ,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,CAAA;QACjC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAEjB,mBAAmB;QACnB,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YACpB,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;YAC5B,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACjB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;YAC9B,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACnB,CAAC;QAED,uBAAuB;QACvB,IAAI,MAAM,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;YAChC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACjB,KAAK,MAAM,WAAW,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;gBAC9C,QAAQ,CAAC,IAAI,CAAC,KAAK,WAAW,EAAE,CAAC,CAAA;YACnC,CAAC;YACD,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACnB,CAAC;QAED,uBAAuB;QACvB,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;YACxB,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;YAChC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACjB,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;YAC3B,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;YAClC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACpB,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACnB,CAAC;QAED,2BAA2B;QAC3B,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;YAC3B,QAAQ,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAA;YACpC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACjB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,CAAA;YACrC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACnB,CAAC;QAED,6BAA6B;QAC7B,IAAI,MAAM,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAA;YACtC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACjB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,iBAAiB,EAAE,CAAC;gBAC7C,QAAQ,CAAC,IAAI,CAAC,KAAK,KAAK,EAAE,CAAC,CAAA;YAC7B,CAAC;YACD,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACnB,CAAC;QAED,gBAAgB;QAChB,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACjB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QAC7B,CAAC;QAED,8BAA8B;QAC9B,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC;YACnE,QAAQ,CAAC,GAAG,EAAE,CAAA;QAChB,CAAC;QAED,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEnC,OAAO;YACL,OAAO,EAAE,IAAI;YACb,OAAO;SACR,CAAA;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO;YACL,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,uBAAuB;SACxE,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CAAC,MAAc;IACpD,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;QAClC,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACvC,OAAO,MAAM,CAAA;QACf,CAAC;QAED,MAAM,QAAQ,GAAG;YACf,gCAAgC;YAChC,cAAc,MAAM,CAAC,IAAI,MAAM;YAC/B,iBAAiB,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE,MAAM;YACrD,iBAAiB,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE,MAAM;YACrD,EAAE;SACH,CAAA;QAED,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,OAAO,CAAA;QAEpD,OAAO;YACL,OAAO,EAAE,IAAI;YACb,OAAO;SACR,CAAA;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO;YACL,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,uBAAuB;SACxE,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CAAC,MAAc;IACrD,MAAM,MAAM,GAAa,EAAE,CAAA;IAE3B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;QACxB,MAAM,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAA;IACzC,CAAC;IAED,IAAI,MAAM,CAAC,YAAY,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC;QACvD,MAAM,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAA;IAC1D,CAAC;IAED,IAAI,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QACjD,MAAM,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAA;IACnD,CAAC;IAED,IAAI,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QAC1D,MAAM,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAA;IACzD,CAAC;IAED,4CAA4C;IAC5C,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/B,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAA;IAC/C,CAAC;IAED,IAAI,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACxC,MAAM,CAAC,IAAI,CAAC,4EAA4E,CAAC,CAAA;IAC3F,CAAC;IAED,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;QAC1B,MAAM;KACP,CAAA;AACH,CAAC"}