Version 5.0.0

Major

• Updated Node.js support to ^14.17.0 || ^16.0.0 || >= 18.0.0.
• Updated dev dependencies, some of which require newer Node.js versions than previously supported.
• Removed the package main field.
• Use the node: URL scheme for Node.js builtin module imports.
• Migrated from the Node.js builtin module fs to node:fs/promises.

Patch

• 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.
• Tweaked formatting of a JSDoc comment.
• Revamped the readme:
  • Removed the badges.
  • Added a “Requirements” section.
  • Added information about TypeScript config and optimal JavaScript module design.

Version 4.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.
• Added a license.md MIT License file.

Version 4.0.1

Patch

• Moved @types/node from package devDependencies to dependencies, using * for the version.
• Updated dev dependencies.

Version 4.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 assertSnapshot.mjs and added it to the package exports field.
• Renamed the function snapshot to assertSnapshot.
• Renamed the function assertSnapshot argument 2 snapshotFilePath to snapshotFile, and allow it to also be a file URL instance.
• Added runtime argument type checks.
• Implemented TypeScript types via JSDoc comments.

Patch

• Simplified package scripts.
• Added a package docs-check script that checks the readme API docs are up to date with the source JSDoc.
• Check TypeScript types via a new package types script.
• Also run GitHub Actions CI with Node.js v17, and drop v15.
• Configured Prettier option singleQuote to the default, false.
• Improved tests.
• Documentation tweaks.

Version 3.0.0

Major

• Updated Node.js support to ^12.20 || >= 14.13.
• Updated dev dependencies, some of which require newer Node.js versions than were previously supported.
• Added a package exports field.
• The API is now ESM in .mjs files instead of CJS in .js files, accessible via import but not require.

Minor

• Added package sideEffects field.

Patch

• Stop using hard-rejection to detect unhandled Promise rejections in tests, as Node.js v15+ does this natively.
• Simplified the package scripts now that jsdoc-md v10 automatically generates a Prettier formatted readme.
• 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 Promise.all for faster tests.
• Tweak whitespace formatting.
• Readme tweaks.

Version 2.0.0

Major

• Updated Node.js support to ^10.17.0 || ^12.0.0 || >= 13.7.0.
• Updated dev dependencies, some of which require newer Node.js versions than previously supported.

Patch

• Ensure GitHub Actions CI runs on pull request.
• Also run GitHub Actions CI with Node.js v14 and v15, and not v13.
• Simplified the GitHub Actions CI config with the npm install-test command.
• Improved the package prepare:prettier and test:prettier scripts.
• Configured Prettier option semi to the default, true.
• Removed a now redundant ESLint rule config.
• Removed npm-debug.log from the .gitignore file as npm v4.2.0+ doesn’t create it in the current working directory.
• Use HTTPS in an .editorconfig comment URL.
• Use HTTPS in a URL within a snapshot function code example.
• Documented how to import and require the snapshot function.

Version 1.0.0

Initial release.