Version 5.0.0

Major

• Support Node.js v10+, from v8+.
• Updated the globby dependency to v10, which may affect how the jsdoc-md command --source-glob argument and jsdocMd function sourceGlob option work.
• Replaced the yargs dependency with arg, for a smaller install size. This affects the jsdoc-md command:
  • The --help/-h argument is gone.
  • The --version/-v argument is gone.
  • Short arguments can’t be used with = (e.g. jsdoc-md -m readme.md works, jsdoc-md -m=readme.md doesn’t), see zeit/arg#51.
  • Behavior using quotes around argument values may have changed.

Minor

• Added a new cwd option for the jsdocMd function.
• Setup GitHub Sponsors funding:
  • Added .github/funding.yml to display a sponsor button in GitHub.
  • Added a package.json funding field to enable npm CLI funding features.

Patch

• Updated dependencies.
• Removed the now redundant eslint-plugin-import-order-alphabetical dev dependency.
• Stop using husky and lint-staged.
• Replaced the tap dev dependency with test-director and coverage-node, refactoring the tests accordingly. This vastly reduces the dev install size.
• Replaced the deprecated circular-json dev dependency with flatted.
• Added a new disposable-directory dev dependency, using it to replace the createTestFile helper and improve tests.
• Added a new hard-rejection dev dependency to ensure unhandled rejections in tests exit the process with an error.
• Test the CLI.
• Use strict mode for scripts.
• Use less arrow functions for better stack traces.
• Replaced every forEach loop with for of.
• More consistent module exports style.
• Removed package-lock.json from .gitignore and .prettierignore as it’s disabled in .npmrc anyway.
• Added a package main field and moved the index and bin files.
• Use GitHub Actions instead of Travis for CI.
• Simplified the readme “Setup” section.
• Improved CLI docs with examples.
• Documented how files are excluded via .gitignore.