v9.0.0 Release Notes

[75lb]

The default output has not changed. The minimum required Node version is still v12.17. The goals of this release were bug fixing and simplification. Feel free to comment in the release discussion or post an issue.

Breaking changes since v8.0.3

• Removed .renderSync(), .getTemplateDataSync() and .getJsdocDataSync(). The jsdoc2md API is now async-only.
• Previously, passing either option.files or option.source was mandatory. Now, it is either option.files, option.source or option.configure. .files or .source options should be optional if .configure is set jsdoc-api#27

Non-breaking changes

• Fixed a bug where it was possible for a handlebars template to be passed into the jsdoc-api template option. command-line option "template" requires a value. #303
• Support clever-links, monospace-links, {@linkcode} and {@linkplain}. Add --clever-links and --monospace-links options #301
• Fixed a 'maximum call stack size exceeded' error. The user now gets a warning if the malformed input which formerly caused the error is detected. Maximum call stack size exceeded dmd#89
• Fixed an issue where the dmd internal partials failed to load if a user's directory name contained special glob characters. Handlebars Partials dmd#82
• Added the --EOL option to control line-endings. Fixes Respect line endings dmd#92.
• Fixed an issue where setting { pedantic: false } confused the underlying jsdoc. Explicitly setting pedantic to false generates error jsdoc-api#22
• Can now pass an array of strings to .source. allows options.source also to be an array of strings jsdoc-api#11
• Added support for @hideconstructor. @hideconstructor does not hide constructor dmd#94
• Print a warning when the most common mistake is detected (@module tag required) Add a warning when a common mistake is detected: @module tag required dmd#96
• Fixed an issue where a @example was excluded in the output if the doclet did not contain a description. Constructor documentation is ignored unless description or @param is included jsdoc-parse#33

Other improvements

• Greatly optimised the dependency tree - upgraded all deps to their latest versions (removing deprecation warnings) and factored many old modules out of the project.

Upgrade notes

• Update your code replacing any use of .renderSync(), .getTemplateDataSync() and .getJsdocDataSync() with their async equivalents.
  • To see an example of API usage, see here.

---

This discussion was created from the release v9.0.0.