specweave 1.0.31 → 1.0.33

package/dist/src/core/living-docs/scaffolding/merger.d.ts

@@ -0,0 +1,183 @@
+/**
+ * Living Docs Merger - Intelligently merges existing documentation
+ *
+ * This module scans for existing documentation in a user project and
+ * offers to merge/import it into the living docs structure.
+ *
+ * Smart features:
+ * - Detects documentation type (README, API docs, guides, etc.)
+ * - Suggests appropriate target folders
+ * - Detects similar/duplicate content
+ * - Preserves original files (copies, doesn't move)
+ *
+ * @module core/living-docs/scaffolding/merger
+ */
+import { Logger } from '../../../utils/logger.js';
+/**
+ * Detected documentation file
+ */
+export interface DetectedDoc {
+    /** Original file path (relative to project root) */
+    sourcePath: string;
+    /** Absolute path */
+    absolutePath: string;
+    /** File name */
+    fileName: string;
+    /** Detected document type */
+    type: DocType;
+    /** Confidence score (0-1) */
+    confidence: number;
+    /** Suggested target folder in living docs */
+    suggestedTarget: string;
+    /** File size in bytes */
+    size: number;
+    /** First 500 chars of content (for preview) */
+    preview: string;
+    /** Detected keywords/themes */
+    themes: string[];
+}
+/**
+ * Document types
+ */
+export type DocType = 'readme' | 'api' | 'guide' | 'architecture' | 'adr' | 'runbook' | 'contributing' | 'changelog' | 'spec' | 'other';
+/**
+ * Merge options
+ */
+export interface MergeOptions {
+    /** Project root path */
+    projectPath: string;
+    /** Additional folders to scan (besides common locations) */
+    additionalFolders?: string[];
+    /** Whether to scan recursively */
+    recursive?: boolean;
+    /** Maximum depth for recursive scan */
+    maxDepth?: number;
+    /** Minimum confidence to include in results */
+    minConfidence?: number;
+    /** Logger instance */
+    logger?: Logger;
+}
+/**
+ * Merge result
+ */
+export interface MergeResult {
+    /** Detected documentation files */
+    detected: DetectedDoc[];
+    /** Files that were merged */
+    merged: string[];
+    /** Files that were skipped */
+    skipped: string[];
+    /** Any errors */
+    errors: string[];
+    /** Suggested merges (grouped by target folder) */
+    suggestions: Map<string, DetectedDoc[]>;
+}
+/**
+ * Similarity result
+ */
+export interface SimilarityResult {
+    /** Whether files are similar */
+    isSimilar: boolean;
+    /** Similarity score (0-1) */
+    score: number;
+    /** Reason for similarity */
+    reason?: string;
+}
+/**
+ * Living Docs Merger class
+ */
+export declare class LivingDocsMerger {
+    private projectPath;
+    private logger;
+    private recursive;
+    private maxDepth;
+    private minConfidence;
+    private additionalFolders;
+    constructor(options: MergeOptions);
+    /**
+     * Scan for existing documentation
+     */
+    scan(): Promise<DetectedDoc[]>;
+    /**
+     * Scan a directory for markdown files
+     */
+    private scanDirectory;
+    /**
+     * Check if directory should be skipped
+     */
+    private shouldSkipDir;
+    /**
+     * Check if file is a documentation file
+     */
+    private isDocFile;
+    /**
+     * Analyze a documentation file
+     */
+    private analyzeFile;
+    /**
+     * Detect document type from filename and content
+     */
+    private detectType;
+    /**
+     * Extract themes/keywords from content
+     */
+    private extractThemes;
+    /**
+     * Check similarity between two files using TF-IDF weighted cosine similarity
+     *
+     * TF-IDF (Term Frequency-Inverse Document Frequency) weights terms by:
+     * - How often they appear in a document (TF - more = more important)
+     * - How rare they are across all documents (IDF - rarer = more distinctive)
+     */
+    checkSimilarity(doc1: DetectedDoc, doc2: DetectedDoc): SimilarityResult;
+    /**
+     * Compute TF-IDF weighted cosine similarity between two texts
+     *
+     * This is a simplified but effective TF-IDF implementation:
+     * - TF: term frequency in document (normalized)
+     * - IDF: inverse document frequency (approximated using both documents as corpus)
+     */
+    private computeTfIdfSimilarity;
+    /**
+     * Tokenize text into meaningful terms
+     * Filters out common stop words and short tokens
+     */
+    private tokenize;
+    /**
+     * Compute normalized term frequency
+     */
+    private computeTermFrequency;
+    /**
+     * Compute cosine similarity between two TF-IDF vectors
+     */
+    private cosineSimilarity;
+    /**
+     * Compute filename similarity using normalized Levenshtein distance
+     */
+    private computeFilenameSimilarity;
+    /**
+     * Compute Levenshtein edit distance between two strings
+     */
+    private levenshteinDistance;
+    /**
+     * Generate merge suggestions grouped by target folder
+     */
+    generateSuggestions(detected: DetectedDoc[]): Map<string, DetectedDoc[]>;
+    /**
+     * Merge a detected document into living docs
+     */
+    mergeDoc(doc: DetectedDoc, targetFolder?: string): Promise<{
+        success: boolean;
+        targetPath: string;
+        error?: string;
+    }>;
+}
+/**
+ * Scan for existing documentation (convenience function)
+ */
+export declare function scanExistingDocs(options: MergeOptions): Promise<DetectedDoc[]>;
+/**
+ * Find similar documentation folders
+ */
+export declare function findSimilarFolders(projectPath: string, existingDocs: DetectedDoc[]): Map<string, string[]>;
+//# sourceMappingURL=merger.d.ts.map

