Skip to content

Latest commit

 

History

History
131 lines (90 loc) · 5.61 KB

README.md

File metadata and controls

131 lines (90 loc) · 5.61 KB
Raw

SonarQube R

Uploading your R project lintr information into SonarQube. This can be used as a plugin, to insert R language issues with SonarQube scanner.

This repository is DEPRECATED.

The new repository will utilize the R programming language, eliminating the need for additional tech stacks like JavaScript and Node.js is available at:

This transition is motivated by several factors:

  • Enhanced Performance: The R programming language is well-suited for data analysis and statistical computing, offering significant performance advantages for [project name].
  • Reduced Dependencies: By adopting R, we can streamline our development process and reduce the complexity of managing multiple tech stacks.
  • Ease of Maintenance: R is a widely used language with a large and active community, making it easier to maintain and extend the repository.

We understand that this change may require some adjustments to your development workflow. However, we are confident that the benefits of adopting R will outweigh any initial challenges.

Dependencies

You need to have the following

  • R (tested with version 4.0.3).

You need to have the following R libraries:

  • lintr
  • devtools
  • roxygen2

Usage

Install lintr packages and R.

Rscript -e 'install.packages("lintr")'
Rscript -e 'install.packages("devtools")'
Rscript -e 'install.packages("roxygen2")'

To generate the file lintr_out.json execute the command:

rscript .\run_lintr.R

The lintr generates a json file lintr_out.json with the issues found on your code. This format is not compatible with SonarQube and needs to follow the format:

So that Sonar Scanner is able to import the issues to SonarQube.

Issue fields description for Sonar.

  • engineId - string
  • ruleId - string
  • primaryLocation - Location object
  • type - string. One of BUG, VULNERABILITY, CODE_SMELL
  • severity - string. One of BLOCKER, CRITICAL, MAJOR, MINOR, INFO
  • effortMinutes - integer, optional. Defaults to 0
  • secondaryLocations - array of Location objects, optional

The mapping table is used to generate issue type, effort and severity required to ingest the information into SonarQube.

Linter Issue Type Effort Minutes Severity
object_usage_linter CODE_SMELL 5 MINOR
absolute_path_linter CODE_SMELL 5 MINOR
nonportable_path_linter CODE_SMELL 5 MINOR
pipe_continuation_linter CODE_SMELL 5 MINOR
assignment_linter CODE_SMELL 5 MINOR
camel_case_linter CODE_SMELL 5 MINOR
closed_curly_linter CODE_SMELL 5 MINOR
commas_linter CODE_SMELL 5 MINOR
commented_code_linter CODE_SMELL 5 MINOR
cyclocomp_linter CODE_SMELL 5 MINOR
equals_na_linter CODE_SMELL 5 MINOR
extraction_operator_linter CODE_SMELL 5 MINOR
function_left_parentheses_linter CODE_SMELL 5 MINOR
function_left_parentheses_linter CODE_SMELL 5 MINOR
implicit_integer_linter CODE_SMELL 5 MINOR
infix_spaces_linter CODE_SMELL 5 MINOR
line_length_linter CODE_SMELL 5 MINOR
no_tab_linter CODE_SMELL 5 MINOR
object_length_linter CODE_SMELL 5 MINOR
object_name_linter CODE_SMELL 5 MINOR
open_curly_linter CODE_SMELL 5 MINOR
paren_brace_linter CODE_SMELL 5 MINOR
semicolon_terminator_linter CODE_SMELL 5 MINOR
seq_linter CODE_SMELL 5 MINOR
single_quotes_linter CODE_SMELL 5 MINOR
spaces_inside_linter CODE_SMELL 5 MINOR
spaces_left_parentheses_linter CODE_SMELL 5 MINOR
todo_comment_linter CODE_SMELL 5 MINOR
trailing_blank_lines_linter CODE_SMELL 5 MINOR
trailing_whitespace_linter CODE_SMELL 5 MINOR
T_and_F_symbol_linter CODE_SMELL 5 MINOR
undesirable_function_linter CODE_SMELL 5 MINOR
undesirable_operator_linter CODE_SMELL 5 MINOR
unneeded_concatenation_linter CODE_SMELL 5 MINOR
other non specified in the table CODE_SMELL 5 MINOR

Translating from lintr json into SonarQube json format can be done online via in this site:

Save the converted json as the lintr_out.json .

Add the following line to your sonar-project.properties file:

sonar.externalIssuesReportPaths=lintr_sonar_out.json

Execute sonar-scanner to upload the issues to SonarQube server.

Enjoy.

Contribute