Skip to content

Version 4.0.0

Latest
Compare
Choose a tag to compare
@jaydenseric jaydenseric released this 25 May 03:26
· 32 commits to master since this release

Major

  • Updated Node.js support to ^12.20 || >= 14.13.
  • Stopped supporting Internet Explorer.
  • Updated dev dependencies, some of which require newer Node.js versions than were previously supported.
  • Removed the package module field.
  • Added a package exports field with conditional exports to support native ESM in Node.js and keep internal code private, whilst avoiding the dual package hazard. Published files have been reorganized, so previously undocumented deep imports will need to be rewritten according to the newly documented paths.
  • Removed Babel related dev dependencies, config, and scripts. Published modules now contain more modern ES syntax.
  • Published modules now contain JSDoc comments, which might affect TypeScript projects.
  • Added a package test:api script to test the API, using coverage-node, test-director, and ESM in .mjs files.

Patch

  • Updated GitHub Actions CI config:
    • Also run on pull request.
    • Run tests with Node.js v12, v14, v16.
    • Updated actions/checkout to v2.
    • Updated actions/setup-node to v2.
    • Use the simpler npm install-test command.
    • Don’t specify the CI environment variable as it’s set by default.
  • Simplified JSDoc related package scripts now that jsdoc-md v10+ automatically generates a Prettier formatted readme.
  • Added a package test:jsdoc script that checks the readme API docs are up to date with the source JSDoc.
  • Improved the package test:prettier script.
  • Reordered the package test:eslint script args.
  • Test the bundle size manually using esbuild and gzip-size, removing size-limit related dev dependencies, config, and scripts.
  • Configured Prettier option semi to the default, true.
  • Removed npm-debug.log from the .gitignore file as npm v4.2.0+ doesn’t create it in the current working directory.
  • Added .DS_Store to the .gitignore file.
  • Updated the EditorConfig.
  • Documentation tweaks.
  • The file changelog.md is no longer published.