Skip to content

santoshshinde2012/jest-to-sonar

Repository files navigation

Convert the Jest test case report to a Sonar generic test execution report.

Quality Gate Status Github action workflow status maintainability test_coverage

Installation

  • Using yarn:

    yarn add -D jest-to-sonar
    
  • Using npm:

    npm i -D jest-to-sonar
    

Configuration

Configure the jest config file jest.config.js, by adding jest-to-sonar to the list of reporters. Once you successfully run the jest test command, a Sonar generic test execution report will be created at ./coverage/sonar-report.xml.

module.exports = {
    ...
    reporters: ['default',  'jest-to-sonar'],
    ...
}

We can customize the file name and path for the generated Sonar generic test execution report by passing parameters to outputFile in jest config.

module.exports = {
    ...
        reporters: ['default',  ['jest-to-sonar', {
            outputFile: './coverage/sonar-report.xml',
        }]],
    ...
}

Available Options

Parameter Name Description Default Value Type
outputFile Report file name with or without folder path ./coverage/sonar-report.xml String
... ... ... ...

You can help this project by reporting bugs, asking for features, or sending in pull requests.


Connect with me on