Version 11.0.2

Patch

• Updated dependencies.
• Renamed remark related imports.

Version 11.0.1

Patch

• Updated dependencies.
• Use newly available dependency ESM imports, fixing #24.
• Account for the new comment-parser token lineEnd.
• Renamed imports in the test index module.
• Amended the changelog entries for v6.0.0, v7.0.0, and v10.2.0.

Version 11.0.0

Major

• Only insert a table of contents into the generated markdown if there’s multiple members.
• The heading “Table of contents” is no longer inserted before the table of contents in the generated markdown.

Patch

• Updated dependencies.
• Updated the GitHub Actions CI config to stop testing Node.js v15.
• Display the project logo in the readme.

Version 10.2.0

Minor

• Added a package sideEffects field.

Patch

• Updated dependencies.
• Fixed lint errors introduced by the updated Prettier version.
• Fixed JSDoc parameter or property tags without types or descriptions causing an exception when generating the markdown tables. Now, the “Type” and “Description” columns are only generated if at least one row has a type or description.
• Corrected the code location for JSDoc parameter and property tag default value invalid JSDoc type errors.
• Readme tweaks.
• The file changelog.md is no longer published.

Version 10.1.0

Minor

• Added a new --check (and alias -c) argument for the command jsdoc-md and a check option for the function jsdocMd to specify if an error should be thrown instead of updating the markdown file if the contents would change; useful for checking docs are up to date in CI. Fixes #22.

Patch

• Updated dev dependencies.
• The command jsdoc-md and the function jsdocMd no longer updates the markdown file if there are no changes.
• Simplified TypeError messages.
• Readme tweaks.

Version 10.0.1

Patch

• Updated dev dependencies.
• Added back JSDoc typedefs that were accidentally deleted in v10.0.0.
• Replaced the package prepare script with a jsdoc script.
• Tweaked the package description.
• Updated readme content.

Version 10.0.0

Major

• Updated Node.js support to ^12.20 || >= 14.13.
• Updated dependencies, some of which require newer Node.js versions than previously supported.
• The API is now ESM in .mjs files instead of CJS in .js files, accessible via import but not require.
• Replaced the the package.json exports field public subpath folder mapping (deprecated by Node.js) with a subpath pattern.
• By default also scape files with the .cjs file extension for JSDoc.
• If the optional peer dependency prettier is installed, the new markdown file contents is Prettier formatted.

Patch

• Also run GitHub Actions CI with Node.js v16.
• Use regex u mode.
• JSDoc comment ends (*/) escaped with a backslash (*\/) can now be escaped using additional backslashes (e.g. *\\/ unescapes to *\/).
• Tweaked a code example for the public function jsdocMd.
• v9.1.1 changelog entry tweak.

Version 9.1.1

Patch

• Updated dev dependencies.
• Account for the JSDoc comment fence when deriving the code locations for JSDoc inline tag @link namepath error messages, fixing #20.
• Exclude multiple newlines from the start and end of JSDoc markdown content.
• Exclude multiple newlines following a JSDoc tag @example caption from the content start.
• Disallow newlines between JSDoc inline tag @link parts.
• Removed the private function parseJsdocExample, moving functionality to the private function jsdocCommentToMember.
• Corrected JSDoc member code location end column numbers.
• Reordered tests.

Version 9.1.0

Minor

• Display the relevant source code file path and location in more JSDoc related error messages, fixing #19.
• Allow whitespace between JSDoc inline tag @link parts.

Patch

• Updated dependencies.
• Tweaked some tests.
• Internal JSDoc fixes.
• Use regex u mode when parsing JSDoc examples or scanning for JSDoc inline links in description markdown.
• Renamed several private functions.
• Internally, throw TypeError instead of Error for JSDoc type related errors.

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.