agents-reverse-engineer 0.2.12 → 0.3.1

package/dist/generation/writers/supplementary.d.ts

@@ -9,6 +9,16 @@ export interface SupplementaryConfig {
     generateArchitecture: boolean;
     /** Whether to generate STACK.md */
     generateStack: boolean;
+    /** Whether to generate STRUCTURE.md */
+    generateStructure: boolean;
+    /** Whether to generate CONVENTIONS.md */
+    generateConventions: boolean;
+    /** Whether to generate TESTING.md */
+    generateTesting: boolean;
+    /** Whether to generate INTEGRATIONS.md */
+    generateIntegrations: boolean;
+    /** Whether to generate CONCERNS.md */
+    generateConcerns: boolean;
 }
 /**
  * Information about the technology stack.
@@ -33,21 +43,167 @@ export interface StackInfo {
  * This generates a template that the host LLM will expand with actual
  * architectural analysis.
  */
-export declare function buildArchitectureMd(metrics: ComplexityMetrics, projectName: string): string;
+export declare function buildArchitectureMd(metrics: ComplexityMetrics, projectName: string, hasLocalFile?: boolean): string;
 /**
  * Build STACK.md content from package.json analysis.
  */
-export declare function buildStackMd(stackInfo: StackInfo, projectName: string): string;
+export declare function buildStackMd(stackInfo: StackInfo, projectName: string, hasLocalFile?: boolean): string;
 /**
  * Parse package.json to extract stack information.
  */
 export declare function analyzePackageJson(packageJsonPath: string): Promise<StackInfo | null>;
+/**
+ * Parse go.mod to extract stack information.
+ */
+export declare function analyzeGoMod(goModPath: string): Promise<StackInfo | null>;
+/**
+ * Parse Cargo.toml to extract stack information for Rust projects.
+ */
+export declare function analyzeCargoToml(cargoTomlPath: string): Promise<StackInfo | null>;
 /**
  * Write ARCHITECTURE.md to the configured location.
+ *
+ * If a user-defined ARCHITECTURE.md exists (not generated by us), it will be
+ * preserved as ARCHITECTURE.local.md and referenced in the generated file.
  */
 export declare function writeArchitectureMd(projectRoot: string, metrics: ComplexityMetrics, config: SupplementaryConfig): Promise<string | null>;
 /**
  * Write STACK.md to the configured location.
+ *
+ * If a user-defined STACK.md exists (not generated by us), it will be
+ * preserved as STACK.local.md and referenced in the generated file.
  */
 export declare function writeStackMd(projectRoot: string, config: SupplementaryConfig): Promise<string | null>;
