Customizing the code review report

Data format

Each rule element represents a triggered rule, justified or not. It contains the following information at the top level:

• rule is the name of the rule, corresponding to its label defined in the configuration file
• group is the family of this rule, it corresponds to the label of the rule’s group that is defined in the configuration file
• kind is the severity of the rule. The possible values are 'error', 'warning' or 'info', depending on the error level in the configuration file and on the possible justification (the justified rules have an 'info' type value)
• line is the line of the current file where the rule was triggered
• column is the column of the current file where the rule was triggered
• text is the rule description. It is related to the rule text in configuration file
• justification is the justification text for the rule. This field is optional, and is present only if the rule is justified
  Example:

  {
  "rule": "M21.6.1", 
  "group": "21- Standard libraries", 
  "kind": "info", 
  "line": 21, 
  "column": 10, 
  "text": "The input/output library <stdio.h> shall not be used in production code.", 
  "justification": "This rule does not apply to the following line"
  }

Each deactivated element represents a group of rules that is deactivated for a specific reason. It contains the following information at the top level:

• desactivated_rules_by_user is used for all the rules that are deactivated when it is used in the configuration file with the error set to level 0. This field is optional, it can be empty, or you can enter an array of disactivated rule element
  Example:

  {
  "desactivated_rules_by_user": [
  ]
  }

• desactivated_rules_by_test_option is used for all the rules that are deactivated by using the “-test” option. This field is optional, it can be empty, or you can enter an array of disactivated rule element
  Example:

  {
  "desactivated_rules_test_option": [
  ]
  }

Each disactivated rule element represents a deactivated rule for any reason. It contains the following information at the top level:

• rule is the name of the rule, it corresponds to the rule label that is defined in the configuration file
• text is the rule description, it corresponds to the rule text in configuration file
  Example:

  {
  "rule": "E15.3", 
  "text": "The return keyword should not be used in a conditional block."
  }

Each rule statistics element represents global statistics for the rule raised during test. It contains the following information at the top level:

• ruleStatistics is the array of the statistic rule element
  Example:

  {
  "rulesStatistics": [
  ]
  }

Each statistic rule element contains a rule that was raised one or several times. It contains the following information at the top level:

• rule is the name of the rule. It corresponds to the rule label that is defined in the configuration file
• kind is the severity of the rule. The possible values are 'error' or 'warning' that correspond to the error level in the configuration file
• occurences is the number of times that the rule was raised
  Example:

  {
  "rule": "M17.7", 
  "kind": "error", 
  "text": "When a function returns a value, this value should be used.", 
  "occurences": 4
  }

Javascript functions

You can find in the misrareport.template template a set of JavaScript functions.

Some of the helper functions simplify access to “raw data”:

• isFct(element) checks whether an element is a function or not
• isFile(element) checks whether an element is a file or not
• isFileInError(element) checks whether an element is a file that contains an error or a warning
• isFctPassed(element) checks whether an element is a passed function or not
• isFctFailed(element) checks whether an element is a failed function or not
• isRuleError(element) checks whether a rule level is error or not
• isRuleWarning(element) checks whether a rule level is warning or not
• isRuleInfo(element) checks whether a rule level is an information or not
• isRuleJustified(element) checks whether a rule is justified or not

Other functions are used to display each section of the report:

• emptyLine() displays an empty line (helper function)
• startFile(element) is called at start of a file element.
• endFile() is called at end of a file element.
• startFileRules() is called at the beginning of a group of rules that is relative to a file. Used to display array headers
• endFileRules() is called at end of a group of rules relative to a file.
• startFileFunctions() is called at the beginning of a function
• rule(element) is called to display details of a raised rule.

The last section is a set of functions that is used to display summaries:

• displayDesactivatedbytest(elem) displays all deactivated rules by using the '-test' option
• displayDesactivatedbyuser(elem) displays all deactivated rules that are used in the configuration file
• displayrulesstatistics(elem) displays statistics for all rules that are raised during the test

The main algorithm dispatches the function calls by parsing the raw data.