Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix undefined metric description #2883

Merged
merged 5 commits into from
Jul 6, 2022
Merged

fix undefined metric description #2883

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1c99951
add new metric description for 'statements'
MW-Friedrich Jul 6, 2022
e99c832
add logic to omit a metric description if it does not exist
MW-Friedrich Jul 6, 2022
401d437
update CHANGELOG.md
MW-Friedrich Jul 6, 2022
2282f54
refactor getNameAndDescriptionOfMetric
MW-Friedrich Jul 6, 2022
dd26444
test: getNameAndDescriptionOfMetric #2575
charlotteKehm Jul 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 8 additions & 1 deletion ...eCharta/ui/artificialIntelligence/artificialIntelligenceHelper/suspiciousMetricsHelper.ts
View file
Open in desktop
Expand Up @@ -62,6 +62,13 @@ function compareSuspiciousMetricSuggestionLinks(a: MetricSuggestionParameters, b
return 0
}

function getNameAndDescriptionOfMetric(metricName: string): string {
if (metricDescriptions.get(metricName)) {
return `${metricName} (${metricDescriptions.get(metricName)})`
MW-Friedrich marked this conversation as resolved.
Show resolved Hide resolved
}
return `${metricName}`
}

export function findGoodAndBadMetrics(
metricValuesByLanguages: MetricValuesByLanguage,
mainProgrammingLanguage: string
Expand All @@ -84,7 +91,7 @@ export function findGoodAndBadMetrics(
const maxMetricValue = Math.max(...valuesOfMetric)

if (maxMetricValue <= thresholdConfig.percentile70) {
metricAssessmentResults.unsuspiciousMetrics.push(`${metricName} (${metricDescriptions.get(metricName)})`)
metricAssessmentResults.unsuspiciousMetrics.push(getNameAndDescriptionOfMetric(metricName))
} else if (maxMetricValue > thresholdConfig.percentile70) {
metricAssessmentResults.suspiciousMetrics.set(metricName, {
from: thresholdConfig.percentile70,
Expand Down
3 changes: 2 additions & 1 deletion visualization/app/codeCharta/util/metric/metricDescriptions.ts
View file
Open in desktop
Expand Up @@ -14,5 +14,6 @@ export const metricDescriptions: Map<string, string> = new Map([
["line_coverage", "number of code lines covered by tests"],
["sonar_code_smells", "number of smells Sonar has identified"],
["avg_code_churn", "average number of lines added or removed from this file"],
["number_of_authors", "number of authors that have edited this file"]
["number_of_authors", "number of authors that have edited this file"],
["statements", "number of statements"]
])