jest-html-reporter 2.2.0 → 2.4.2

package/README.md

@@ -28,29 +28,29 @@ npm install jest-html-reporter --save-dev
 ```
 
 ## Usage
-Configure Jest to process the test results by adding the following entry to the Jest config (jest.config.js):
+Configure Jest to process the test results by adding the following entry to the Jest config (jest.config.json):
 ```JSON
-{
-	"testResultsProcessor": "./node_modules/jest-html-reporter"
-}
-```
-Then when you run Jest from within the terminal, a file called *test-report.html* will be created within your root folder containing information about your tests.
-
-#### Alternative usage with package.json
-Although jest.config.js is specifically created for configuring Jest (and not this plugin), it is possible to configure Jest from within package.json by adding the following as a new line:
-```JSON
-"jest": {"testResultsProcessor": "./node_modules/jest-html-reporter" }
+"reporters": [
+	"default",
+	["./node_modules/jest-html-reporter", {
+		"pageTitle": "Test Report"
+	}]
+]
 ```
+As you run Jest from within the terminal, a file called *test-report.html* will be created within your root folder containing information about your tests.
 
-### Run as a Custom Reporter
-It is also possible to run jest-html-reporter as a custom reporter within Jest. This allows the plugin to be run in parallel with Jest instead of after a test run, and will guarantee that the test report is generated even if Jest is run with options such as `--forceExit`.
-
-Add the following entry to the Jest config (jest.config.js):
+There are multiple configuration options available. To read more about these, please refer to the [documentation](https://github.com/Hargne/jest-html-reporter/wiki/configuration).
 
+### Alternative Usage as a Test Results Processor
+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):
 ```JSON