+/**
+ * Information about codebase structure.
+ */
+export interface StructureInfo {
+    /** Top-level directories with descriptions */
+    directories: Array<{
+        name: string;
+        description: string;
+        fileCount: number;
+    }>;
+    /** Key entry points */
+    entryPoints: string[];
+    /** Notable patterns in organization */
+    organizationPatterns: string[];
+}
+/**
+ * Information about coding conventions.
+ */
+export interface ConventionsInfo {
+    /** Naming conventions detected */
+    namingConventions: string[];
+    /** File organization patterns */
+    filePatterns: string[];
+    /** Code style indicators */
+    codeStyle: string[];
+    /** Import/export patterns */
+    importPatterns: string[];
+}
+/**
+ * Information about testing setup.
+ */
+export interface TestingInfo {
+    /** Testing framework(s) used */
+    frameworks: string[];
+    /** Test file patterns */
+    testPatterns: string[];
+    /** Test directories */
+    testDirs: string[];
+    /** Coverage tool if any */
+    coverageTool?: string;
+    /** Estimated test file count */
+    testFileCount: number;
+}
+/**
+ * Information about external integrations.
+ */
+export interface IntegrationsInfo {
+    /** External APIs/services */
+    apis: Array<{
+        name: string;
+        type: string;
+    }>;
+    /** Database connections */
+    databases: string[];
+    /** Third-party services */
+    services: string[];
+    /** Environment variables referenced */
+    envVars: string[];
+}
+/**
+ * Information about technical concerns.
+ */
+export interface ConcernsInfo {
+    /** TODO/FIXME comments found */
+    todoCount: number;
+    /** Files with high complexity */
+    complexFiles: string[];
+    /** Deprecated patterns detected */
+    deprecatedPatterns: string[];
+    /** Missing documentation areas */
+    missingDocs: string[];
+}
+/**
+ * Analyze codebase structure from directories and files.
+ */
+export declare function analyzeStructure(projectRoot: string, metrics: ComplexityMetrics): Promise<StructureInfo>;
+/**
+ * Analyze coding conventions from package.json and common patterns.
+ */
+export declare function analyzeConventions(projectRoot: string): Promise<ConventionsInfo>;
+/**
+ * Analyze testing setup from package.json and directory structure.
+ */
+export declare function analyzeTestingSetup(projectRoot: string, metrics: ComplexityMetrics): Promise<TestingInfo>;
+/**
+ * Analyze external integrations from package.json.
+ */
+export declare function analyzeIntegrations(projectRoot: string): Promise<IntegrationsInfo>;
+/**
+ * Analyze potential technical concerns.
+ */
+export declare function analyzeConcerns(projectRoot: string, metrics: ComplexityMetrics): Promise<ConcernsInfo>;
+/**
+ * Build STRUCTURE.md content.
+ */
+export declare function buildStructureMd(info: StructureInfo, projectName: string, hasLocalFile?: boolean): string;
+/**
+ * Build CONVENTIONS.md content.
+ */
+export declare function buildConventionsMd(info: ConventionsInfo, projectName: string, hasLocalFile?: boolean): string;
+/**
+ * Build TESTING.md content.
+ */
+export declare function buildTestingMd(info: TestingInfo, projectName: string, hasLocalFile?: boolean): string;
+/**
+ * Build INTEGRATIONS.md content.
+ */
+export declare function buildIntegrationsMd(info: IntegrationsInfo, projectName: string, hasLocalFile?: boolean): string;
+/**
+ * Build CONCERNS.md content.
+ */
+export declare function buildConcernsMd(info: ConcernsInfo, projectName: string, hasLocalFile?: boolean): string;
+/**
+ * Write STRUCTURE.md to the configured location.
+ */
+export declare function writeStructureMd(projectRoot: string, metrics: ComplexityMetrics, config: SupplementaryConfig): Promise<string | null>;
+/**
+ * Write CONVENTIONS.md to the configured location.
+ */
+export declare function writeConventionsMd(projectRoot: string, config: SupplementaryConfig): Promise<string | null>;
+/**
+ * Write TESTING.md to the configured location.
+ */
+export declare function writeTestingMd(projectRoot: string, metrics: ComplexityMetrics, config: SupplementaryConfig): Promise<string | null>;
+/**
+ * Write INTEGRATIONS.md to the configured location.
+ */
+export declare function writeIntegrationsMd(projectRoot: string, config: SupplementaryConfig): Promise<string | null>;
+/**
+ * Write CONCERNS.md to the configured location.
+ */
+export declare function writeConcernsMd(projectRoot: string, metrics: ComplexityMetrics, config: SupplementaryConfig): Promise<string | null>;
 //# sourceMappingURL=supplementary.d.ts.map

