Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump jsdoc-to-markdown from 8.0.3 to 9.0.5 #65

Closed

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Nov 25, 2024

Bumps jsdoc-to-markdown from 8.0.3 to 9.0.5.

Release notes

Sourced from jsdoc-to-markdown's releases.

v9.0.5

Non-breaking changes since v9.0.4

  • Fixed a regression where spaces in the jsdoc binary path caused jsdoc2md to fail. #307

v9.0.4

Non-breaking change

  • Implemented a permanent fix for the critical util.isRegExp is not a function issue in Node v23, replacing the previous temporary workaround. #306

v9.0.3

Non-breaking change

  • Temporary workaround fix for critical util.isRegExp is not a function issue in Node v23: #306

v9.0.2

Non-breaking

  • Fixed a scenario where --EOL failed to correctly replace naked CR characters created by jsdoc. jsdoc2md/dmd2

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
  • 60232cc 9.0.5
  • c3cfc73 Fixed regression where spaces in the jsdoc binary path caused jsdoc2md to cra...
  • 158b387 9.0.4
  • 00bb79b Implement permanent fix for #306
  • ba03afc 9.0.3
  • 7fb1354 Temp workaround fix for critical 'util.isRegExp is not a function' issue: #306
  • 825707e 9.0.2
  • 7298a45 Fixed a scenario where --EOL failed to correctly replace naked CR characters ...
  • 4c6f56d 9.0.1
  • f139500 Fixed a case where the 'Jsdoc data looks malformed' warning was displayed unn...
  • Additional commits viewable in compare view

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 <dependency name> 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)

Bumps [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown) from 8.0.3 to 9.0.5.
- [Release notes](https://github.com/jsdoc2md/jsdoc-to-markdown/releases)
- [Commits](jsdoc2md/jsdoc-to-markdown@v8.0.3...v9.0.5)

---
updated-dependencies:
- dependency-name: jsdoc-to-markdown
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Nov 25, 2024
Copy link

sonarcloud bot commented Nov 25, 2024

Copy link
Contributor Author

dependabot bot commented on behalf of github Nov 29, 2024

Superseded by #68.

@dependabot dependabot bot closed this Nov 29, 2024
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/jsdoc-to-markdown-9.0.5 branch November 29, 2024 07:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants