| 1 | # coverage-node changelog
|
| 2 |
|
| 3 | ## 5.0.1
|
| 4 |
|
| 5 | ### Patch
|
| 6 |
|
| 7 | - Updated dependencies.
|
| 8 | - Added a package `test:jsdoc` script that checks the readme API docs are up to date with the source JSDoc.
|
| 9 | - Readme tweaks.
|
| 10 |
|
| 11 | ## 5.0.0
|
| 12 |
|
| 13 | ### Major
|
| 14 |
|
| 15 | - Updated supported Node.js versions to `^12.20 || >= 14.13`.
|
| 16 | - Updated dependencies, some of which require newer Node.js versions than previously supported.
|
| 17 | - The API is now ESM in `.mjs` files instead of CJS in `.js` files, [accessible via `import` but not `require`](https://nodejs.org/dist/latest/docs/api/esm.html#esm_require).
|
| 18 | - Replaced the the `package.json` `exports` field public [subpath folder mapping](https://nodejs.org/api/packages.html#packages_subpath_folder_mappings) (deprecated by Node.js) with a [subpath pattern](https://nodejs.org/api/packages.html#packages_subpath_patterns).
|
| 19 |
|
| 20 | ### Patch
|
| 21 |
|
| 22 | - Simplified the package scripts now that [`jsdoc-md`](https://npm.im/jsdoc-md) v10 automatically generates a Prettier formatted readme.
|
| 23 | - Always use regex `u` mode.
|
| 24 | - Stop using [`hard-rejection`](https://npm.im/hard-rejection) to detect unhandled `Promise` rejections in tests, as Node.js v15+ does this natively.
|
| 25 | - Improved the test helper function `replaceStackTraces`.
|
| 26 | - Refactored unnecessary template strings.
|
| 27 | - Updated GitHub Actions CI config:
|
| 28 | - Also run tests with Node.js v16.
|
| 29 | - Updated `actions/checkout` to v2.
|
| 30 | - Updated `actions/setup-node` to v2.
|
| 31 | - Don’t specify the `CI` environment variable as it’s set by default.
|
| 32 |
|
| 33 | ## 4.0.0
|
| 34 |
|
| 35 | ### Major
|
| 36 |
|
| 37 | - The updated [`kleur`](https://npm.im/kleur) dependency causes subtle differences in which environments get colored console output.
|
| 38 |
|
| 39 | ### Minor
|
| 40 |
|
| 41 | - Added runtime argument type checks for various private and public functions.
|
| 42 | - Improved console output for `coverage-node` CLI errors.
|
| 43 |
|
| 44 | ### Patch
|
| 45 |
|
| 46 | - Updated dependencies.
|
| 47 | - Also test Node.js v15 in GitHub Actions CI.
|
| 48 | - Simplified the GitHub Actions CI config with the [`npm install-test`](https://docs.npmjs.com/cli/v7/commands/npm-install-test) command.
|
| 49 | - Removed `npm-debug.log` from the `.gitignore` file as npm [v4.2.0](https://github.com/npm/npm/releases/tag/v4.2.0)+ doesn’t create it in the current working directory.
|
| 50 | - Removed an extra space character from the `coverage-node` CLI error message when coverage is enabled.
|
| 51 | - Use the `FORCE_COLOR` environment variable in tests to ensure output is colorized.
|
| 52 | - Use a new [`snapshot-assertion`](https://npm.im/snapshot-assertion) dev dependency to snapshot test CLI output.
|
| 53 | - Replaced the `stripStackTraces` test helper with a smarter `replaceStackTraces` helper that allows tests to detect a missing stack trace.
|
| 54 | - Use `spawnSync` from the Node.js `child_process` API instead of the `execFilePromise` helper in tests.
|
| 55 | - Added more `coverage-node` CLI tests.
|
| 56 | - Improved internal JSDoc.
|
| 57 | - Updated SLOC and install size related documentation.
|
| 58 |
|
| 59 | ## 3.0.0
|
| 60 |
|
| 61 | ### Major
|
| 62 |
|
| 63 | - Updated supported Node.js versions to `^10.17.0 || ^12.0.0 || >= 13.7.0`.
|
| 64 | - Updated dependencies, some of which require newer Node.js versions than were previously supported.
|
| 65 | - Added a [package `exports` field](https://nodejs.org/api/esm.html#esm_package_entry_points) with [conditional exports](https://nodejs.org/api/esm.html#esm_conditional_exports) to support native ESM in Node.js and keep internal code private, [whilst avoiding the dual package hazard](https://nodejs.org/api/esm.html#esm_approach_1_use_an_es_module_wrapper). Published files have been reorganized, so previously undocumented deep imports will need to be rewritten according to the newly documented paths.
|
| 66 |
|
| 67 | ### Patch
|
| 68 |
|
| 69 | - Updated Prettier config and scripts.
|
| 70 | - Added ESM related keywords to the package `keywords` field.
|
| 71 | - Updated ESLint config to match the new Node.js version support.
|
| 72 | - Moved reading `process.argv` into the `coverageNode` function scope.
|
| 73 | - Improved a JSDoc return type.
|
| 74 | - Ensure GitHub Actions run on pull request.
|
| 75 | - Test with Node.js v14 instead of v13.
|
| 76 | - Updated EditorConfig.
|
| 77 |
|
| 78 | ## 2.0.3
|
| 79 |
|
| 80 | ### Patch
|
| 81 |
|
| 82 | - Updated dev dependencies.
|
| 83 | - Added a new [`hard-rejection`](https://npm.im/hard-rejection) dev dependency to ensure unhandled rejections in tests exit the process with an error.
|
| 84 | - Destructured `assert` imports.
|
| 85 | - Moved the `execFilePromise` helper from the `/lib` directory to `/test`, reducing the install size.
|
| 86 |
|
| 87 | ## 2.0.2
|
| 88 |
|
| 89 | ### Patch
|
| 90 |
|
| 91 | - Allow a line to contain both code and a coverage ignore next line comment.
|
| 92 | - Simplified `test/index.js`.
|
| 93 |
|
| 94 | ## 2.0.1
|
| 95 |
|
| 96 | ### Patch
|
| 97 |
|
| 98 | - Updated dev dependencies.
|
| 99 | - Added a new [`disposable-directory`](https://npm.im/disposable-directory) dependency to simplify the implementation and tests.
|
| 100 | - Moved JSDoc comments above module exports code.
|
| 101 | - Updated the compared [`c8` install size](https://packagephobia.com/result?p=c8@7.0.0), fixing [#1](https://github.com/jaydenseric/coverage-node/issues/1).
|
| 102 |
|
| 103 | ## 2.0.0
|
| 104 |
|
| 105 | ### Major
|
| 106 |
|
| 107 | - The `coverage-node` CLI now skips code coverage when Node.js < v13.3 and displays an explanatory message in place of a code coverage report.
|
| 108 | - Removed the `nodeWithCoverage` function.
|
| 109 |
|
| 110 | ### Minor
|
| 111 |
|
| 112 | - New `coverageSupported` and `coverageSupportedMinNodeVersion` constants are exported.
|
| 113 |
|
| 114 | ### Patch
|
| 115 |
|
| 116 | - Additionally test Node.js v10 and v12 in CI.
|
| 117 | - Updated the comparison install size in the readme for [`nyc@15.0.0`](https://packagephobia.com/result?p=nyc@15.0.0).
|
| 118 |
|
| 119 | ## 1.1.0
|
| 120 |
|
| 121 | ### Minor
|
| 122 |
|
| 123 | - Added a new `filesCount` field to the code coverage analysis resolved by the `analyseCoverage` function.
|
| 124 |
|
| 125 | ### Patch
|
| 126 |
|
| 127 | - Fixed the total number of files in the report summary sometimes being too big.
|
| 128 |
|
| 129 | ## 1.0.1
|
| 130 |
|
| 131 | ### Patch
|
| 132 |
|
| 133 | - Updated the [`eslint-config-env`](https://npm.im/eslint-config-env) dev dependency.
|
| 134 | - Only test Node.js v13 in CI as earlier versions produce flawed coverage data.
|
| 135 | - Updated the support documentation to recommend Node.js v13.3+.
|
| 136 | - Corrected the temporary directory paths created by the `createTempDir` function.
|
| 137 | - The `tempDirOperation` function now checks the temporary directory path was created before attempting to remove it in the cleanup phase.
|
| 138 | - `fsPathRemove` function improvements:
|
| 139 | - Reject with an error if the provided path is not a string.
|
| 140 | - Use `rm -rf` instead of `rm -r` so that it doesn’t error when the path doesn’t exist.
|
| 141 | - Tweaked test fixture formatting.
|
| 142 |
|
| 143 | ## 1.0.0
|
| 144 |
|
| 145 | Initial release.
|
| 146 | |
| \ | No newline at end of file |