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

chore(deps): update dependency jsdoc-to-markdown to v9 #70

Merged
merged 1 commit into from
Dec 16, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Dec 12, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
jsdoc-to-markdown 8.0.3 -> 9.1.1 age adoption passing confidence

Release Notes

jsdoc2md/jsdoc-to-markdown (jsdoc-to-markdown)

v9.1.1

Compare Source

Non-breaking changes since v9.1.0

  • Amended the fix for #​90 so that @link, @linkcode and @linkplain tags are resolved in the @deprecated tag text.

v9.1.0

Compare Source

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

Compare Source

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

Compare Source

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

Compare Source

Non-breaking change

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

v9.0.2

Compare Source

Non-breaking

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

v9.0.1

Compare Source

v9.0.0

Compare Source

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. https://github.com/jsdoc2md/jsdoc-api/issues/27

Non-breaking changes

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.

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot force-pushed the renovate/jsdoc-to-markdown-9.x branch from edb66d1 to c6999b4 Compare December 16, 2024 09:08
@rbartl-pv rbartl-pv merged commit 953acaa into main Dec 16, 2024
5 checks passed
@rbartl-pv rbartl-pv deleted the renovate/jsdoc-to-markdown-9.x branch December 16, 2024 09:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant