jest-xlsx-reporter

An XLSX reporter for Jest

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
jest-xlsx-reporter
2.0.04 years ago4 years agoMinified + gzip package size for jest-xlsx-reporter in KB

Readme

jest-xlsx-reporter
A XLSX reporter for Jest

Description

An Excel Workbook (XLSX) Jest reporter with separate Worksheets for each file under test.

Compatibility

This reporter does not use testResultsProcessor as that has been deprecated per Jest documentation. Please use the reporters configuration option to point to this reporter. You will also need to have Node v7.6.0+.

How to install reporter

npm install jest-xlsx-reporter
Configure Jest to use reporters in your project
// jest.config.json
{
  "reporters": ["./node_modules/jest-xlsx-reporter"]
}

For more info refer to the Jest documentation for using reporters option.

Configuration

You can pass options to the reporter a few ways. If you do not set an outputPath it will default to test-results.xlsx in the project root.
You can put them in your jest.config.json file
// jest.config.json
{
  "reporters": ["./node_modules/jest-xlsx-reporter", { "outputPath": "custom-file.xlsx" }]
}

You can put your config in a file called jest-xlsx-reporter.config.json in the project root
// jest-xlsx-reporter.config.json
{
    outputPath: 'jest-test.xlsx'
}

You can put your config in your package.json under jest-xlsx-reporter
// package.json
},
jest-xlsx-reporter: {
    outputPath: 'test-results.xlsx'
},

Roadmap

  • Add more tests
  • Add configuration options (e.g. timestamp conversion, csv output)
  • Typescript?