@mytechtoday/augment-extensions 1.2.2 → 1.3.0

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

@@ -0,0 +1,203 @@
+"use strict";
+/**
+ * ADR Validation Module
+ * Implements validation logic for Architecture Decision Records (ADRs)
+ * Based on augment-extensions/workflows/adr-support/rules/validation-rules.md
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidISO8601 = isValidISO8601;
+exports.validateMetadata = validateMetadata;
+exports.validateOptionalFields = validateOptionalFields;
+exports.validateFileName = validateFileName;
+exports.validateADRReferences = validateADRReferences;
+exports.validateContentQuality = validateContentQuality;
+exports.validateContext = validateContext;
+exports.validateADR = validateADR;
+/**
+ * Validates ISO 8601 date format (YYYY-MM-DD)
+ */
+function isValidISO8601(date) {
+    const iso8601Pattern = /^\d{4}-\d{2}-\d{2}$/;
+    if (!iso8601Pattern.test(date)) {
+        return false;
+    }
+    const parsedDate = new Date(date);
+    return parsedDate instanceof Date && !isNaN(parsedDate.getTime());
+}
+/**
+ * Validates required metadata fields
+ * Level 1: Structural Validation (Required)
+ */
+function validateMetadata(adr) {
+    const errors = [];
+    // ID validation
+    if (!adr.id) {
+        errors.push("Missing required field: id");
+    }
+    else if (!/^adr-\d{4}$/.test(adr.id)) {
+        errors.push("Invalid ID format. Must be adr-NNNN (e.g., adr-0001)");
+    }
+    // Title validation
+    if (!adr.title) {
+        errors.push("Missing required field: title");
+    }
+    else if (adr.title.length < 10 || adr.title.length > 100) {
+        errors.push("Title must be 10-100 characters");
+    }
+    // Status validation
+    const validStatuses = ['draft', 'proposed', 'approved', 'implemented', 'maintained', 'superseded', 'sunset'];
+    if (!adr.status) {
+        errors.push("Missing required field: status");
+    }
+    else if (!validStatuses.includes(adr.status)) {
+        errors.push(`Invalid status. Must be one of: ${validStatuses.join(', ')}`);
+    }
+    // Date validation
+    if (!adr.date) {
+        errors.push("Missing required field: date");
+    }
+    else if (!isValidISO8601(adr.date)) {
+        errors.push("Invalid date format. Must be ISO 8601 (YYYY-MM-DD)");
+    }
+    // Deciders validation
+    if (!adr.deciders || adr.deciders.length === 0) {
+        errors.push("At least one decider must be specified");
+    }
+    return { valid: errors.length === 0, errors };
+}
+/**
+ * Validates optional metadata fields
+ * Level 2: Content Validation (Warning)
+ */
+function validateOptionalFields(adr) {
+    const warnings = [];
+    // Tags validation
+    if (adr.tags && !Array.isArray(adr.tags)) {
+        warnings.push("Tags must be an array");
+    }
+    // Supersedes validation
+    if (adr.supersedes) {
+        if (!Array.isArray(adr.supersedes)) {
+            warnings.push("Supersedes must be an array");
+        }
+        else {
+            adr.supersedes.forEach(id => {
+                if (!/^adr-\d{4}$/.test(id)) {
+                    warnings.push(`Invalid ADR ID in supersedes: ${id}`);
+                }
+            });
+        }
+    }
+    // Superseded_by validation
+    if (adr.superseded_by && !/^adr-\d{4}$/.test(adr.superseded_by)) {
+        warnings.push(`Invalid ADR ID in superseded_by: ${adr.superseded_by}`);
+    }
+    return { valid: warnings.length === 0, warnings };
+}
+/**
+ * Validates file naming convention
+ * Format: adr/NNNN-brief-title.md
+ */
+function validateFileName(filePath) {
+    const errors = [];
+    const pattern = /^adr\/\d{4}-[a-z0-9-]+\.md$/;
+    if (!pattern.test(filePath)) {
+        errors.push("Invalid file name. Must be adr/NNNN-brief-title.md");
+    }
+    return { valid: errors.length === 0, errors };
+}
+/**
+ * Validates ADR references
+ * Level 3: Reference Validation (Warning)
+ */
+function validateADRReferences(adr, allADRs) {
+    const warnings = [];
+    const adrIds = new Set(allADRs.map(a => a.id));
+    // Validate supersedes references
+    if (adr.supersedes) {
+        adr.supersedes.forEach(id => {
+            if (!adrIds.has(id)) {
+                warnings.push(`Referenced ADR does not exist: ${id}`);
+            }
+        });
+    }
+    // Validate superseded_by reference
+    if (adr.superseded_by && !adrIds.has(adr.superseded_by)) {
+        warnings.push(`Referenced ADR does not exist: ${adr.superseded_by}`);
+    }
+    // Validate related_decisions
+    if (adr.related_decisions) {
+        adr.related_decisions.forEach(id => {
+            if (!adrIds.has(id)) {
+                warnings.push(`Related ADR does not exist: ${id}`);
+            }
+        });
+    }
+    return { valid: warnings.length === 0, warnings };
+}
+/**
+ * Validates content quality
+ * Checks for placeholder text and minimum content length
+ */
+function validateContentQuality(content) {
+    const warnings = [];
+    // Check for placeholder text
+    const placeholders = ['TODO', 'TBD', 'FIXME', 'XXX', '[Insert', 'Lorem ipsum'];
+    placeholders.forEach(placeholder => {
+        if (content.includes(placeholder)) {
+            warnings.push(`Contains placeholder text: ${placeholder}`);
+        }
+    });
+    return { valid: warnings.length === 0, warnings };
+}
+/**
+ * Validates context section content
+ * Ensures context explains "why" not "how"
+ */
+function validateContext(context) {
+    const warnings = [];
+    // Should contain problem statement
+    const problemIndicators = ['problem', 'issue', 'challenge', 'need', 'requirement'];
+    const hasProblem = problemIndicators.some(word => context.toLowerCase().includes(word));
+    if (!hasProblem) {
+        warnings.push("Context should clearly state the problem or need");
+    }
+    // Should not be too implementation-focused
+    const implDetails = ['function', 'class', 'variable', 'line', 'file'];
+    const tooDetailed = implDetails.filter(word => context.toLowerCase().includes(word)).length > 2;
+    if (tooDetailed) {
+        warnings.push("Context contains too many implementation details. Focus on 'why' not 'how'");
+    }
+    return { valid: warnings.length === 0, warnings };
+}
+/**
+ * Comprehensive ADR validation
+ * Runs all validation checks and aggregates results
+ */
+function validateADR(adr, allADRs = []) {
+    const errors = [];
+    const warnings = [];
+    // Level 1: Structural validation (required)
+    const metadataResult = validateMetadata(adr);
+    if (metadataResult.errors) {
+        errors.push(...metadataResult.errors);
+    }
+    // Level 2: Content validation (warnings)
+    const optionalResult = validateOptionalFields(adr);
+    if (optionalResult.warnings) {
+        warnings.push(...optionalResult.warnings);
+    }
+    // Level 3: Reference validation (warnings)
+    if (allADRs.length > 0) {
+        const refResult = validateADRReferences(adr, allADRs);
+        if (refResult.warnings) {
+            warnings.push(...refResult.warnings);
+        }
+    }
+    return {
+        valid: errors.length === 0,
+        errors: errors.length > 0 ? errors : undefined,
+        warnings: warnings.length > 0 ? warnings : undefined
+    };
+}
+//# sourceMappingURL=adr-validator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"adr-validator.js","sourceRoot":"","sources":["../../src/utils/adr-validator.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;AA2BH,wCAQC;AAMD,4CAsCC;AAMD,wDA2BC;AAMD,4CASC;AAMD,sDA4BC;AAMD,wDAYC;AAMD,0CAwBC;AAMD,kCA6BC;AA5ND;;GAEG;AACH,SAAgB,cAAc,CAAC,IAAY;IACzC,MAAM,cAAc,GAAG,qBAAqB,CAAC;IAC7C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,OAAO,UAAU,YAAY,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;AACpE,CAAC;AAED;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,GAAQ;IACvC,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,gBAAgB;IAChB,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACZ,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IAC5C,CAAC;SAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;QACvC,MAAM,CAAC,IAAI,CAAC,sDAAsD,CAAC,CAAC;IACtE,CAAC;IAED,mBAAmB;IACnB,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;IAC/C,CAAC;SAAM,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,EAAE,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;QAC3D,MAAM,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;IACjD,CAAC;IAED,oBAAoB;IACpB,MAAM,aAAa,GAAG,CAAC,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,YAAY,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;IAC7G,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;QAChB,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;IAChD,CAAC;SAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;QAC/C,MAAM,CAAC,IAAI,CAAC,mCAAmC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED,kBAAkB;IAClB,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QACd,MAAM,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;IAC9C,CAAC;SAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,MAAM,CAAC,IAAI,CAAC,oDAAoD,CAAC,CAAC;IACpE,CAAC;IAED,sBAAsB;IACtB,IAAI,CAAC,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/C,MAAM,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;AAChD,CAAC;AAED;;;GAGG;AACH,SAAgB,sBAAsB,CAAC,GAAQ;IAC7C,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,kBAAkB;IAClB,IAAI,GAAG,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QACzC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;IACzC,CAAC;IAED,wBAAwB;IACxB,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;QACnB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YACnC,QAAQ,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;QAC/C,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;gBAC1B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;oBAC5B,QAAQ,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,CAAC,CAAC;gBACvD,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,2BAA2B;IAC3B,IAAI,GAAG,CAAC,aAAa,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC;QAChE,QAAQ,CAAC,IAAI,CAAC,oCAAoC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC;AACpD,CAAC;AAED;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,QAAgB;IAC/C,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,OAAO,GAAG,6BAA6B,CAAC;IAE9C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5B,MAAM,CAAC,IAAI,CAAC,oDAAoD,CAAC,CAAC;IACpE,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;AAChD,CAAC;AAED;;;GAGG;AACH,SAAgB,qBAAqB,CAAC,GAAQ,EAAE,OAAc;IAC5D,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAE/C,iCAAiC;IACjC,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;QACnB,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;YAC1B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;gBACpB,QAAQ,CAAC,IAAI,CAAC,kCAAkC,EAAE,EAAE,CAAC,CAAC;YACxD,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,mCAAmC;IACnC,IAAI,GAAG,CAAC,aAAa,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC;QACxD,QAAQ,CAAC,IAAI,CAAC,kCAAkC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;IACvE,CAAC;IAED,6BAA6B;IAC7B,IAAI,GAAG,CAAC,iBAAiB,EAAE,CAAC;QAC1B,GAAG,CAAC,iBAAiB,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;YACjC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;gBACpB,QAAQ,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,CAAC,CAAC;YACrD,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC;AACpD,CAAC;AAED;;;GAGG;AACH,SAAgB,sBAAsB,CAAC,OAAe;IACpD,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,6BAA6B;IAC7B,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;IAC/E,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;QACjC,IAAI,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YAClC,QAAQ,CAAC,IAAI,CAAC,8BAA8B,WAAW,EAAE,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC;AACpD,CAAC;AAED;;;GAGG;AACH,SAAgB,eAAe,CAAC,OAAe;IAC7C,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,mCAAmC;IACnC,MAAM,iBAAiB,GAAG,CAAC,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;IACnF,MAAM,UAAU,GAAG,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC/C,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CACrC,CAAC;IAEF,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,QAAQ,CAAC,IAAI,CAAC,kDAAkD,CAAC,CAAC;IACpE,CAAC;IAED,2CAA2C;IAC3C,MAAM,WAAW,GAAG,CAAC,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACtE,MAAM,WAAW,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAC5C,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CACrC,CAAC,MAAM,GAAG,CAAC,CAAC;IAEb,IAAI,WAAW,EAAE,CAAC;QAChB,QAAQ,CAAC,IAAI,CAAC,4EAA4E,CAAC,CAAC;IAC9F,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC;AACpD,CAAC;AAED;;;GAGG;AACH,SAAgB,WAAW,CAAC,GAAQ,EAAE,UAAiB,EAAE;IACvD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,4CAA4C;IAC5C,MAAM,cAAc,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAC7C,IAAI,cAAc,CAAC,MAAM,EAAE,CAAC;QAC1B,MAAM,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAED,yCAAyC;IACzC,MAAM,cAAc,GAAG,sBAAsB,CAAC,GAAG,CAAC,CAAC;IACnD,IAAI,cAAc,CAAC,QAAQ,EAAE,CAAC;QAC5B,QAAQ,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAED,2CAA2C;IAC3C,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,SAAS,GAAG,qBAAqB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACtD,IAAI,SAAS,CAAC,QAAQ,EAAE,CAAC;YACvB,QAAQ,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAED,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;QAC1B,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;QAC9C,QAAQ,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;KACrD,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mytechtoday/augment-extensions",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "CLI tool for managing Augment Code AI extension modules",
   "main": "cli/dist/index.js",
   "bin": {