search

mseminatore / TeslaJS

An Unofficial Tesla API library for NodeJS
https://www.teslajs.org
MIT License
411 stars 102 forks source link

Bump jsdoc-to-markdown from 8.0.1 to 9.0.1 #374

Closed dependabot[bot] closed 1 month ago

dependabot[bot] commented 2 months ago

Bumps jsdoc-to-markdown from 8.0.1 to 9.0.1.

Release notes

Sourced from jsdoc-to-markdown's releases.

v9.0.0

The default output has not changed. The minimum required Node version is still v12.17. The goals for 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. jsdoc2md/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. #303
  • Support clever-links, monospace-links, {@linkcode} and {@linkplain}. #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. jsdoc2md/dmd#89
  • Fixed an issue where the dmd internal partials failed to load if a user's directory name contained special glob characters. jsdoc2md/dmd#82
  • Added the --EOL option to control line-endings. Fixes jsdoc2md/dmd#92.
  • Fixed an issue where setting { pedantic: false } confused the underlying jsdoc. jsdoc2md/jsdoc-api#22
  • Can now pass an array of strings to .source. jsdoc2md/jsdoc-api#11
  • Added support for @hideconstructor. jsdoc2md/dmd#94
  • Print a warning when the most common mistake is detected (@module tag required) jsdoc2md/dmd#96
  • Fixed an issue where a @example was excluded in the output if the doclet did not contain a description. jsdoc2md/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.
Commits


Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
dependabot[bot] commented 1 month ago

Superseded by #375.