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.1.0 #393

Closed

Conversation

dependabot[bot]
Copy link
Contributor

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

Bumps jsdoc-to-markdown from 8.0.3 to 9.1.0.

Release notes

Sourced from jsdoc-to-markdown's releases.

v9.1.0

New feature since v9.0.5

  • Any text passed to the @deprecated tag is now displayed. #90

Upgrade notes

See this testbed directory for example source code and output.

Previously, the tag @deprecated This method has been deprecated since v2.0.0 would simply print ***Deprecated*** in the output, ignoring the deprecation text. The new behaviour:

  • For an empty @deprecated tag with no text, display ***Deprecated*** (same as before).
  • If the tag has text, e.g. @deprecated This method has been deprecated since v2.0.0, then the full text line will be printed as written
    • This will replace the previous ***Deprecated*** line with ***This method has been deprecated since v2.0.0***.
    • This approach gives you full control over the text displayed (without assuming you want the line to begin with "Deprecated").

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

... (truncated)

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

Summary by Sourcery

Build:

  • Update jsdoc-to-markdown from version 8.0.3 to 9.1.0 in package.json.

@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code labels Nov 29, 2024
Copy link

sourcery-ai bot commented Nov 29, 2024

Reviewer's Guide by Sourcery

This PR updates the jsdoc-to-markdown dependency from version 8.0.3 to 9.1.0. The update includes breaking changes in the API, making it async-only, along with several bug fixes and new features such as improved @deprecated tag handling.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Dependency version bump in package configuration files
  • Updated jsdoc-to-markdown from ^8.0.1 to ^9.1.0
package.json
package-lock.json
Major version upgrade introduces breaking changes in the jsdoc-to-markdown API
  • Removed sync methods (.renderSync(), .getTemplateDataSync(), and .getJsdocDataSync())
  • Modified input options requirements for files, source, and configure parameters
  • Added support for clever-links, monospace-links, {@linkcode}, and {@linkplain}
  • Improved @deprecated tag handling to display full deprecation messages
package.json
package-lock.json

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have skipped reviewing this pull request. It seems to have been created by a bot (hey, dependabot[bot]!). We assume it knows what it's doing!

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

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

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/jsdoc-to-markdown-9.1.0 branch from ee4d03d to 5976ba9 Compare November 29, 2024 04:05
Copy link
Contributor Author

dependabot bot commented on behalf of github Dec 2, 2024

Superseded by #394.

@dependabot dependabot bot closed this Dec 2, 2024
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/jsdoc-to-markdown-9.1.0 branch December 2, 2024 03:54
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 javascript Pull requests that update Javascript code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants