iansan5653 / jest-markdown-reporter Goto Github PK

📜

A Jest test results processor for generating a summary in Markdown.
Forked from jest-html-reporter

$ npm install --save-dev jest-markdown-reporter

Configure Jest to process the test results by adding the following entry to the Jest config (jest.config.json):

"reporters": [
	"default",
	["./node_modules/jest-markdown-reporter", {
		"pageTitle": "Test Report"
	}]
]

As you run Jest from within the terminal, a file called test-report.md will be created within your root folder containing information about your tests.

There are multiple configuration options available.

To run the reporter as a test results processor (after Jest is complete instead of running in parallel), add the following entry to the Jest config (jest.config.json):

{
	"testResultsProcessor": "./node_modules/jest-markdown-reporter"
}

Note: When running as a testResultsProcessor, the configuration needs be placed within a new file named jestmarkdownreporter.config.json residing in the root folder.

This plugin is compatible with Node version ^4.8.3

Please note that all configuration properties are optional.

Configuration may also be performed with environment variables for dynamic file saving paths in different environments. *NOTE: Environment variables will take precedence over configurations set in jesthtmlreporter.config.json and package.json*

Here is an example of dynamically naming your output file and test report title to match your current branch that one might see in a automated deployment pipeline before running their tests.

export BRANCH_NAME=`git symbolic-ref HEAD 2>/dev/null | cut -d"/" -f 3`
export JEST_MARKDOWN_REPORTER_OUTPUT_PATH=/home/username/jest-test-output/test-reports/"$BRANCH_NAME".md
export JEST_MARKDOWN_REPORTER_PAGE_TITLE="$BRANCH_NAME"\ Test\ Report

The environment variables reflect the configuration options available in JSON format.