Version 9.0.0

Major

• The function jsdocMd is now async and should be faster.

Minor

• Added support for more JSDoc tags (some are aliases for already supported tags):
  • @arg
  • @argument
  • @callback
  • @desc
  • @description
  • @property
  • @return
  • @typedef
• Display the relevant source code file path and location in JSDoc namepath related error messages, using new kleur and @babel/code-frame dependencies.
• Improved console output for jsdoc-md CLI errors.
• Added runtime argument type checks for the function jsdocMd.

Patch

• Update dependencies.
• Use unist-util-remove-position to remove undesirable position data from the markdown AST that the private function mdToMdAst returns.
• Removed dynamicImport and objectRestSpread plugins from the Babel parser config, as they are enabled by default nowadays.
• Fixed the function jsdocMd option cwd causing ENOENT filesystem errors.
• Fixed the generated markdown headings for various kinds of nested members:
  • Inner members of classes of kind member are now labeled member instead of property.
  • Inner members of non-classes are now labeled inner.
  • Inner typedefs are now labeled type instead of typedef, consistent with non-inner typedefs.
• Fixed mixed absent and present event: prefixes in sibling event names in source JSDoc causing incorrect sorting of events in generated markdown.
• Use the SyntaxError class instead of Error for when deconstructJsdocNamepath can’t deconstruct an invalid namepath.
• Renamed the private function jsdocCommentsFromCode to codeToJsdocComments.
• Made the private function codeToJsdocComments async.
• Made the private function mdFileReplaceSection async.
• Added runtime argument type checks for various private functions.
• Renamed the private function jsdocToMember to jsdocCommentToMember.
• Configured the JSDoc parser to not accept a name part for a type tag.
• Rewrote a lot of the implementation for better performance.
• Use backticks (`) to quote values in error messages instead of typographic double quotes (“/”).
• Renamed the private remarkStringifyOptions module to REMARK_STRINGIFY_OPTIONS and added JSDoc.
• Use Array<> JSDoc type syntax instead of [].
• Improved the internal JSDoc.
• Improved tests.
• Stop using hard-rejection to detect unhandled Promise rejections in tests, as Node.js v15+ does this natively.
• Updated GitHub Actions CI config:
  • Updated actions/checkout to v2.
  • Updated actions/setup-node to v2.
  • Don’t specify the CI environment variable as it’s set by default.