adpa-enterprise-framework-automation
Version:
Modular, standards-compliant Node.js/TypeScript automation framework for enterprise requirements, project, and data management. Provides CLI and API for BABOK v3, PMBOK 7th Edition, and DMBOK 2.0 (in progress). Production-ready Express.js API with TypeSpe
59 lines • 2.51 kB
TypeScript
/**
* Project Analyzer Module for Requirements Gathering Agent
*
* Provides comprehensive project analysis capabilities including markdown file discovery,
* content categorization, relevance scoring, and project context building.
*
* @version 2.1.3
* @author Requirements Gathering Agent Team
* @created 2024
* @updated June 2025
*
* Key Features:
* - Enhanced markdown file discovery with recursive directory scanning
* - Intelligent relevance scoring based on content and file structure
* - Automatic categorization of project documentation
* - Comprehensive project context building from multiple sources
* - Support for package.json metadata integration
*
* @filepath c:\Users\menno\Source\Repos\requirements-gathering-agent\src\modules\projectAnalyzer.ts
*/
export interface ProjectMarkdownFile {
fileName: string;
filePath: string;
content: string;
relevanceScore: number;
category: 'primary' | 'documentation' | 'planning' | 'development' | 'other';
}
export interface ProjectAnalysis {
readme: string | null;
additionalMarkdownFiles: ProjectMarkdownFile[];
packageJson: Record<string, any> | null;
projectContext: string;
suggestedSources: string[];
}
/**
* Reads the README.md file from the given project path.
* @param projectPath - The root directory of the project.
* @returns The content of README.md if found, otherwise null.
*/
export declare function getReadmeContent(projectPath: string): Promise<string | null>;
/**
* Reads and parses the package.json file from the given project path.
* @param projectPath - The root directory of the project.
* @returns The parsed package.json object if found and valid, otherwise null.
*/
export declare function getProjectPackageJson(projectPath: string): Promise<Record<string, any> | null>;
/**
* Analyzes the entire project directory for relevant markdown files and project information.
* @param projectPath - The root directory of the project.
* @returns Complete project analysis including all relevant markdown files.
*/
export declare function analyzeProjectComprehensively(projectPath: string): Promise<ProjectAnalysis>;
/**
* Finds all relevant markdown files in the project directory.
* @param projectPath - The root directory of the project.
* @returns Array of relevant markdown files with content and metadata.
*/
export declare function findRelevantMarkdownFiles(projectPath: string): Promise<ProjectMarkdownFile[]>;
//# sourceMappingURL=projectAnalyzer.d.ts.map