Function calculateDistanceMetricsForProject

  • calculateDistanceMetricsForProject(tsConfigPath?, projectPath?, options?): Promise<{
        fileResults: {
            filePath: string;
            abstractness: number;
            instability: number;
            distanceFromMainSequence: number;
            couplingFactor: number;
            normalizedDistance: number;
            analysisResult: FileAnalysisResult;
        }[];
        projectSummary: {
            totalFiles: number;
            averageAbstractness: number;
            averageInstability: number;
            averageDistance: number;
            averageCouplingFactor: number;
            averageNormalizedDistance: number;
            filesOnMainSequence: number;
        };
    }>

  • Utility function to calculate distance metrics for an entire project using file-wise analysis based on TypeScript AST and dependency graphs

    Parameters

    • Optional tsConfigPath: string
    • Optional projectPath: string
    • Optional options: CheckOptions

    Returns Promise<{
        fileResults: {
            filePath: string;
            abstractness: number;
            instability: number;
            distanceFromMainSequence: number;
            couplingFactor: number;
            normalizedDistance: number;
            analysisResult: FileAnalysisResult;
        }[];
        projectSummary: {
            totalFiles: number;
            averageAbstractness: number;
            averageInstability: number;
            averageDistance: number;
            averageCouplingFactor: number;
            averageNormalizedDistance: number;
            filesOnMainSequence: number;
        };
    }>

Settings

Member Visibility

Theme