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 #730

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Sep 2, 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: Disabled by config. Please merge this manually once you are satisfied.

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 added the dependencies Pull requests that update a dependency file label Sep 2, 2024
Copy link
Contributor Author

renovate bot commented Sep 2, 2024

⚠️ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

  • any of the package files in this branch needs updating, or
  • the branch becomes conflicted, or
  • you click the rebase/retry checkbox if found above, or
  • you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: yarn.lock
/opt/containerbase/tools/corepack/0.30.0/16.20.2/node_modules/corepack/dist/lib/corepack.cjs:21609
    throw new Error(
          ^

Error: Error when performing the request to https://registry.npmjs.org/yarn/latest; for troubleshooting help, see https://github.com/nodejs/corepack#troubleshooting
    at fetch (/opt/containerbase/tools/corepack/0.30.0/16.20.2/node_modules/corepack/dist/lib/corepack.cjs:21609:11)
    at async fetchAsJson (/opt/containerbase/tools/corepack/0.30.0/16.20.2/node_modules/corepack/dist/lib/corepack.cjs:21623:20)
    ... 4 lines matching cause stack trace ...
    at async Object.runMain (/opt/containerbase/tools/corepack/0.30.0/16.20.2/node_modules/corepack/dist/lib/corepack.cjs:23102:5) {
  [cause]: TypeError: globalThis.fetch is not a function
      at fetch (/opt/containerbase/tools/corepack/0.30.0/16.20.2/node_modules/corepack/dist/lib/corepack.cjs:21603:33)
      at async fetchAsJson (/opt/containerbase/tools/corepack/0.30.0/16.20.2/node_modules/corepack/dist/lib/corepack.cjs:21623:20)
      at async fetchLatestStableVersion (/opt/containerbase/tools/corepack/0.30.0/16.20.2/node_modules/corepack/dist/lib/corepack.cjs:21550:20)
      at async fetchLatestStableVersion2 (/opt/containerbase/tools/corepack/0.30.0/16.20.2/node_modules/corepack/dist/lib/corepack.cjs:21672:14)
      at async Engine.getDefaultVersion (/opt/containerbase/tools/corepack/0.30.0/16.20.2/node_modules/corepack/dist/lib/corepack.cjs:22298:23)
      at async Engine.executePackageManagerRequest (/opt/containerbase/tools/corepack/0.30.0/16.20.2/node_modules/corepack/dist/lib/corepack.cjs:22396:47)
      at async Object.runMain (/opt/containerbase/tools/corepack/0.30.0/16.20.2/node_modules/corepack/dist/lib/corepack.cjs:23102:5)
}

Copy link

changeset-bot bot commented Sep 2, 2024

⚠️ No Changeset found

Latest commit: ea9ea5a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

coderabbitai bot commented Sep 2, 2024

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@renovate renovate bot force-pushed the renovate/jsdoc-to-markdown-9.x branch from 98cec73 to 0c391c8 Compare September 8, 2024 13:07
@renovate renovate bot force-pushed the renovate/jsdoc-to-markdown-9.x branch from 0c391c8 to 4a803b7 Compare September 25, 2024 16:45
@renovate renovate bot force-pushed the renovate/jsdoc-to-markdown-9.x branch 2 times, most recently from 9d36217 to a4f3bd8 Compare October 20, 2024 01:29
@renovate renovate bot force-pushed the renovate/jsdoc-to-markdown-9.x branch from a4f3bd8 to b4025d6 Compare November 2, 2024 20:37
@renovate renovate bot force-pushed the renovate/jsdoc-to-markdown-9.x branch from b4025d6 to dc505ef Compare November 28, 2024 17:15
@renovate renovate bot force-pushed the renovate/jsdoc-to-markdown-9.x branch from dc505ef to ea9ea5a Compare November 29, 2024 15:46
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