package/dist/src/core/living-docs/scaffolding/merger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"merger.d.ts","sourceRoot":"","sources":["../../../../../src/core/living-docs/scaffolding/merger.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAIH,OAAO,EAAE,MAAM,EAAiB,MAAM,0BAA0B,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,oDAAoD;IACpD,UAAU,EAAE,MAAM,CAAC;IAEnB,oBAAoB;IACpB,YAAY,EAAE,MAAM,CAAC;IAErB,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IAEjB,6BAA6B;IAC7B,IAAI,EAAE,OAAO,CAAC;IAEd,6BAA6B;IAC7B,UAAU,EAAE,MAAM,CAAC;IAEnB,6CAA6C;IAC7C,eAAe,EAAE,MAAM,CAAC;IAExB,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;IAEb,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC;IAEhB,+BAA+B;IAC/B,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,OAAO,GACf,QAAQ,GACR,KAAK,GACL,OAAO,GACP,cAAc,GACd,KAAK,GACL,SAAS,GACT,cAAc,GACd,WAAW,GACX,MAAM,GACN,OAAO,CAAC;AAEZ;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,wBAAwB;IACxB,WAAW,EAAE,MAAM,CAAC;IAEpB,4DAA4D;IAC5D,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE7B,kCAAkC;IAClC,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,+CAA+C;IAC/C,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,sBAAsB;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,mCAAmC;IACnC,QAAQ,EAAE,WAAW,EAAE,CAAC;IAExB,6BAA6B;IAC7B,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB,8BAA8B;IAC9B,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB,iBAAiB;IACjB,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB,kDAAkD;IAClD,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,gCAAgC;IAChC,SAAS,EAAE,OAAO,CAAC;IAEnB,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAC;IAEd,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAiDD;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,SAAS,CAAU;IAC3B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,iBAAiB,CAAW;gBAExB,OAAO,EAAE,YAAY;IASjC;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAoCpC;;OAEG;YACW,aAAa;IAgC3B;;OAEG;IACH,OAAO,CAAC,aAAa;IAgBrB;;OAEG;IACH,OAAO,CAAC,SAAS;IAIjB;;OAEG;IACH,OAAO,CAAC,WAAW;IAiCnB;;OAEG;IACH,OAAO,CAAC,UAAU;IAuClB;;OAEG;IACH,OAAO,CAAC,aAAa;IA0BrB;;;;;;OAMG;IACH,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,GAAG,gBAAgB;IAwCvE;;;;;;OAMG;IACH,OAAO,CAAC,sBAAsB;IAoC9B;;;OAGG;IACH,OAAO,CAAC,QAAQ;IAqBhB;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAa5B;;OAEG;IACH,OAAO,CAAC,gBAAgB;IA4BxB;;OAEG;IACH,OAAO,CAAC,yBAAyB;IAajC;;OAEG;IACH,OAAO,CAAC,mBAAmB;IA6B3B;;OAEG;IACH,mBAAmB,CAAC,QAAQ,EAAE,WAAW,EAAE,GAAG,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC;IAcxE;;OAEG;IACG,QAAQ,CACZ,GAAG,EAAE,WAAW,EAChB,YAAY,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAkCrE;AAED;;GAEG;AACH,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAGpF;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,WAAW,EAAE,GAC1B,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAkCvB"}