-"reporters": ["default", "./node_modules/jest-html-reporter"]
-```
-Please note that you need to add the `"executionMode": "reporter"` configuration within jesthtmlreporter.config.json in order for this to work (more information on configuration can be found within the [documentation](https://github.com/Hargne/jest-html-reporter/wiki/configuration)).
+{
+	"testResultsProcessor": "./node_modules/jest-html-reporter"
+}
+``` 
+
+**Note:** When running as a testResultsProcessor, the configuration needs be placed  within a new file named `jesthtmlreporter.config.json` residing in the root folder.
+More information about this can be found in the [documentation](https://github.com/Hargne/jest-html-reporter/wiki/configuration).
 
 
 ## Node Compatibility
@@ -59,48 +59,23 @@ This plugin is compatible with Node version `^4.8.3`
 ---
 
 ## Configuration
-To configure this plugin, create a file named `jesthtmlreporter.config.json` in the root folder of the project. Please note that all configuration properties are optional.
+Please note that all configuration properties are optional.
 
 | Property | Type | Description | Default
 |--|--|--|--|
 | `pageTitle` | `STRING` | The title of the document. This string will also be outputted on the top of the page. | `"Test Suite"`
 | `outputPath` | `STRING` | The path to where the plugin will output the HTML report. The path must include the filename and end with .html | `"./test-report.html"`
 | `includeFailureMsg` | `BOOLEAN` | If this setting is set to true, this will output the detailed failure message for each failed test. | `false`
+| `includeConsoleLog` | `BOOLEAN` | If set to true, this will output all triggered console logs for each test suite. | `false`
 | `styleOverridePath` | `STRING` | The path to a file containing CSS styles that should override the default styling.* | `null`
 | `customScriptPath` | `STRING` | Path to a javascript file that should be injected into the test report | `null`
-| `theme` | `STRING` | The name of the reporter themes to use when rendering the report. You can find the available themes in the [Documentation](https://github.com/Hargne/jest-html-reporter/wiki/Test-Report-Themes) | `"defaultTheme"`
+| `theme` | `STRING` | The name of the reporter themes to use when rendering the report. You can find the available themes in the [documentation](https://github.com/Hargne/jest-html-reporter/wiki/Test-Report-Themes) | `"defaultTheme"`
 | `logo` | `STRING` | Path to a logo that will be included in the header of the report | `null`
 | `executionTimeWarningThreshold` | `NUMBER` | The threshold for test execution time (in seconds) in each test suite that will render a warning on the report page. 5 seconds is the default timeout in Jest. | `5`
-| `dateFormat` | `STRING` | The format in which date/time should be formatted in the test report. Have a look in the [Documentation](https://github.com/Hargne/jest-html-reporter/wiki/Date-Format) for the available date format variables. | `"yyyy-mm-dd HH:MM:ss"`
-| `sort` | `STRING` | Sorts the test results using the given method. Available sorting methods can be found in the [Documentation](https://github.com/Hargne/jest-html-reporter/wiki/Sorting-Methods). | `"default"`
-| `executionMode` | `STRING` | Defines the execution mode. Avaiable modes are: `reporter`, `testResultsProcessor` | `"testResultsProcessor"`
+| `dateFormat` | `STRING` | The format in which date/time should be formatted in the test report. Have a look in the [documentation](https://github.com/Hargne/jest-html-reporter/wiki/Date-Format) for the available date format variables. | `"yyyy-mm-dd HH:MM:ss"`
+| `sort` | `STRING` | Sorts the test results using the given method. Available sorting methods can be found in the [documentation](https://github.com/Hargne/jest-html-reporter/wiki/Sorting-Methods). | `"default"`
 
-#### *A note on styleOverridePath
-The plugin will search for the file from the root directory, therefore there is no need to prepend the string with `./` or `../`. Please have a look at the default styling (located within *style/defaultTheme.css*) for a reference of the elements available for styling.
-
-### Example Configuration
-
-```
-{
-	"pageTitle": "Your test suite",
-	"outputPath": "test-report/index.html",
-	"includeFailureMsg": true,
-	"styleOverridePath": "src/teststyle.css"
-}
-```
-
-#### Alternative configuration with package.json
-Add an entry named *"jest-html-reporter"* to your package.json 
-```
-{
-	...
-	"jest-html-reporter": {
-		"pageTitle": "Your test suite",
-		"outputPath": "test-report.html",
-		"includeFailureMsg": true
-	}
-}
-```
+> *The plugin will search for the *styleOverridePath* from the root directory, therefore there is no need to prepend the string with `./` or `../` - You can read more about the themes in the [documentation](https://github.com/Hargne/jest-html-reporter/wiki/Test-Report-Themes).
 
 ---
 
@@ -118,5 +93,5 @@ export JEST_HTML_REPORTER_PAGE_TITLE="$BRANCH_NAME"\ Test\ Report
 ```
 
 ### Configuration Environment Variables
-The environment variables reflect the properties set in the JSON configuration file. Please read the [documentation](https://github.com/Hargne/jest-html-reporter/wiki/configuration#configuration-environment-variables) for more information on these variables.
+The environment variables reflect the configuration options available in JSON format. Please read the [documentation](https://github.com/Hargne/jest-html-reporter/wiki/configuration#configuration-environment-variables) for more information on these variables.
 

package/dist/main.js

@@ -367,11 +367,26 @@ class ReportGenerator {
 					// Append data to <tr>
 					testTr.ele('td', { class: 'result' }, (test.status === 'passed') ? `${test.status} in ${test.duration / 1000}s` : test.status);
 				});
+
+				// Test Suite console.logs
+				if (suite.console && suite.console.length > 0 && (this.config.shouldIncludeConsoleLog())) {
+					// Console Log Container
+					const consoleLogContainer = htmlOutput.ele('div', { class: 'suite-consolelog' });
+					// Console Log Header
+					consoleLogContainer.ele('div', { class: 'suite-consolelog-header' }, 'Console Log');
+
+					// Logs
+					suite.console.forEach((log) => {
+						const logElement = consoleLogContainer.ele('div', { class: 'suite-consolelog-item' });
+						logElement.ele('pre', { class: 'suite-consolelog-item-origin' }, stripAnsi(log.origin));
+						logElement.ele('pre', { class: 'suite-consolelog-item-message' }, stripAnsi(log.message));
+					});
+				}
 			});
 			// Custom Javascript
 			const customScript = this.config.getCustomScriptFilepath();
 			if (customScript) {
-				htmlOutput.ele('script', { src: customScript });
+				htmlOutput.raw(`<script src="${customScript}"></script>`);
 			}
 			return resolve(htmlOutput);
 		});
@@ -457,6 +472,13 @@ const getLogo = () =>
 const shouldIncludeFailureMessages = () =>
 	process.env.JEST_HTML_REPORTER_INCLUDE_FAILURE_MSG || config.includeFailureMsg || false;
 
+/**
+ * Returns whether the report should contain console.logs or not
+ * @return {Boolean}
+ */
+const shouldIncludeConsoleLog = () =>
+	process.env.JEST_HTML_REPORTER_INCLUDE_CONSOLE_LOG || config.includeConsoleLog || false;
+
 /**
  * Returns the configured threshold (in seconds) when to apply a warning
  * @return {Number}
@@ -479,13 +501,6 @@ const getDateFormat = () =>
 const getSort = () =>
 	process.env.JEST_HTML_REPORTER_SORT || config.sort || 'default';
 
-/**
- * Returns the configured mode of execution ('testResultsProcessor' or 'reporters')
- * @return {String}
- */
-const getExecutionMode = () =>
-	process.env.JEST_HTML_REPORTER_EXECUTION_MODE || config.executionMode || 'testResultsProcessor';
-
 module.exports = {
 	config,
 	setup,
@@ -496,11 +511,11 @@ module.exports = {
 	getPageTitle,
 	getLogo,
 	shouldIncludeFailureMessages,
+	shouldIncludeConsoleLog,
 	getExecutionTimeWarningThreshold,
 	getTheme,
 	getDateFormat,
 	getSort,
-	getExecutionMode,
 };
 });
 
@@ -513,45 +528,48 @@ var config_7 = config_1.getCustomScriptFilepath;
 var config_8 = config_1.getPageTitle;
 var config_9 = config_1.getLogo;
 var config_10 = config_1.shouldIncludeFailureMessages;
-var config_11 = config_1.getExecutionTimeWarningThreshold;
-var config_12 = config_1.getTheme;
-var config_13 = config_1.getDateFormat;
-var config_14 = config_1.getSort;
-var config_15 = config_1.getExecutionMode;
-
-var src = createCommonjsModule(function (module) {
-// Initiate the config and the Report Generator class
-config_1.setup();
-const reportGenerator$$1 = new reportGenerator(config_1);
+var config_11 = config_1.shouldIncludeConsoleLog;
+var config_12 = config_1.getExecutionTimeWarningThreshold;
+var config_13 = config_1.getTheme;
+var config_14 = config_1.getDateFormat;
+var config_15 = config_1.getSort;
 
-/**
- * Usage as TestResultsProcessor
- * @param {Object} testResult Jest test result data
- */
-const TestResultsProcessor = (testResult) => {
-	// Generate Report
-	reportGenerator$$1.generate({ data: testResult });
-	// Return the results as required by Jest
-	return testResult;
-};
+function JestHtmlReporter(globalConfig, options) {
+	// Initiate the config and setup the Generator class
+	config_1.setup();
+	const reportGenerator$$1 = new reportGenerator(config_1);
 
-/**
- * Usage as Custom Reporter
- */
-class CustomReporter {
-	constructor(globalConfig, options) {
-		this.jestConfig = globalConfig;
-		this.jestOptions = options;
+	/**
+	 * If the first parameter has a property named 'testResults',
+	 * the script is being run as a 'testResultsProcessor'.
+	 * We then need to return the test results as they were received from Jest
+	 * https://facebook.github.io/jest/docs/en/configuration.html#testresultsprocessor-string
+	 */
+	if (Object.prototype.hasOwnProperty.call(globalConfig, 'testResults')) {
+		// Generate Report
+		reportGenerator$$1.generate({ data: globalConfig });
+		// Return the results as required by Jest
+		return globalConfig;
 	}
 
-	onRunComplete(contexts, testResult) {
-		this.testResult = testResult;
+	/**
+	 * The default behaviour - run as Custom Reporter, in parallel with Jest.
+	 * This should eventually be turned into a proper class (whenever the testResultsProcessor option is phased out)
+	 * https://facebook.github.io/jest/docs/en/configuration.html#reporters-array-modulename-modulename-options
+	 */
+	this.jestConfig = globalConfig;
+	this.jestOptions = options;
+
+	this.onRunComplete = (contexts, testResult) => {
+		// Apply the configuration within jest.config.json to the current config
+		config_1.setConfigData(this.jestOptions);
+		// Apply the updated config
+		reportGenerator$$1.config = config_1;
 		// Generate Report
 		return reportGenerator$$1.generate({ data: testResult });
-	}
+	};
 }
 
-module.exports = (config_1.getExecutionMode() === 'reporter') ? CustomReporter : TestResultsProcessor;
-});
+var src = JestHtmlReporter;
 
 module.exports = src;

package/dist/main.min.js

@@ -1 +1 @@
-"use strict";function _interopDefault(e){return e&&"object"==typeof e&&"default"in e?e.default:e}var fs=_interopDefault(require("fs")),path=_interopDefault(require("path")),mkdirp=_interopDefault(require("mkdirp")),xmlbuilder=_interopDefault(require("xmlbuilder")),dateformat=_interopDefault(require("dateformat")),stripAnsi=_interopDefault(require("strip-ansi"));function createCommonjsModule(e,t){return e(t={exports:{}},t.exports),t.exports}var utils=createCommonjsModule(function(e){e.exports={logMessage:({type:e,msg:t,ignoreConsole:s})=>{const r={default:"%s",success:"%s",error:"%s"},o=r[e]?r[e]:r.default,n=`jest-html-reporter >> ${t}`;return s||console.log(o,n),{logColor:o,logMsg:n}},writeFile:({filePath:e,content:t})=>new Promise((s,r)=>{mkdirp(path.dirname(e),o=>o?r(new Error(`Something went wrong when creating the folder: ${o}`)):fs.writeFile(e,t,t=>t?r(new Error(`Something went wrong when creating the file: ${t}`)):s(e)))}),createHtmlBase:({pageTitle:e,stylesheet:t})=>xmlbuilder.create({html:{head:{meta:{"@charset":"utf-8"},title:{"#text":e},style:{"@type":"text/css","#text":t}}}}),sortAlphabetically:({a:e,b:t,reversed:s})=>!s&&e<t||s&&e>t?-1:!s&&e>t||s&&e<t?1:0}}),utils_1=utils.logMessage,utils_2=utils.writeFile,utils_3=utils.createHtmlBase,utils_4=utils.sortAlphabetically,sorting=createCommonjsModule(function(e){e.exports={sortSuiteResults:({testData:e,sortMethod:t})=>{if(t)switch(t.toLowerCase()){case"status":return(e=>{const t=[],s=[],r=[];return e.forEach(e=>{const o=[],n=[],i=[];e.testResults.forEach(e=>{"pending"===e.status?o.push(e):"failed"===e.status?n.push(e):i.push(e)}),o.length&&t.push(Object.assign({},e,{testResults:o})),n.length&&s.push(Object.assign({},e,{testResults:n})),i.length&&r.push(Object.assign({},e,{testResults:i}))}),[].concat(t,s,r)})(e);case"executiondesc":return(e=>(e&&e.sort((e,t)=>t.perfStats.end-t.perfStats.start-(e.perfStats.end-e.perfStats.start)),e))(e);case"executionasc":return(e=>(e&&e.sort((e,t)=>e.perfStats.end-e.perfStats.start-(t.perfStats.end-t.perfStats.start)),e))(e);case"titledesc":return(e=>{if(e){const t=e.sort((e,t)=>utils.sortAlphabetically({a:e.testFilePath,b:t.testFilePath,reversed:!0}));return t.forEach(e=>{e.testResults.sort((e,t)=>utils.sortAlphabetically({a:e.ancestorTitles.join(" "),b:t.ancestorTitles.join(" "),reversed:!0}))}),t}return e})(e);case"titleasc":return(e=>{if(e){const t=e.sort((e,t)=>utils.sortAlphabetically({a:e.testFilePath,b:t.testFilePath}));return t.forEach(e=>{e.testResults.sort((e,t)=>utils.sortAlphabetically({a:e.ancestorTitles.join(" "),b:t.ancestorTitles.join(" ")}))}),t}return e})(e);default:return e}return e}}}),sorting_1=sorting.sortSuiteResults;class ReportGenerator{constructor(e){this.config=e}generate({data:e,ignoreConsole:t}){const s=this.config.getOutputFilepath();return this.getStylesheetContent().then(t=>this.renderHtmlReport({data:e,stylesheet:t})).then(e=>utils.writeFile({filePath:s,content:e})).then(()=>utils.logMessage({type:"success",msg:`Report generated (${s})`,ignoreConsole:t})).catch(e=>utils.logMessage({type:"error",msg:e,ignoreConsole:t}))}getStylesheetContent(){const e=this.config.getStylesheetFilepath();return new Promise((t,s)=>{fs.readFile(e,"utf8",(r,o)=>r?s(new Error(`Could not locate the stylesheet: '${e}': ${r}`)):t(o))})}renderHtmlReport({data:e,stylesheet:t}){return new Promise((s,r)=>{if(!e)return r(new Error("Test data missing or malformed"));const o=this.config.getPageTitle(),n=utils.createHtmlBase({pageTitle:o,stylesheet:t}),i=n.ele("header");i.ele("h1",{id:"title"},o);const a=this.config.getLogo();a&&i.ele("img",{id:"logo",src:a});const l=n.ele("div",{id:"metadata-container"}),c=new Date(e.startTime);l.ele("div",{id:"timestamp"},`Start: ${dateformat(c,this.config.getDateFormat())}`),l.ele("div",{id:"summary"},`\n\t\t\t\t${e.numTotalTests} tests --\n\t\t\t\t${e.numPassedTests} passed /\n\t\t\t\t${e.numFailedTests} failed /\n\t\t\t\t${e.numPendingTests} pending\n\t\t\t`),sorting.sortSuiteResults({testData:e.testResults,sortMethod:this.config.getSort()}).forEach(e=>{if(!e.testResults||e.testResults.length<=0)return;const t=n.ele("div",{class:"suite-info"});t.ele("div",{class:"suite-path"},e.testFilePath);const s=(e.perfStats.end-e.perfStats.start)/1e3;t.ele("div",{class:`suite-time${s>5?" warn":""}`},`${s}s`);const r=n.ele("table",{class:"suite-table",cellspacing:"0",cellpadding:"0"});e.testResults.forEach(e=>{const t=r.ele("tr",{class:e.status});t.ele("td",{class:"suite"},e.ancestorTitles.join(" > "));const s=t.ele("td",{class:"test"},e.title);if(e.failureMessages&&this.config.shouldIncludeFailureMessages()){const t=s.ele("div",{class:"failureMessages"});e.failureMessages.forEach(e=>{t.ele("pre",{class:"failureMsg"},stripAnsi(e))})}t.ele("td",{class:"result"},"passed"===e.status?`${e.status} in ${e.duration/1e3}s`:e.status)})});const u=this.config.getCustomScriptFilepath();return u&&n.ele("script",{src:u}),s(n)})}}var reportGenerator=ReportGenerator,config_1=createCommonjsModule(function(e){const t={},s=e=>Object.assign(t,e),r=()=>process.env.JEST_HTML_REPORTER_THEME||t.theme||"defaultTheme";e.exports={config:t,setup:()=>{try{const e=fs.readFileSync(path.join(process.cwd(),"jesthtmlreporter.config.json"),"utf8");if(e)return s(JSON.parse(e))}catch(e){}try{const e=fs.readFileSync(path.join(process.cwd(),"package.json"),"utf8");if(e)return s(JSON.parse(e)["jest-html-reporter"])}catch(e){}return t},setConfigData:s,getOutputFilepath:()=>process.env.JEST_HTML_REPORTER_OUTPUT_PATH||t.outputPath||path.join(process.cwd(),"test-report.html"),getStylesheetFilepath:()=>process.env.JEST_HTML_REPORTER_STYLE_OVERRIDE_PATH||t.styleOverridePath||path.join(__dirname,`../style/${r()}.css`),getCustomScriptFilepath:()=>process.env.JEST_HTML_REPORTER_CUSTOM_SCRIPT_PATH||t.customScriptPath||null,getPageTitle:()=>process.env.JEST_HTML_REPORTER_PAGE_TITLE||t.pageTitle||"Test report",getLogo:()=>process.env.JEST_HTML_REPORTER_LOGO||t.logo||null,shouldIncludeFailureMessages:()=>process.env.JEST_HTML_REPORTER_INCLUDE_FAILURE_MSG||t.includeFailureMsg||!1,getExecutionTimeWarningThreshold:()=>process.env.JEST_HTML_REPORTER_EXECUTION_TIME_WARNING_THRESHOLD||t.executionTimeWarningThreshold||5,getTheme:r,getDateFormat:()=>process.env.JEST_HTML_REPORTER_DATE_FORMAT||t.dateFormat||"yyyy-mm-dd HH:MM:ss",getSort:()=>process.env.JEST_HTML_REPORTER_SORT||t.sort||"default",getExecutionMode:()=>process.env.JEST_HTML_REPORTER_EXECUTION_MODE||t.executionMode||"testResultsProcessor"}}),config_2=config_1.config,config_3=config_1.setup,config_4=config_1.setConfigData,config_5=config_1.getOutputFilepath,config_6=config_1.getStylesheetFilepath,config_7=config_1.getCustomScriptFilepath,config_8=config_1.getPageTitle,config_9=config_1.getLogo,config_10=config_1.shouldIncludeFailureMessages,config_11=config_1.getExecutionTimeWarningThreshold,config_12=config_1.getTheme,config_13=config_1.getDateFormat,config_14=config_1.getSort,config_15=config_1.getExecutionMode,src=createCommonjsModule(function(e){config_1.setup();const t=new reportGenerator(config_1);e.exports="reporter"===config_1.getExecutionMode()?class{constructor(e,t){this.jestConfig=e,this.jestOptions=t}onRunComplete(e,s){return this.testResult=s,t.generate({data:s})}}:e=>(t.generate({data:e}),e)});module.exports=src;
+"use strict";function _interopDefault(e){return e&&"object"==typeof e&&"default"in e?e.default:e}var fs=_interopDefault(require("fs")),path=_interopDefault(require("path")),mkdirp=_interopDefault(require("mkdirp")),xmlbuilder=_interopDefault(require("xmlbuilder")),dateformat=_interopDefault(require("dateformat")),stripAnsi=_interopDefault(require("strip-ansi"));function createCommonjsModule(e,t){return e(t={exports:{}},t.exports),t.exports}var utils=createCommonjsModule(function(e){e.exports={logMessage:({type:e,msg:t,ignoreConsole:s})=>{const o={default:"%s",success:"%s",error:"%s"},r=o[e]?o[e]:o.default,i=`jest-html-reporter >> ${t}`;return s||console.log(r,i),{logColor:r,logMsg:i}},writeFile:({filePath:e,content:t})=>new Promise((s,o)=>{mkdirp(path.dirname(e),r=>r?o(new Error(`Something went wrong when creating the folder: ${r}`)):fs.writeFile(e,t,t=>t?o(new Error(`Something went wrong when creating the file: ${t}`)):s(e)))}),createHtmlBase:({pageTitle:e,stylesheet:t})=>xmlbuilder.create({html:{head:{meta:{"@charset":"utf-8"},title:{"#text":e},style:{"@type":"text/css","#text":t}}}}),sortAlphabetically:({a:e,b:t,reversed:s})=>!s&&e<t||s&&e>t?-1:!s&&e>t||s&&e<t?1:0}}),utils_1=utils.logMessage,utils_2=utils.writeFile,utils_3=utils.createHtmlBase,utils_4=utils.sortAlphabetically,sorting=createCommonjsModule(function(e){e.exports={sortSuiteResults:({testData:e,sortMethod:t})=>{if(t)switch(t.toLowerCase()){case"status":return(e=>{const t=[],s=[],o=[];return e.forEach(e=>{const r=[],i=[],n=[];e.testResults.forEach(e=>{"pending"===e.status?r.push(e):"failed"===e.status?i.push(e):n.push(e)}),r.length&&t.push(Object.assign({},e,{testResults:r})),i.length&&s.push(Object.assign({},e,{testResults:i})),n.length&&o.push(Object.assign({},e,{testResults:n}))}),[].concat(t,s,o)})(e);case"executiondesc":return(e=>(e&&e.sort((e,t)=>t.perfStats.end-t.perfStats.start-(e.perfStats.end-e.perfStats.start)),e))(e);case"executionasc":return(e=>(e&&e.sort((e,t)=>e.perfStats.end-e.perfStats.start-(t.perfStats.end-t.perfStats.start)),e))(e);case"titledesc":return(e=>{if(e){const t=e.sort((e,t)=>utils.sortAlphabetically({a:e.testFilePath,b:t.testFilePath,reversed:!0}));return t.forEach(e=>{e.testResults.sort((e,t)=>utils.sortAlphabetically({a:e.ancestorTitles.join(" "),b:t.ancestorTitles.join(" "),reversed:!0}))}),t}return e})(e);case"titleasc":return(e=>{if(e){const t=e.sort((e,t)=>utils.sortAlphabetically({a:e.testFilePath,b:t.testFilePath}));return t.forEach(e=>{e.testResults.sort((e,t)=>utils.sortAlphabetically({a:e.ancestorTitles.join(" "),b:t.ancestorTitles.join(" ")}))}),t}return e})(e);default:return e}return e}}}),sorting_1=sorting.sortSuiteResults;class ReportGenerator{constructor(e){this.config=e}generate({data:e,ignoreConsole:t}){const s=this.config.getOutputFilepath();return this.getStylesheetContent().then(t=>this.renderHtmlReport({data:e,stylesheet:t})).then(e=>utils.writeFile({filePath:s,content:e})).then(()=>utils.logMessage({type:"success",msg:`Report generated (${s})`,ignoreConsole:t})).catch(e=>utils.logMessage({type:"error",msg:e,ignoreConsole:t}))}getStylesheetContent(){const e=this.config.getStylesheetFilepath();return new Promise((t,s)=>{fs.readFile(e,"utf8",(o,r)=>o?s(new Error(`Could not locate the stylesheet: '${e}': ${o}`)):t(r))})}renderHtmlReport({data:e,stylesheet:t}){return new Promise((s,o)=>{if(!e)return o(new Error("Test data missing or malformed"));const r=this.config.getPageTitle(),i=utils.createHtmlBase({pageTitle:r,stylesheet:t}),n=i.ele("header");n.ele("h1",{id:"title"},r);const l=this.config.getLogo();l&&n.ele("img",{id:"logo",src:l});const a=i.ele("div",{id:"metadata-container"}),c=new Date(e.startTime);a.ele("div",{id:"timestamp"},`Start: ${dateformat(c,this.config.getDateFormat())}`),a.ele("div",{id:"summary"},`\n\t\t\t\t${e.numTotalTests} tests --\n\t\t\t\t${e.numPassedTests} passed /\n\t\t\t\t${e.numFailedTests} failed /\n\t\t\t\t${e.numPendingTests} pending\n\t\t\t`),sorting.sortSuiteResults({testData:e.testResults,sortMethod:this.config.getSort()}).forEach(e=>{if(!e.testResults||e.testResults.length<=0)return;const t=i.ele("div",{class:"suite-info"});t.ele("div",{class:"suite-path"},e.testFilePath);const s=(e.perfStats.end-e.perfStats.start)/1e3;t.ele("div",{class:`suite-time${s>5?" warn":""}`},`${s}s`);const o=i.ele("table",{class:"suite-table",cellspacing:"0",cellpadding:"0"});if(e.testResults.forEach(e=>{const t=o.ele("tr",{class:e.status});t.ele("td",{class:"suite"},e.ancestorTitles.join(" > "));const s=t.ele("td",{class:"test"},e.title);if(e.failureMessages&&this.config.shouldIncludeFailureMessages()){const t=s.ele("div",{class:"failureMessages"});e.failureMessages.forEach(e=>{t.ele("pre",{class:"failureMsg"},stripAnsi(e))})}t.ele("td",{class:"result"},"passed"===e.status?`${e.status} in ${e.duration/1e3}s`:e.status)}),e.console&&e.console.length>0&&this.config.shouldIncludeConsoleLog()){const t=i.ele("div",{class:"suite-consolelog"});t.ele("div",{class:"suite-consolelog-header"},"Console Log"),e.console.forEach(e=>{const s=t.ele("div",{class:"suite-consolelog-item"});s.ele("pre",{class:"suite-consolelog-item-origin"},stripAnsi(e.origin)),s.ele("pre",{class:"suite-consolelog-item-message"},stripAnsi(e.message))})}});const u=this.config.getCustomScriptFilepath();return u&&i.raw(`<script src="${u}"><\/script>`),s(i)})}}var reportGenerator=ReportGenerator,config_1=createCommonjsModule(function(e){const t={},s=e=>Object.assign(t,e),o=()=>process.env.JEST_HTML_REPORTER_THEME||t.theme||"defaultTheme";e.exports={config:t,setup:()=>{try{const e=fs.readFileSync(path.join(process.cwd(),"jesthtmlreporter.config.json"),"utf8");if(e)return s(JSON.parse(e))}catch(e){}try{const e=fs.readFileSync(path.join(process.cwd(),"package.json"),"utf8");if(e)return s(JSON.parse(e)["jest-html-reporter"])}catch(e){}return t},setConfigData:s,getOutputFilepath:()=>process.env.JEST_HTML_REPORTER_OUTPUT_PATH||t.outputPath||path.join(process.cwd(),"test-report.html"),getStylesheetFilepath:()=>process.env.JEST_HTML_REPORTER_STYLE_OVERRIDE_PATH||t.styleOverridePath||path.join(__dirname,`../style/${o()}.css`),getCustomScriptFilepath:()=>process.env.JEST_HTML_REPORTER_CUSTOM_SCRIPT_PATH||t.customScriptPath||null,getPageTitle:()=>process.env.JEST_HTML_REPORTER_PAGE_TITLE||t.pageTitle||"Test report",getLogo:()=>process.env.JEST_HTML_REPORTER_LOGO||t.logo||null,shouldIncludeFailureMessages:()=>process.env.JEST_HTML_REPORTER_INCLUDE_FAILURE_MSG||t.includeFailureMsg||!1,shouldIncludeConsoleLog:()=>process.env.JEST_HTML_REPORTER_INCLUDE_CONSOLE_LOG||t.includeConsoleLog||!1,getExecutionTimeWarningThreshold:()=>process.env.JEST_HTML_REPORTER_EXECUTION_TIME_WARNING_THRESHOLD||t.executionTimeWarningThreshold||5,getTheme:o,getDateFormat:()=>process.env.JEST_HTML_REPORTER_DATE_FORMAT||t.dateFormat||"yyyy-mm-dd HH:MM:ss",getSort:()=>process.env.JEST_HTML_REPORTER_SORT||t.sort||"default"}}),config_2=config_1.config,config_3=config_1.setup,config_4=config_1.setConfigData,config_5=config_1.getOutputFilepath,config_6=config_1.getStylesheetFilepath,config_7=config_1.getCustomScriptFilepath,config_8=config_1.getPageTitle,config_9=config_1.getLogo,config_10=config_1.shouldIncludeFailureMessages,config_11=config_1.shouldIncludeConsoleLog,config_12=config_1.getExecutionTimeWarningThreshold,config_13=config_1.getTheme,config_14=config_1.getDateFormat,config_15=config_1.getSort;function JestHtmlReporter(e,t){config_1.setup();const s=new reportGenerator(config_1);if(Object.prototype.hasOwnProperty.call(e,"testResults"))return s.generate({data:e}),e;this.jestConfig=e,this.jestOptions=t,this.onRunComplete=((e,t)=>(config_1.setConfigData(this.jestOptions),s.config=config_1,s.generate({data:t})))}var src=JestHtmlReporter;module.exports=src;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-html-reporter",
-  "version": "2.2.0",
+  "version": "2.4.2",
   "description": "Jest test results processor for generating a summary in HTML",
   "main": "dist/main",
   "unpkg": "dist/main.min.js",
@@ -10,7 +10,8 @@
   ],
   "scripts": {
     "eslint": "./node_modules/.bin/eslint ./src/**/*.js",
-    "test": "npm run eslint && jest --no-cache --config=jest.config.json",
+    "jest": "jest --no-cache --config=jest.config.json",
+    "test": "npm run eslint && npm run jest",
     "bundle": "rollup -c rollup.config.js",
     "bundle:minified": "rollup -c rollup.config.js --environment BUILD:minified",
     "bundle:all": "npm run bundle && npm run bundle:minified",
@@ -43,16 +44,18 @@
     "xmlbuilder": "8.2.2"
   },
   "peerDependencies": {
-    "jest": "19.x - 22.x"
+    "jest": "19.x - 23.x"
   },
   "devDependencies": {
-    "eslint": "^4.16.0",
+    "eslint": "^4.19.1",
     "eslint-config-airbnb-base": "^12.1.0",
-    "eslint-plugin-import": "^2.8.0",
+    "eslint-plugin-import": "^2.13.0",
     "jest": "^21.2.1",
-    "rollup": "^0.55.2",
-    "rollup-plugin-commonjs": "^8.3.0",
-    "rollup-plugin-node-resolve": "^3.0.2",
-    "rollup-plugin-uglify": "^3.0.0"
+    "rollup": "^0.55.5",
+    "rollup-plugin-commonjs": "^8.4.1",
+    "rollup-plugin-node-resolve": "^3.3.0",
+    "rollup-plugin-uglify": "^3.0.0",
+    "istanbul-api": "1.2.2",
+    "istanbul-reports": "1.1.4"
   }
 }

package/style/darkTheme.css

@@ -122,3 +122,28 @@ header {
 	width: 20%;
 	text-align: right;
 }
+
+/* CONSOLE LOGS */
+.suite-consolelog {
+	margin-bottom: 2rem;
+	padding: 1rem;
+	border-left: 0.5rem solid #999;
+	color: #999;
+}
+.suite-consolelog-header {
+	font-weight: bold;
+}
+.suite-consolelog-item {
+	padding: 0.5rem;
+}
+.suite-consolelog-item pre {
+	margin: 0;
+}
+.suite-consolelog-item-origin {
+	color: #555;
+	font-weight: bold;
+}
+.suite-consolelog-item-message {
+	font-size: 1rem;
+	padding: 0 0.5rem;
+}

package/style/defaultTheme.css

@@ -96,3 +96,28 @@ header {
 	width: 20%;
 	text-align: right;
 }
+
+/* CONSOLE LOGS */
+.suite-consolelog {
+	margin-bottom: 2rem;
+	padding: 1rem;
+	background-color: #efefef;
+}
+.suite-consolelog-header {
+	font-weight: bold;
+}
+.suite-consolelog-item {
+	padding: 0.5rem;
+}
+.suite-consolelog-item pre {
+	margin: 0;
+}
+.suite-consolelog-item-origin {
+	color: #777;
+	font-weight: bold;
+}
+.suite-consolelog-item-message {
+	color: #000;
+	font-size: 1rem;
+	padding: 0 0.5rem;
+}

package/style/lightTheme.css

@@ -121,3 +121,29 @@ header {
 	width: 20%;
 	text-align: right;
 }
+
+/* CONSOLE LOGS */
+.suite-consolelog {
+	margin-bottom: 2rem;
+	padding: 1rem;
+	border-left: 0.5rem solid #666;
+	color: #666;
+	box-shadow: 0px 3px 8px rgba(0, 0, 0, 0.3);
+}
+.suite-consolelog-header {
+	font-weight: bold;
+}
+.suite-consolelog-item {
+	padding: 0.5rem;
+}
+.suite-consolelog-item pre {
+	margin: 0;
+}
+.suite-consolelog-item-origin {
+	color: #aaa;
+	font-weight: bold;
+}
+.suite-consolelog-item-message {
+	font-size: 1rem;
+	padding: 0 0.5rem;
+}