Skip to content

Latest commit

 

History

History
251 lines (199 loc) · 11.4 KB

CHANGELOG.md

File metadata and controls

251 lines (199 loc) · 11.4 KB

mochawesome changelog

5.0.0 - 2020-02-25

Changed

  • BREAKING Drop support for node 8
  • BREAKING Requies mocha 7+

Fixed

  • Ensure a stats collector is always initialized
  • Omit code snippets from JSON when code option is false

4.1.0 - 2019-08-06

Added

  • New consoleReporter option to allow specifying console reporter to use or disabling console reporter entirely #99

4.0.1 - 2019-06-15

Fixed

  • Issue where using addContext inside a before or after hook would incorrectly apply context to the test #284

4.0.0 - 2019-06-04

Changed

  • Drop support for Node <8
  • Require peer dependency of mocha >5
  • Removed Babel dependency
  • Replace lodash dependency with individual modules
  • Updated codeclimate config to version 2
  • Updated various dependencies
  • Breaking changes to JSON data structure
    • Renamed allSuites to results and made it an array of suites
    • Removed isRoot property from cleaned tests (only suites can be a root)
    • Removed class-related stats (passPercentClass, pendingPercentClass)
    • Added uuid to suites
    • Removed rounding of passPercent and pendingPercent
    • Removed copyrightYear property
    • Added new meta property to track info about the test run (useful for debugging)

3.1.2 - 2019-04-17

Fixed

  • Issue where a suite with skipped tests reports duration as 0. #276

3.1.1 - 2018-10-22

Changed

  • Switch from RegExp to state machine for stripping function start in cleanCode method. #257

3.1.0 - 2018-10-17

Changed

  • Invert logic for getting test code by checking for test.body before test.fn inside cleanTest method #252

3.0.3 - 2018-07-25

Changed

  • Reworked cleanCode regexes to handle more cases #244

3.0.2 - 2018-01-25

Changed

  • Call stripAnsi for test/suite titles. #223 (@JoeTheFkingFrypan)

3.0.1 - 2017-12-26

Fixed

  • Updated RegExp in cleanCode method to handle arrow functions without braces. #220

3.0.0 - 2017-11-30

This release is in tandem with and requires mochawesome-report-generator >= 3.0.0.

Added

  • New option: html. Allows user to specify whether or not to generate the HTML report. Defaults to true.

Changed

  • BREAKING: This release features a trimmed-down data output that removes properties that are not necessary for the report generation. This change will only affect things that consume the JSON output and does not affect usage of the reporter itself.

  • Suites are now cleaned by mapping over them instead of a breadth-first traversal

  • Options handling was overhauled and greatly simplified. The reporter will only concern itself with options directly related to the reporter. All other options are passed through to the report generator as-is.

  • Updated the done function to display better output when only one or no files have been generated.

Removed

  • enableTestCode option was deprecated as of 2.0.3 and has been removed. Use enableCode instead.
  • Fixes an issue where generator functions were not displayed properly #188 (@APshenkin)
  • Added showHooks option #168
  • Support mocha's --inline-diffs option #167
  • Normalize error objects for consistent display #166
  • Bumped mochawesome-report-generator dependency to 2.2.0
  • Separated out before and after hooks
  • Bumped mochawesome-report-generator dependency to 2.1.0
  • Enable using addContext in beforeEach and afterEach test hooks
  • Fix a bug where you could pass an object with empty title string to addContext
  • Allow a context value of undefined to be displayed in the report
  • Added new options: overwrite and timestamp
  • Fix UnhandledPromiseRejectionWarning error when calling nonexistant exit function
  • Limit files included in package
  • Better handling of different coding styles in test code. #98
  • Separate utility functions from main reporter code for better test coverage
  • Bump mochawesome-report-generator and fs-extra packages
  • Fixed #126
  • Fix default options handling
  • Add enableCode option to be consistent with mochawesome-report-generator options
  • Deprecate enableTestCode option
  • Add dev option for testing
  • Fixed an issue where reportFilename was not propagated to config object
  • Updated handling of reportDir option to allow relative paths
  • Bumped mochawesome-report-generator dependency (requires 1.0.3 or higher)
  • Moved report generation to mochawesome-report package
  • Updated dependencies
  • Switched from jshint to eslint
  • Rewritten using ES6
  • Fixed an issue where test uuid was not generated properly
  • Added done function that will get called before mocha exits (eliminates need for --no-exit option)
  • Unit tests!
  • Added diff for test error
  • Added ability to display additional test context

Breaking Changes

  • reportName option changed to reportFilename
  • Run pending tests thru cleanTest function. Fixes possible scenario where a pending test with a large amount of text could cause node to run out of memory. See #94
  • Fixed build issues on Windows. See #84
  • Updated mocha peerDependency to allow any version
  • Added missing LICENSE.md file
  • Moved mocha to peerDependencies and devDependencies and fixed it to ~2. See #69
  • Added slide-over navigation menu for quickly jumping to a test suite. See #49
  • Removed extra slash in @font-path LESS variable. See #53
  • Added option to auto open report. Also fixed an issue with boolean options. See #44
  • Added support for creating custom dir where the parent dir(s) may not exist yet. See #40
  • Removed allHooks array since it was not being used and could lead to an issue where node runs out of memory while rendering the template. See #33
  • Update copyright in template
  • Changes to support mocha 2.4.0 and later (fixes empty code blocks). See #29
  • Added option to generate report with all assets inlined. See #26
  • Reset totalTestsRegistered when reporter is run. PR #21
  • Enhancement: custom report title option. Closes #11
  • Fixed indentation in code block and stack traces
  • Add filter icon in summary for better visibility (Completely new idea and not at all in response to this)
  • Change util.print to console.log due to deprecation
  • Add support for options
    • custom report directory
    • custom report filename
  • Enhancements to console output

1.0.1 - 1.0.5

  • Bugfixes
  • Redesigned report
  • Mobile friendly
  • Complete refactor of client-side script
  • Custom builds of vendor scripts
  • Custom font-icon set
  • All fonts are now local to the report