Version 11.0.0

Major

• Updated Node.js support to ^16.9.0 || >= 18.0.0.
• Tests now report a thrown AggregateError instance property errors.
• Tests now report a thrown Error instance property cause.

Patch

• Updated dev dependencies.
• Use test-director as a dev dependency for tests.
• Updated GitHub Actions CI config:
  • Run tests with Node.js v16, v18, v19.
• Improved the installation instructions in the readme.
• Remove node-fetch from code examples. Modern Node.js supports the fetch global.

Version 10.0.0

Major

• Removed the package main field.
• Use the node: URL scheme for Node.js builtin module imports.

Patch

• Updated dev dependencies.

Version 9.0.0

Major

• Updated Node.js support to ^14.17.0 || ^16.0.0 || >= 18.0.0.

Patch

• Updated dependencies.
• Removed the @types/stack-utils and stack-utils dependencies; error details are now output in a much simpler and more reliable way.
• Added a new replace-stack-traces dev dependency for replacing error stack traces in test snapshots, and removed the test helper function simulatePublishedTraces.
• Updated jsconfig.json:
  • Set compilerOptions.maxNodeModuleJsDepth to 10.
  • Set compilerOptions.module to nodenext.
• Updated ESLint config.
• Updated GitHub Actions CI config:
  • Run tests with Node.js v14, v16, v18.
  • Updated actions/checkout to v3.
  • Updated actions/setup-node to v3.
• Removed redundant JSDoc @ignore tags.
• Revamped the readme:
  • Removed the badges.
  • Added information about TypeScript config and optimal JavaScript module design.

Version 8.0.2

Patch

• Updated dev dependencies.
• Simplified dev dependencies and config for ESLint.
• Removed the jsdoc-md dev dependency and the related package scripts, replacing the readme “API” section with manually written “Examples” and “Exports” sections.
• Updated jsconfig.json to disable TypeScript automatic type acquisition for the project.
• Moved the test index module.
• Added a license.md MIT License file.

Version 8.0.1

Patch

• Moved @types/node from package devDependencies to dependencies, using * for the version.
• Moved @types/stack-utils from package devDependencies to dependencies.

Version 8.0.0

Major

• Updated Node.js support to ^12.22.0 || ^14.17.0 || >= 16.0.0.
• Updated dev dependencies, some of which require newer Node.js versions than previously supported.
• Removed ./package from the package exports field; the full package.json filename must be used in a require path.
• Renamed index.mjs to TestDirector.mjs and added it to the package exports field.
• Implemented TypeScript types via JSDoc comments.

Patch

• Simplified package scripts.
• Check TypeScript types via a new package types script.
• Stopped using the kleur chaining API.
• Configured Prettier option singleQuote to the default, false.
• Fixed a JSDoc example code bug.
• Documentation tweaks.

Version 7.0.0

Major

• Updated Node.js support to ^12.20.0 || ^14.13.1 || >= 16.0.0.
• Updated dev dependencies, some of which require newer Node.js versions than previously supported.

Patch

• Updated dependencies.
• Replaced the package prepare script with a jsdoc script.
• Added a package test:jsdoc script that checks the readme API docs are up to date with the source JSDoc.
• Also run GitHub Actions CI with Node.js v17, and drop v15.
• Prevent outputting the Node.js internal async Promise.all (index 0) error stack frame generated by recent Node.js versions that stack-utils fails to clean, (see tapjs/stack-utils#63).
• Readme tweaks.

Version 6.0.0

Major

• Updated Node.js support to ^12.20 || >= 14.13.
• The API is now ESM in .mjs files instead of CJS in .js files, accessible via import but not require.
• The TestDirector class is now only accessible via a default import from the main index.
• The TesDirector instance method add now throws a TypeError if argument 1 name is not a string.

Patch

• Updated dependencies.
• Stop using hard-rejection to detect unhandled Promise rejections in tests, as Node.js v15+ does this natively.
• Updated GitHub Actions CI config:
  • Also run tests with Node.js v16.
  • Updated actions/checkout to v2.
  • Updated actions/setup-node to v2.
  • Don’t specify the CI environment variable as it’s set by default.
• Use the regex flag u.
• The TesDirector instance method add now throws a more specific TypeError if argument 2 test is not a function.
• Stop snapshot testing major Node.js versions separately, as they all produce the same results now.
• Changed the snapshot-assertion link in the readme from GitHub to npm.
• Recommend coverage-node in the readme.
• Prettier formatting fix for a code example.
• Whitespace formatting tweaks.
• Linked Node.js in the readme.

Version 5.0.0

Major

• Updated supported Node.js versions to ^10.17.0 || ^12.0.0 || >= 13.7.0.
• Updated dependencies, some of which require newer Node.js versions than were previously supported.
• The updated kleur dependency causes subtle differences in which environments get colored console output.
• Published files have been reorganized, so previously supported deep imports will need to be rewritten according to the newly documented paths.
• Removed the package module field.
• The summary message when tests fail now outputs using stderr via console.error instead of using stdout via console.info.

Patch

• Removed Node.js v13 and added v15 to the versions tested in GitHub Actions CI.
• Simplified the GitHub Actions CI config with the npm install-test command.
• Updated the EditorConfig.
• Use destructuring for require of the Node.js path API in tests.
• Use the FORCE_COLOR environment variable in tests to ensure output is colorized.
• Use the .ans file extension for snapshot text files containing ANSI colorization.
• Removed npm-debug.log from the .gitignore file as npm v4.2.0+ doesn’t create it in the current working directory.
• When tests fail and the throwOnFailure option is used, don’t set the process exit code to 1.
• Tweaked the order of ANSI escape codes in messages so modifiers come before colors.

Version 4.0.1

Patch

• Updated dependencies.
• Updated Node.js support to 10 - 12 || >= 13.7 to reflect the package exports related breaking changes.
• Updated the package exports field to allow requiring package.json and specific deep imports.
• Also run GitHub Actions with Node.js v14.
• Use snapshot-assertion for snapshot tests.
• Mention snapshot-assertion in the readme.
• Improved the package prepare:prettier and test:prettier scripts.
• Configured Prettier option semi to the default, true.