Sonar

Rename metric keys

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: 1.9
  • Component/s: API
  • Labels:
    None
  • Number of attachments :
    0

Description

Naming of metric keys is not enough explicit. It's important to set some naming conventions :

  • do not use 'count'
  • use _ to separate tokens
  • go from most specific to general, example : 'commented_public_classes'
  • % metrics are suffixed by 'density' : 'comments_density'

Upgrade to Sonar 1.9 implies renaming :

before after
NEW lines
ncss replaced by ncloc
NEW ncloc
classes_count classes
packages_count packages
files_count files
functions_count functions
directories_count directories
NEW accessors
ccn complexity
ccn_class class_complexity
NEW function_complexity
ccn_file file_complexity
ccn_classes_count_distribution class_complexity_distribution
ccn_classes_percent_distribution  REMOVED
NEW function_complexity_distribution
ccn_vs_cc uncovered_complexity_by_tests
comment_lines comment_lines
comment_ratio comment_lines_density
javadocs REMOVED
NEW public_api
NEW public_undocumented_api
NEW public_documented_api_density
test_count tests
test_errors_count test_errors
test_skipped_count skipped_tests
test_failures_count test_failures
test_success_percentage test_success_density
test_details test_data
test_execution_time test_execution_time
duplicated_lines UNCHANGED
duplicated_blocks UNCHANGED
duplicated_files UNCHANGED
duplications_data UNCHANGED
duplicated_lines_ratio duplicated_lines_density
code_coverage coverage
rules_violations_count violations
rules_violations mandatory_violations
optional_rules_violations optional_violations
rules_index violations_density
rules_compliance mandatory_violations_density
optional_rules_compliance REMOVED
alert_status UNCHANGED

Activity

Hide
Freddy Mallet added a comment -

Don't forget to also rename the Metric in the Java source code.

Show
Freddy Mallet added a comment - Don't forget to also rename the Metric in the Java source code.
Hide
Simon Brandhof added a comment -

'var_accessor_functions' is renamed 'accessors'

Show
Simon Brandhof added a comment - 'var_accessor_functions' is renamed 'accessors'
Hide
Freddy Mallet added a comment -

the metric "loc" must be renamed in "lines"

Show
Freddy Mallet added a comment - the metric "loc" must be renamed in "lines"

People

Vote (0)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved: