stig-engine/com.stigway.engine.commands.analyzefunctionmetrics

Package-level declarations

Types

AnalyzeFunctionMetricsCodeBrowserCommitRef

enum AnalyzeFunctionMetricsCodeBrowserCommitRef : Enum<AnalyzeFunctionMetricsCodeBrowserCommitRef>

AnalyzeFunctionMetricsCompositeCalibration

data class AnalyzeFunctionMetricsCompositeCalibration(val weightCognitiveComplexity: Double = 0.1, val weightBranches: Double = 0.55, val weightStatements: Double = 0.1, val weightLines: Double = 0.1, val weightParameters: Double = 0.1, val weightVariables: Double = 0.05, val scaleCognitiveComplexity: Double = defaultFunctionLowToMediumThreshold("cognitiveComplexity"), val scaleBranches: Double = defaultFunctionLowToMediumThreshold("branches"), val scaleStatements: Double = defaultFunctionLowToMediumThreshold("statements"), val scaleLines: Double = defaultFunctionLowToMediumThreshold("lines"), val scaleParameters: Double = defaultFunctionLowToMediumThreshold("parameters"), val scaleVariables: Double = defaultFunctionLowToMediumThreshold("variables"), val weightRecommendedTestsCognitiveComplexity: Double = 0.15, val weightRecommendedTestsBranches: Double = 0.7, val weightRecommendedTestsParameters: Double = 0.15, val scaleRecommendedTestsCognitiveComplexity: Double = 2.0, val scaleRecommendedTestsBranches: Double = 1.0, val scaleRecommendedTestsParameters: Double = 0.5, val scoreGain: Double = 1.0, val scoreOffset: Double = 0.0, val minimumRecommendedTests: Int = 1)

Calibration model used to derive per-function NEXY (Normalized Engineering compleXY).

AnalyzeFunctionMetricsOutputFormat

enum AnalyzeFunctionMetricsOutputFormat : Enum<AnalyzeFunctionMetricsOutputFormat>

AnalyzeFunctionMetricsRequest

data class AnalyzeFunctionMetricsRequest(val projectRoot: Path, val elementDir: Path, val compileCommandsFile: Path, val outputFile: Path, val sourceGlobs: List<String> = emptyList(), val excludedSourceGlobs: List<String> = emptyList(), val excludedSourceFiles: List<Path> = emptyList(), val outputFormat: AnalyzeFunctionMetricsOutputFormat = AnalyzeFunctionMetricsOutputFormat.JSON, val clangTidyBinary: String = StigLlvmToolchain.CLANG_TIDY, val codeBrowserCommitRef: AnalyzeFunctionMetricsCodeBrowserCommitRef = AnalyzeFunctionMetricsCodeBrowserCommitRef.CURRENT, val codeBrowserBaseUrl: String? = null, val codeBrowserContexts: List<CodeBrowserUrl.Context> = emptyList(), val compositeCalibration: AnalyzeFunctionMetricsCompositeCalibration = AnalyzeFunctionMetricsCompositeCalibration())

AnalyzeFunctionMetricsResult

data class AnalyzeFunctionMetricsResult(val outputFile: Path, val sourceFilesAnalyzed: Int, val functionCount: Int, val clangTidyExecutable: String)