@mytechtoday/augment-extensions 0.1.2 → 0.4.0

package/cli/dist/utils/documentation-validator.d.ts

@@ -0,0 +1,18 @@
+import { Module, ValidationResult } from './module-system';
+/**
+ * Validate module README.md has required sections
+ */
+export declare function validateReadmeStructure(modulePath: string): ValidationResult;
+/**
+ * Validate module has comprehensive documentation
+ */
+export declare function validateModuleDocumentation(module: Module): ValidationResult;
+/**
+ * Extract module overview from README.md
+ */
+export declare function extractModuleOverview(modulePath: string): string;
+/**
+ * Extract character count from README.md
+ */
+export declare function extractCharacterCountFromReadme(modulePath: string): number | null;
+//# sourceMappingURL=documentation-validator.d.ts.map

package/cli/dist/utils/documentation-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentation-validator.d.ts","sourceRoot":"","sources":["../../src/utils/documentation-validator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAW3D;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,MAAM,GAAG,gBAAgB,CAuC5E;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAsG5E;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAoChE;AAED;;GAEG;AACH,wBAAgB,+BAA+B,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAwBjF"}

package/cli/dist/utils/documentation-validator.js

@@ -0,0 +1,233 @@
+"use strict";
+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.validateReadmeStructure = validateReadmeStructure;
+exports.validateModuleDocumentation = validateModuleDocumentation;
+exports.extractModuleOverview = extractModuleOverview;
+exports.extractCharacterCountFromReadme = extractCharacterCountFromReadme;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+/**
+ * Required sections in README.md
+ */
+const REQUIRED_README_SECTIONS = [
+    'Overview',
+    'Contents',
+    'Character Count'
+];
+/**
+ * Validate module README.md has required sections
+ */
+function validateReadmeStructure(modulePath) {
+    const errors = [];
+    const warnings = [];
+    const readmePath = path.join(modulePath, 'README.md');
+    if (!fs.existsSync(readmePath)) {
+        errors.push('README.md file is missing');
+        return { valid: false, errors, warnings };
+    }
+    const content = fs.readFileSync(readmePath, 'utf-8');
+    // Check for required sections
+    for (const section of REQUIRED_README_SECTIONS) {
+        // Look for markdown headers (# Section or ## Section)
+        const sectionPattern = new RegExp(`^#{1,3}\\s+${section}`, 'mi');
+        if (!sectionPattern.test(content)) {
+            errors.push(`README.md missing required section: ${section}`);
+        }
+    }
+    // Check for empty README
+    if (content.trim().length < 100) {
+        warnings.push('README.md appears to be too short (< 100 characters)');
+    }
+    // Check for module name in title
+    const titlePattern = /^#\s+(.+)/m;
+    const titleMatch = content.match(titlePattern);
+    if (!titleMatch) {
+        warnings.push('README.md missing title (# heading)');
+    }
+    return {
+        valid: errors.length === 0,
+        errors,
+        warnings
+    };
+}
+/**
+ * Validate module has comprehensive documentation
+ */
+function validateModuleDocumentation(module) {
+    const errors = [];
+    const warnings = [];
+    // Validate README.md structure
+    const readmeValidation = validateReadmeStructure(module.path);
+    errors.push(...readmeValidation.errors);
+    warnings.push(...readmeValidation.warnings);
+    // Check for rule files
+    if (module.rules.length === 0) {
+        errors.push('Module has no rule files in rules/ directory');
+    }
+    // Check for examples (optional but recommended for certain module types)
+    if (module.examples.length === 0) {
+        if (module.metadata.type === 'examples') {
+            errors.push('Examples module must have files in examples/ directory');
+        }
+        else if (module.metadata.type === 'coding-standards') {
+            warnings.push('Coding standards module should have examples in examples/ directory (recommended)');
+        }
+        else {
+            warnings.push('Module has no examples in examples/ directory (optional but recommended)');
+        }
+    }
+    // Validate each rule file has content
+    const rulesDir = path.join(module.path, 'rules');
+    for (const ruleFile of module.rules) {
+        const rulePath = path.join(rulesDir, ruleFile);
+        const content = fs.readFileSync(rulePath, 'utf-8');
+        if (content.trim().length < 100) {
+            warnings.push(`Rule file ${ruleFile} appears to be too short (< 100 characters)`);
+        }
+        // Check for markdown headers
+        if (!content.match(/^#{1,3}\s+/m)) {
+            warnings.push(`Rule file ${ruleFile} missing markdown headers`);
+        }
+        // Check for code examples in rule files (recommended)
+        if (!content.match(/```/)) {
+            warnings.push(`Rule file ${ruleFile} has no code examples (recommended for clarity)`);
+        }
+        // Check for actionable content (should have lists or steps)
+        if (!content.match(/^[-*]\s+/m) && !content.match(/^\d+\.\s+/m)) {
+            warnings.push(`Rule file ${ruleFile} lacks actionable content (lists or numbered steps recommended)`);
+        }
+    }
+    // Validate module.json completeness
+    if (!module.metadata.displayName) {
+        errors.push('module.json missing displayName field');
+    }
+    if (!module.metadata.description) {
+        errors.push('module.json missing description field');
+    }
+    else if (module.metadata.description.length < 20) {
+        warnings.push('module.json description is too short (< 20 characters)');
+    }
+    else if (module.metadata.description.length > 200) {
+        warnings.push('module.json description is too long (> 200 characters) - consider shortening');
+    }
+    if (!module.metadata.tags || module.metadata.tags.length === 0) {
+        warnings.push('module.json missing tags field (recommended for discoverability)');
+    }
+    if (!module.metadata.augment?.characterCount) {
+        warnings.push('module.json missing augment.characterCount field (required for catalog)');
+    }
+    if (!module.metadata.augment?.priority) {
+        warnings.push('module.json missing augment.priority field (recommended: high, medium, or low)');
+    }
+    // Validate README.md has usage examples
+    const readmePath = path.join(module.path, 'README.md');
+    if (fs.existsSync(readmePath)) {
+        const readmeContent = fs.readFileSync(readmePath, 'utf-8');
+        // Check for usage section
+        if (!readmeContent.match(/^#{1,3}\s+Usage/mi)) {
+            warnings.push('README.md missing Usage section (recommended)');
+        }
+        // Check for installation/setup section
+        if (!readmeContent.match(/^#{1,3}\s+(Installation|Setup)/mi)) {
+            warnings.push('README.md missing Installation or Setup section (recommended)');
+        }
+        // Check for examples in README
+        if (!readmeContent.match(/```/)) {
+            warnings.push('README.md has no code examples (recommended)');
+        }
+    }
+    return {
+        valid: errors.length === 0,
+        errors,
+        warnings
+    };
+}
+/**
+ * Extract module overview from README.md
+ */
+function extractModuleOverview(modulePath) {
+    const readmePath = path.join(modulePath, 'README.md');
+    if (!fs.existsSync(readmePath)) {
+        return '';
+    }
+    const content = fs.readFileSync(readmePath, 'utf-8');
+    // Extract first paragraph after title
+    const lines = content.split('\n');
+    let overview = '';
+    let foundTitle = false;
+    for (const line of lines) {
+        if (line.match(/^#\s+/)) {
+            foundTitle = true;
+            continue;
+        }
+        if (foundTitle && line.trim().length > 0 && !line.match(/^#{1,3}\s+/)) {
+            overview += line + ' ';
+            // Stop at next heading or after a reasonable length
+            if (overview.length > 200) {
+                break;
+            }
+        }
+        // Stop at next heading
+        if (foundTitle && line.match(/^#{1,3}\s+/)) {
+            break;
+        }
+    }
+    return overview.trim();
+}
+/**
+ * Extract character count from README.md
+ */
+function extractCharacterCountFromReadme(modulePath) {
+    const readmePath = path.join(modulePath, 'README.md');
+    if (!fs.existsSync(readmePath)) {
+        return null;
+    }
+    const content = fs.readFileSync(readmePath, 'utf-8');
+    // Look for character count patterns
+    const patterns = [
+        /Character Count[:\s]+~?(\d{1,3}(?:,\d{3})*)/i,
+        /~(\d{1,3}(?:,\d{3})*)\s+characters/i,
+        /Total:\s+~?(\d{1,3}(?:,\d{3})*)/i
+    ];
+    for (const pattern of patterns) {
+        const match = content.match(pattern);
+        if (match) {
+            return parseInt(match[1].replace(/,/g, ''), 10);
+        }
+    }
+    return null;
+}
+//# sourceMappingURL=documentation-validator.js.map

package/cli/dist/utils/documentation-validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentation-validator.js","sourceRoot":"","sources":["../../src/utils/documentation-validator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgBA,0DAuCC;AAKD,kEAsGC;AAKD,sDAoCC;AAKD,0EAwBC;AAxOD,uCAAyB;AACzB,2CAA6B;AAG7B;;GAEG;AACH,MAAM,wBAAwB,GAAG;IAC/B,UAAU;IACV,UAAU;IACV,iBAAiB;CAClB,CAAC;AAEF;;GAEG;AACH,SAAgB,uBAAuB,CAAC,UAAkB;IACxD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;IAEtD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/B,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;QACzC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IAC5C,CAAC;IAED,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAErD,8BAA8B;IAC9B,KAAK,MAAM,OAAO,IAAI,wBAAwB,EAAE,CAAC;QAC/C,sDAAsD;QACtD,MAAM,cAAc,GAAG,IAAI,MAAM,CAAC,cAAc,OAAO,EAAE,EAAE,IAAI,CAAC,CAAC;QACjE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAClC,MAAM,CAAC,IAAI,CAAC,uCAAuC,OAAO,EAAE,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IAED,yBAAyB;IACzB,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;QAChC,QAAQ,CAAC,IAAI,CAAC,sDAAsD,CAAC,CAAC;IACxE,CAAC;IAED,iCAAiC;IACjC,MAAM,YAAY,GAAG,YAAY,CAAC;IAClC,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAC/C,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,QAAQ,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;IACvD,CAAC;IAED,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;QAC1B,MAAM;QACN,QAAQ;KACT,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,2BAA2B,CAAC,MAAc;IACxD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,+BAA+B;IAC/B,MAAM,gBAAgB,GAAG,uBAAuB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC9D,MAAM,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACxC,QAAQ,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAE5C,uBAAuB;IACvB,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,MAAM,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC;IAC9D,CAAC;IAED,yEAAyE;IACzE,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACjC,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YACxC,MAAM,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;QACxE,CAAC;aAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;YACvD,QAAQ,CAAC,IAAI,CAAC,mFAAmF,CAAC,CAAC;QACrG,CAAC;aAAM,CAAC;YACN,QAAQ,CAAC,IAAI,CAAC,0EAA0E,CAAC,CAAC;QAC5F,CAAC;IACH,CAAC;IAED,sCAAsC;IACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACjD,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC/C,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAEnD,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;YAChC,QAAQ,CAAC,IAAI,CAAC,aAAa,QAAQ,6CAA6C,CAAC,CAAC;QACpF,CAAC;QAED,6BAA6B;QAC7B,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;YAClC,QAAQ,CAAC,IAAI,CAAC,aAAa,QAAQ,2BAA2B,CAAC,CAAC;QAClE,CAAC;QAED,sDAAsD;QACtD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,QAAQ,CAAC,IAAI,CAAC,aAAa,QAAQ,iDAAiD,CAAC,CAAC;QACxF,CAAC;QAED,4DAA4D;QAC5D,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;YAChE,QAAQ,CAAC,IAAI,CAAC,aAAa,QAAQ,iEAAiE,CAAC,CAAC;QACxG,CAAC;IACH,CAAC;IAED,oCAAoC;IACpC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;IACvD,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;IACvD,CAAC;SAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QACnD,QAAQ,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;IAC1E,CAAC;SAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;QACpD,QAAQ,CAAC,IAAI,CAAC,8EAA8E,CAAC,CAAC;IAChG,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/D,QAAQ,CAAC,IAAI,CAAC,kEAAkE,CAAC,CAAC;IACpF,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,cAAc,EAAE,CAAC;QAC7C,QAAQ,CAAC,IAAI,CAAC,yEAAyE,CAAC,CAAC;IAC3F,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC;QACvC,QAAQ,CAAC,IAAI,CAAC,gFAAgF,CAAC,CAAC;IAClG,CAAC;IAED,wCAAwC;IACxC,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IACvD,IAAI,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9B,MAAM,aAAa,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAE3D,0BAA0B;QAC1B,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,mBAAmB,CAAC,EAAE,CAAC;YAC9C,QAAQ,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC;QACjE,CAAC;QAED,uCAAuC;QACvC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,kCAAkC,CAAC,EAAE,CAAC;YAC7D,QAAQ,CAAC,IAAI,CAAC,+DAA+D,CAAC,CAAC;QACjF,CAAC;QAED,+BAA+B;QAC/B,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,QAAQ,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IAED,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;QAC1B,MAAM;QACN,QAAQ;KACT,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,qBAAqB,CAAC,UAAkB;IACtD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;IAEtD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAErD,sCAAsC;IACtC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAClC,IAAI,QAAQ,GAAG,EAAE,CAAC;IAClB,IAAI,UAAU,GAAG,KAAK,CAAC;IAEvB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;YACxB,UAAU,GAAG,IAAI,CAAC;YAClB,SAAS;QACX,CAAC;QAED,IAAI,UAAU,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;YACtE,QAAQ,IAAI,IAAI,GAAG,GAAG,CAAC;YAEvB,oDAAoD;YACpD,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;gBAC1B,MAAM;YACR,CAAC;QACH,CAAC;QAED,uBAAuB;QACvB,IAAI,UAAU,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;YAC3C,MAAM;QACR,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACzB,CAAC;AAED;;GAEG;AACH,SAAgB,+BAA+B,CAAC,UAAkB;IAChE,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;IAEtD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAErD,oCAAoC;IACpC,MAAM,QAAQ,GAAG;QACf,8CAA8C;QAC9C,qCAAqC;QACrC,kCAAkC;KACnC,CAAC;IAEF,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACrC,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}

package/cli/dist/utils/install-rules.d.ts

@@ -0,0 +1,32 @@
+export interface InstallRulesOptions {
+    targetDir?: string;
+    skipIfExists?: boolean;
+    verbose?: boolean;
+    force?: boolean;
+    interactive?: boolean;
+}
+export interface InstallRulesResult {
+    success: boolean;
+    created: boolean;
+    skipped: boolean;
+    updated?: boolean;
+    error?: string;
+    errorType?: 'PERMISSION_DENIED' | 'DISK_FULL' | 'CONFLICT' | 'UNKNOWN';
+    path?: string;
+}
+/**
+ * Error types for better error handling
+ */
+export declare class InstallRulesError extends Error {
+    type: 'PERMISSION_DENIED' | 'DISK_FULL' | 'CONFLICT' | 'UNKNOWN';
+    originalError?: Error | undefined;
+    constructor(message: string, type: 'PERMISSION_DENIED' | 'DISK_FULL' | 'CONFLICT' | 'UNKNOWN', originalError?: Error | undefined);
+}
+/**
+ * Install character count management rule to .augment/rules directory
+ *
+ * @param options - Installation options
+ * @returns Installation result
+ */
+export declare function installCharacterCountRule(options?: InstallRulesOptions): Promise<InstallRulesResult>;
+//# sourceMappingURL=install-rules.d.ts.map

package/cli/dist/utils/install-rules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"install-rules.d.ts","sourceRoot":"","sources":["../../src/utils/install-rules.ts"],"names":[],"mappings":"AAkEA,MAAM,WAAW,mBAAmB;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,mBAAmB,GAAG,WAAW,GAAG,UAAU,GAAG,SAAS,CAAC;IACvE,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,KAAK;IAGjC,IAAI,EAAE,mBAAmB,GAAG,WAAW,GAAG,UAAU,GAAG,SAAS;IAChE,aAAa,CAAC,EAAE,KAAK;gBAF5B,OAAO,EAAE,MAAM,EACR,IAAI,EAAE,mBAAmB,GAAG,WAAW,GAAG,UAAU,GAAG,SAAS,EAChE,aAAa,CAAC,EAAE,KAAK,YAAA;CAK/B;AAqID;;;;;GAKG;AACH,wBAAsB,yBAAyB,CAC7C,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,kBAAkB,CAAC,CAkL7B"}

package/cli/dist/utils/install-rules.js

@@ -0,0 +1,375 @@
+"use strict";
+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;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InstallRulesError = void 0;
+exports.installCharacterCountRule = installCharacterCountRule;
+const fs = __importStar(require("fs/promises"));
+const fsSync = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const chalk_1 = __importDefault(require("chalk"));
+/**
+ * Character count management rule content
+ * This is embedded to avoid hardcoded paths and ensure cross-platform compatibility
+ */
+const CHARACTER_COUNT_RULE_CONTENT = `---
+type: "always_apply"
+---
+
+# Character Count Management for .augment/ Directory
+
+## Target Range
+
+**Total character count of all files in \`.augment/\` directory: 48,599 - 49,299 characters**
+
+## Extension System
+
+**For content exceeding the character limit, use Augment Extensions:**
+
+This repository provides an extension module system that allows unlimited content storage outside the \`.augment/\` folder. See [AGENTS.md](../../AGENTS.md) for details on how to use extension modules.
+
+## Verification Command
+
+\`\`\`powershell
+Get-ChildItem -Path ".augment" -Recurse -File | Get-Content -Raw | Measure-Object -Character | Select-Object -ExpandProperty Characters
+\`\`\`
+
+## Character Reduction Priority (When Over Target)
+
+### 1. Condense Examples (First Priority)
+- Make examples more concise
+- Keep 1-2 examples per concept maximum
+
+### 2. Remove Examples (Second Priority)
+- Remove least critical examples
+
+### 3. Reduce Redundancy (Third Priority)
+- Remove duplicate content
+- Consolidate similar sections
+
+### 4. Streamline Content (Fourth Priority)
+- Use more concise language
+- Combine related bullet points
+
+## Content Preservation Rules
+
+### NEVER Remove
+- Core requirements and constraints
+- Critical validation rules
+
+### Always Preserve
+- Specific, actionable guidance
+- Technical accuracy and precision
+
+## Validation Process
+
+Before committing changes to \`.augment/\` files:
+1. Run character count verification command
+2. Verify total is within 48,599 - 49,299 range
+3. If outside range, apply reduction/addition priorities
+`;
+/**
+ * Error types for better error handling
+ */
+class InstallRulesError extends Error {
+    constructor(message, type, originalError) {
+        super(message);
+        this.type = type;
+        this.originalError = originalError;
+        this.name = 'InstallRulesError';
+    }
+}
+exports.InstallRulesError = InstallRulesError;
+/**
+ * Check if directory exists and is writable
+ */
+async function checkDirectoryWritable(dirPath) {
+    try {
+        await fs.access(dirPath, fsSync.constants.W_OK);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Create directory with proper error handling
+ */
+async function createDirectorySafe(dirPath, verbose = false) {
+    try {
+        await fs.mkdir(dirPath, { recursive: true });
+        if (verbose) {
+            console.log(chalk_1.default.green(`✓ Created directory: ${dirPath}`));
+        }
+    }
+    catch (error) {
+        // Check for specific error types
+        if (error.code === 'EACCES' || error.code === 'EPERM') {
+            throw new InstallRulesError(`Permission denied: Cannot create directory ${dirPath}`, 'PERMISSION_DENIED', error);
+        }
+        else if (error.code === 'ENOSPC') {
+            throw new InstallRulesError(`Disk full: Cannot create directory ${dirPath}`, 'DISK_FULL', error);
+        }
+        else {
+            throw new InstallRulesError(`Failed to create directory ${dirPath}: ${error.message}`, 'UNKNOWN', error);
+        }
+    }
+}
+/**
+ * Write file with proper error handling and rollback support
+ */
+async function writeFileSafe(filePath, content, verbose = false) {
+    const backupPath = `${filePath}.backup`;
+    let backupCreated = false;
+    try {
+        // Create backup if file exists
+        if (fsSync.existsSync(filePath)) {
+            await fs.copyFile(filePath, backupPath);
+            backupCreated = true;
+            if (verbose) {
+                console.log(chalk_1.default.gray(`Created backup: ${backupPath}`));
+            }
+        }
+        // Write the file
+        await fs.writeFile(filePath, content, 'utf-8');
+        // Remove backup on success
+        if (backupCreated) {
+            await fs.unlink(backupPath);
+        }
+        if (verbose) {
+            console.log(chalk_1.default.green(`✓ Wrote file: ${filePath}`));
+        }
+    }
+    catch (error) {
+        // Rollback on error
+        if (backupCreated) {
+            try {
+                await fs.copyFile(backupPath, filePath);
+                await fs.unlink(backupPath);
+                if (verbose) {
+                    console.log(chalk_1.default.yellow('Rolled back changes from backup'));
+                }
+            }
+            catch (rollbackError) {
+                console.error(chalk_1.default.red('Failed to rollback changes'), rollbackError);
+            }
+        }
+        // Throw appropriate error
+        if (error.code === 'EACCES' || error.code === 'EPERM') {
+            throw new InstallRulesError(`Permission denied: Cannot write to ${filePath}`, 'PERMISSION_DENIED', error);
+        }
+        else if (error.code === 'ENOSPC') {
+            throw new InstallRulesError(`Disk full: Cannot write to ${filePath}`, 'DISK_FULL', error);
+        }
+        else {
+            throw new InstallRulesError(`Failed to write file ${filePath}: ${error.message}`, 'UNKNOWN', error);
+        }
+    }
+}
+/**
+ * Prompt user for conflict resolution
+ */
+async function promptConflictResolution(existingContent, newContent, verbose) {
+    // For now, return 'skip' - in future, could use inquirer for interactive prompts
+    if (verbose) {
+        console.log(chalk_1.default.yellow('\n⚠ Conflict detected:'));
+        console.log(chalk_1.default.gray('  Existing rule has different content'));
+        console.log(chalk_1.default.gray('  Use --force to replace, or manually update the file'));
+    }
+    return 'skip';
+}
+/**
+ * Install character count management rule to .augment/rules directory
+ *
+ * @param options - Installation options
+ * @returns Installation result
+ */
+async function installCharacterCountRule(options = {}) {
+    const { targetDir = process.cwd(), skipIfExists = true, verbose = false, force = false, interactive = false } = options;
+    try {
+        // Ensure paths use platform-appropriate separators (cross-platform)
+        const augmentDir = path.join(targetDir, '.augment');
+        const rulesDir = path.join(augmentDir, 'rules');
+        const rulePath = path.join(rulesDir, 'character-count-management.md');
+        // Check if rule already exists
+        const ruleExists = fsSync.existsSync(rulePath);
+        if (ruleExists) {
+            // Read existing content
+            const existingContent = await fs.readFile(rulePath, 'utf-8');
+            // Check if content is identical
+            if (existingContent.trim() === CHARACTER_COUNT_RULE_CONTENT.trim()) {
+                if (verbose) {
+                    console.log(chalk_1.default.gray('ℹ Character count rule is up to date'));
+                }
+                return {
+                    success: true,
+                    created: false,
+                    skipped: true,
+                    path: rulePath
+                };
+            }
+            // Content is different - handle conflict
+            if (force) {
+                // Force replace
+                if (verbose) {
+                    console.log(chalk_1.default.yellow('⚠ Replacing existing rule (--force)'));
+                }
+            }
+            else if (skipIfExists) {
+                // Skip if exists
+                if (verbose) {
+                    console.log(chalk_1.default.gray('ℹ Character count rule already exists, skipping...'));
+                }
+                return {
+                    success: true,
+                    created: false,
+                    skipped: true,
+                    path: rulePath
+                };
+            }
+            else if (interactive) {
+                // Prompt user for resolution
+                const resolution = await promptConflictResolution(existingContent, CHARACTER_COUNT_RULE_CONTENT, verbose);
+                if (resolution === 'skip') {
+                    return {
+                        success: true,
+                        created: false,
+                        skipped: true,
+                        path: rulePath
+                    };
+                }
+                else if (resolution === 'keep') {
+                    return {
+                        success: true,
+                        created: false,
+                        skipped: true,
+                        path: rulePath
+                    };
+                }
+                // 'replace' falls through to write
+            }
+            else {
+                // Default: skip with warning
+                if (verbose) {
+                    console.log(chalk_1.default.yellow('⚠ Character count rule exists with different content, skipping...'));
+                    console.log(chalk_1.default.gray('  Use --force to replace'));
+                }
+                return {
+                    success: true,
+                    created: false,
+                    skipped: true,
+                    path: rulePath
+                };
+            }
+        }
+        // Create .augment directory if it doesn't exist
+        if (!fsSync.existsSync(augmentDir)) {
+            await createDirectorySafe(augmentDir, verbose);
+        }
+        else {
+            // Check if directory is writable
+            const isWritable = await checkDirectoryWritable(augmentDir);
+            if (!isWritable) {
+                throw new InstallRulesError(`Permission denied: .augment directory is not writable`, 'PERMISSION_DENIED');
+            }
+        }
+        // Create rules directory if it doesn't exist
+        if (!fsSync.existsSync(rulesDir)) {
+            await createDirectorySafe(rulesDir, verbose);
+        }
+        else {
+            // Check if directory is writable
+            const isWritable = await checkDirectoryWritable(rulesDir);
+            if (!isWritable) {
+                throw new InstallRulesError(`Permission denied: .augment/rules directory is not writable`, 'PERMISSION_DENIED');
+            }
+        }
+        // Write the rule file with rollback support
+        await writeFileSafe(rulePath, CHARACTER_COUNT_RULE_CONTENT, verbose);
+        if (verbose) {
+            console.log(chalk_1.default.green('✓ Installed character count management rule'));
+        }
+        return {
+            success: true,
+            created: !ruleExists,
+            updated: ruleExists,
+            skipped: false,
+            path: rulePath
+        };
+    }
+    catch (error) {
+        // Handle InstallRulesError with specific error types
+        if (error instanceof InstallRulesError) {
+            if (verbose) {
+                console.error(chalk_1.default.red('✗ Failed to install character count rule:'));
+                console.error(chalk_1.default.red(`  ${error.message}`));
+                // Provide helpful suggestions based on error type
+                if (error.type === 'PERMISSION_DENIED') {
+                    console.error(chalk_1.default.yellow('\n  Suggestions:'));
+                    console.error(chalk_1.default.yellow('  - Check file/directory permissions'));
+                    console.error(chalk_1.default.yellow('  - Run with appropriate privileges (sudo on Unix)'));
+                    console.error(chalk_1.default.yellow('  - Ensure .augment directory is not read-only'));
+                }
+                else if (error.type === 'DISK_FULL') {
+                    console.error(chalk_1.default.yellow('\n  Suggestions:'));
+                    console.error(chalk_1.default.yellow('  - Free up disk space'));
+                    console.error(chalk_1.default.yellow('  - Check disk quota'));
+                }
+            }
+            return {
+                success: false,
+                created: false,
+                skipped: false,
+                error: error.message,
+                errorType: error.type
+            };
+        }
+        // Handle generic errors
+        const errorMessage = error instanceof Error ? error.message : String(error);
+        if (verbose) {
+            console.error(chalk_1.default.red('✗ Failed to install character count rule:'), errorMessage);
+        }
+        return {
+            success: false,
+            created: false,
+            skipped: false,
+            error: errorMessage,
+            errorType: 'UNKNOWN'
+        };
+    }
+}
+//# sourceMappingURL=install-rules.js.map