changelogs.md


karma-runner/karma-coverage

Repository  -  API  -  Source

2.2.0

February 10, 2022

Features

  • update Istanbul packages (24aac11)

2.1.1

February 5, 2022

Bug Fixes

2.1.0

December 1, 2021

Bug Fixes

  • deps: update main and dev dependencies (c20d982)

Features

  • reporter: log coverage threshold as a warning fixed #432 (a6c95d8)

2.0.3

July 24, 2020

Bug Fixes

  • report: waiting promise resolve in onExist method fix #418 (c93f061)

2.0.2

April 13, 2020

Bug Fixes

  • reporter: update calls to match new API in istanbul-lib-report fix #398 (#403) (4962a70)
  • remove information about old istanbul lib (#404) (5cf931a)

2.0.1

August 20, 2019

2.0.0

August 20, 2019

Bug Fixes

  • build: Update to lodash 4 (d6d21d2), closes #242
  • reporter: replace colons in the output path (3b2bffa)
  • bump lodash for CVE-2018-16487 (15f8b12)

Chores

BREAKING CHANGES

  • deps: This set of changes may impact some use cases.

  • chore: Add Updated Istanbul Dependencies

The istanbul package is deprecated in favor several split packages that control different aspects of how istanbul works. This commit adds the recommended packages that will be used in future commits as karma-coverage's usage of istanbul is updated to the latest api.

  • refactor(reporter): Follow new report API

This commit refactors the in memory report implementation to use the new istanbul report API.

Report creation is removed from newer versions of the istanbul API, so this commit adds a set of utility functions to wrap around the new API and provide similar functionality as the old API. The top level export uses the new utility function to register the in-memory report.

  • refactor(preprocessor): Switch to istanbul-lib-instrument

This commit updates the preprocessor to use istanbul-lib-instrument instead of the deprecated istanbul package. The biggest change in this refactor is using a callable function instead of a constructor when creating instrumenters

The old istanbul package exposed the Instrumenter directly, allowing the preprocessor to create an instance of it. istanbul-lib-instrument, however, exposes a callable function that creates an Instrumenter. This commit updates the preprocessor to follow this new pattern of using a callable function. In order to ensure backwards compatibility, a utility function is added to wrap constructors with a callable function for creation automatically.

This change allows the following configuration for creating instrumenters:

  1. An object that contains an Instrumenter constructor
  2. An Instrumenter constructor itself
  3. A callable function that returns an Instrumenter instance.

This commit also uses the istanbul-lib-source-maps package to handle storing source maps. A global source map store registers source maps so they can be used later on in the reporter.

  • refactor(reporter): Switch to istanbul-lib-coverage

This commit updates the reporter by using the istanbul-lib-coverage package api for handling coverage checking/management and the istanbul-lib-report package api for handling reporting.

The new apis remove the need for collectors and remove the need to handle disposing collectors.

  • refactor: Remove unused source cache utilities

This commit removes the source-cache-store and source-cache files as they are no longer being used. The source-map-store and istanbul-lib-source-maps are used instead, so these files are no longer needed.

  • feat(util): Add Reset Functionality

This commit updates the report creator utility to allow resetting the custom reporter map.

  • fix(preprocessor): Track Coverage Maps Properly

This commit updates the preprocessor to properly access file coverage when storing it in the global coverage map (when includeAllSources is true). The previous method did not work because the returned instrumented code from the default istanbul instrumenter returns the coverage map in a POJO object instead of JSON notation. This breaks the coverage regex used to match and parse the coverage map.

The istanbul instrumenter offers the ability to receive the coverage map for the last instrumented file through a separate function, so that is tested for and used if it is supported. The original method is used as a fallback for backwards compatibility.

This commit also addresses changes from the v0 instanbul instrumenter options. The changes are additive only to maintain backwards compatibility for other instrumenters.

  • fix(reporter): Access Data Properly to Check Coverage

This commit fixes errors with accessing data properly during the checkCoverage method. A previous commit updated the implementation to use istanbul-lib-coverage, but this involved an api change to access the raw coverage data (which checkCoverage uses).

This commit also fixes the checking coverage for each file by using a map to store file coverage summaries instead of merging summaries like the global results. Per file coverage now works as expected.

  • test: Update Unit Tests to use new Istanbul API

This commit updates the mocking done in unit tests to properly mock the new istanbul API. Additionally, new unit test suites are added for the utility methods report-creator and source-map-store.

  • drop support for node < 8
  • reporter: the output folder names change, they no longer contain :

1.1.2

May 3, 2018

Bug Fixes

  • build: Update to lodash 4 (d6d21d2), closes #242
  • reporter: replace colons in the output path (3b2bffa)

BREAKING CHANGES

  • reporter: the output folder names change, they no longer contain :

1.1.1

July 23, 2016

Bug Fixes

  • remove usage of the deprecated helper._ (dacf9e9)

1.1.0

July 7, 2016

Features

  • reporter: Add callbacks for "writeReport" and "onExit" methods (7e20759)

1.0.0

May 4, 2016

0.5.5

March 7, 2016

Bug Fixes

  • in-memory-reporter: Fix bug in new InMemoryReport, now using null-checks (051cffd)

0.5.4

March 3, 2016

Bug Fixes

  • preprocessor: Call done with error message instead of populating instrumentedCode (c56e4de)
  • preprocessor: Support CoffeeScript when using RequireJS (e941e0c), closes #177
  • preprocessor: Use _.includes instead of _.contains (3c769d5), closes #212

0.5.3

October 20, 2015

Bug Fixes

  • Update (dev)dependencies, include missing peer dependency and fix linter errors (bb73158)

0.5.2

September 8, 2015

Bug Fixes

  • preprocessor: Reset coverageObjRegex before each use (ef3f45c)

0.5.1

August 28, 2015

Bug Fixes

  • preprocessor: Change paths in windows to use backslash (b0eecbe), closes #178
  • preprocessor: Resolve all paths properly (098182f), closes #65

0.5.0

August 6, 2015

Bug Fixes

  • preprocessor: use absolute paths (27e0b09)

<a name"0.4.2">

0.4.2

June 12, 2015

Bug Fixes

  • preprocessor: Use _.contains instead of _.includes to avoid braking with lodash@2 (411beb1f)

<a name"0.4.1">

0.4.1

June 9, 2015

Features

  • preprocessor: Add sourcemap support (de3b738b, closes #109)
  • reporter: add check coverage thresholds (bc63b158, closes #21)

<a name"0.4.0">

0.4.0

June 9, 2015

Bug Fixes

  • Drop karma from peerDependencies (eebcc989)
  • do not dispose collectors before they are written (9816cd14)
  • reporter allow using a externally provided source cachere for reporters change ` (781c126f)
  • watermarks are not passed to reporters (a9044055, closes #143, #144)
  • when using browserify dont create source code caching (50030df1)

Breaking Changes

<a name"0.3.1">

0.3.1

June 9, 2015

Bug Fixes

  • skip directory creation when reporting to console (42c9e0a8, closes #24)

Features

  • adding support for including all sources in coverage data (18091753)

<a name"0.3.0">

0.3.0

June 9, 2015

Features

Breaking Changes

  • Karma-coverage does not ship with additional instrumenter. You need to explicitly install the instrumenter you need.

Removed Ibrik instrumenter that need to be installed explicitly.

Quick list of known community instrumenters :

  • Ibrik (CoffeeScript files instrumenter).

  • Ismailia (ES6 files instrumenter using Traceur).

  • Isparta (ES6 files instrumenter using 6to5).

    (626e7b0c)

<a name"0.2.7">

0.2.7

June 9, 2015

Bug Fixes

  • add in-memory source code caching to support detail reports on compiled CoffeeSc (c1e542a5)

<a name"0.2.6">

0.2.6

June 9, 2015

Bug Fixes

  • reporters can be configured individually (adcb8e69)

<a name"0.2.5">

0.2.5

June 9, 2015

Features

<a name"0.2.4">

0.2.4

June 9, 2015

Bug Fixes

  • optional option no longer trigger an error when omitted (a2cdf569)

<a name"0.2.3">

0.2.3

June 9, 2015

Features

  • config: instrumenter override option (ee3e68e8)

<a name"0.2.2">

0.2.2

June 9, 2015

Features

<a name"0.2.1">

0.2.1

June 9, 2015

Features

  • update istanbul to 0.2.3, ibrik to 1.1.1 (9064ec1e)

<a name"0.2.0">

0.2.0

June 9, 2015

Features

  • no longer write json unless configured (1256fb8b)

Breaking Changes

  • No json coverage is generated by default. If you want that, please use json reporter:
coverageReporter: {
  type: 'json'
}

// or with multiple reporters
coverageReporter: {
  reporters: [
    {type: 'html', dir: 'coverage'},
    {type: 'json', dir: 'coverage'},
  ]
}

(1256fb8b)

<a name"0.1.5">

0.1.5

June 9, 2015

Bug Fixes

Features

<a name"0.1.4">

0.1.4

June 9, 2015

Features

<a name"0.1.3">

0.1.3

June 9, 2015

Bug Fixes

  • update to work with Karma 0.11 (89c98177)

Features

  • update instanbul (24126e72)
  • support coverage for coffee script (9f802c1c)
  • log where the coverage reports are generated (c9ef5c9f)
  • add a default config and normalize outputFile path (027fa4fc)

<a name"0.1.2">

0.1.2

June 9, 2015

<a name"0.1.1">

0.1.1

June 9, 2015

Bug Fixes

  • update to work with Karma 0.11 (b744d6f2)

<a name"0.1.0">

0.1.0

June 9, 2015

<a name"0.0.5">

0.0.5

June 9, 2015

Bug Fixes

  • delay collector disposal until all file writing has completed. (75c4db0e)

Features

  • allow multiple report types (4a9afb62)

<a name"0.0.4">

0.0.4

June 9, 2015

Features

  • do not preprocess files if coverage reporter is not used (277a1ad9, closes #7)

<a name"0.0.3">

0.0.3

June 9, 2015

Bug Fixes

Features

<a name"0.0.2">

0.0.2

June 9, 2015
  • Initial release