package/dist/generation/writers/supplementary.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"supplementary.d.ts","sourceRoot":"","sources":["../../../src/generation/writers/supplementary.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0CAA0C;IAC1C,oBAAoB,EAAE,OAAO,CAAC;IAC9B,mCAAmC;IACnC,aAAa,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,0BAA0B;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,wBAAwB;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2CAA2C;IAC3C,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC,CAAC;IACzF,wBAAwB;IACxB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,iBAAiB,EAC1B,WAAW,EAAE,MAAM,GAClB,MAAM,CAsCR;AA4BD;;GAEG;AACH,wBAAgB,YAAY,CAC1B,SAAS,EAAE,SAAS,EACpB,WAAW,EAAE,MAAM,GAClB,MAAM,CAoCR;AAED;;GAEG;AACH,wBAAsB,kBAAkB,CACtC,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CA+D3B;AAED;;GAEG;AACH,wBAAsB,mBAAmB,CACvC,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,iBAAiB,EAC1B,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAexB;AAED;;GAEG;AACH,wBAAsB,YAAY,CAChC,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAoBxB"}
+{"version":3,"file":"supplementary.d.ts","sourceRoot":"","sources":["../../../src/generation/writers/supplementary.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAK1D;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0CAA0C;IAC1C,oBAAoB,EAAE,OAAO,CAAC;IAC9B,mCAAmC;IACnC,aAAa,EAAE,OAAO,CAAC;IACvB,uCAAuC;IACvC,iBAAiB,EAAE,OAAO,CAAC;IAC3B,yCAAyC;IACzC,mBAAmB,EAAE,OAAO,CAAC;IAC7B,qCAAqC;IACrC,eAAe,EAAE,OAAO,CAAC;IACzB,0CAA0C;IAC1C,oBAAoB,EAAE,OAAO,CAAC;IAC9B,sCAAsC;IACtC,gBAAgB,EAAE,OAAO,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,0BAA0B;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,wBAAwB;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2CAA2C;IAC3C,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC,CAAC;IACzF,wBAAwB;IACxB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AA+CD;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,iBAAiB,EAC1B,WAAW,EAAE,MAAM,EACnB,YAAY,GAAE,OAAe,GAC5B,MAAM,CAgDR;AA4BD;;GAEG;AACH,wBAAgB,YAAY,CAC1B,SAAS,EAAE,SAAS,EACpB,WAAW,EAAE,MAAM,EACnB,YAAY,GAAE,OAAe,GAC5B,MAAM,CA8CR;AAED;;GAEG;AACH,wBAAsB,kBAAkB,CACtC,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CA+D3B;AAED;;GAEG;AACH,wBAAsB,YAAY,CAChC,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CA+F3B;AAwBD;;GAEG;AACH,wBAAsB,gBAAgB,CACpC,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CAiE3B;AAwED;;;;;GAKG;AACH,wBAAsB,mBAAmB,CACvC,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,iBAAiB,EAC1B,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAoBxB;AAED;;;;;GAKG;AACH,wBAAsB,YAAY,CAChC,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAsCxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,8CAA8C;IAC9C,WAAW,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC7E,uBAAuB;IACvB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,uCAAuC;IACvC,oBAAoB,EAAE,MAAM,EAAE,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,kCAAkC;IAClC,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,iCAAiC;IACjC,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,4BAA4B;IAC5B,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,6BAA6B;IAC7B,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,gCAAgC;IAChC,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,yBAAyB;IACzB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,uBAAuB;IACvB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,2BAA2B;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gCAAgC;IAChC,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,6BAA6B;IAC7B,IAAI,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC5C,2BAA2B;IAC3B,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,2BAA2B;IAC3B,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,uCAAuC;IACvC,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,iCAAiC;IACjC,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,mCAAmC;IACnC,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,kCAAkC;IAClC,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAED;;GAEG;AACH,wBAAsB,gBAAgB,CACpC,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,aAAa,CAAC,CAqExB;AAeD;;GAEG;AACH,wBAAsB,kBAAkB,CACtC,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,eAAe,CAAC,CAsD1B;AAED;;GAEG;AACH,wBAAsB,mBAAmB,CACvC,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,WAAW,CAAC,CAwDtB;AAED;;GAEG;AACH,wBAAsB,mBAAmB,CACvC,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,gBAAgB,CAAC,CAgF3B;AAED;;GAEG;AACH,wBAAsB,eAAe,CACnC,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,YAAY,CAAC,CAsBvB;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,aAAa,EACnB,WAAW,EAAE,MAAM,EACnB,YAAY,GAAE,OAAe,GAC5B,MAAM,CAyCR;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,eAAe,EACrB,WAAW,EAAE,MAAM,EACnB,YAAY,GAAE,OAAe,GAC5B,MAAM,CAkDR;AAED;;GAEG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE,WAAW,EACjB,WAAW,EAAE,MAAM,EACnB,YAAY,GAAE,OAAe,GAC5B,MAAM,CA2DR;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,gBAAgB,EACtB,WAAW,EAAE,MAAM,EACnB,YAAY,GAAE,OAAe,GAC5B,MAAM,CAoDR;AAED;;GAEG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,YAAY,EAClB,WAAW,EAAE,MAAM,EACnB,YAAY,GAAE,OAAe,GAC5B,MAAM,CAwCR;AAED;;GAEG;AACH,wBAAsB,gBAAgB,CACpC,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,iBAAiB,EAC1B,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAoBxB;AAED;;GAEG;AACH,wBAAsB,kBAAkB,CACtC,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAoBxB;AAED;;GAEG;AACH,wBAAsB,cAAc,CAClC,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,iBAAiB,EAC1B,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAoBxB;AAED;;GAEG;AACH,wBAAsB,mBAAmB,CACvC,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAoBxB;AAED;;GAEG;AACH,wBAAsB,eAAe,CACnC,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,iBAAiB,EAC1B,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAoBxB"}