Skip to content

Conversation

@renovate
Copy link
Contributor

@renovate renovate bot commented Sep 2, 2024

This PR contains the following updates:

Package Change Age Confidence
jsdoc-to-markdown 8.0.39.1.3 age confidence

Release Notes

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

v9.1.3

Compare Source

Non-breaking change since v9.1.2

v9.1.2

Compare Source

Regression fix since v9.1.1

Previously, you could manually render files in a specific order. For example, in the output this code would render docs for two.js before one.js.

const output = await jsdoc2md.render({ files: ['src/two.js', 'src/one.js'] })

This behaviour was broken by the jsdoc-api v9.0.0 release - instead, that version first sorted the files into alphabetical order, thus rendering one.js before two.js.

Jsdoc-api v9.3.5 (used internally by jsdoc2md) fixes that regression - previous behaviour restored.

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

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
@renovate
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.34.5/16.20.2/node_modules/corepack/dist/lib/corepack.cjs:22572
  const isURL = URL.canParse(range);
                    ^

TypeError: URL.canParse is not a function
    at parseSpec (/opt/containerbase/tools/corepack/0.34.5/16.20.2/node_modules/corepack/dist/lib/corepack.cjs:22572:21)
    at Object.getSpec (/opt/containerbase/tools/corepack/0.34.5/16.20.2/node_modules/corepack/dist/lib/corepack.cjs:22721:55)
    at Engine.findProjectSpec (/opt/containerbase/tools/corepack/0.34.5/16.20.2/node_modules/corepack/dist/lib/corepack.cjs:22939:31)
    at async Engine.executePackageManagerRequest (/opt/containerbase/tools/corepack/0.34.5/16.20.2/node_modules/corepack/dist/lib/corepack.cjs:22978:24)
    at async Object.runMain (/opt/containerbase/tools/corepack/0.34.5/16.20.2/node_modules/corepack/dist/lib/corepack.cjs:23684:7)

@changeset-bot
Copy link

changeset-bot bot commented Sep 2, 2024

⚠️ No Changeset found

Latest commit: fa250ea

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

@coderabbitai
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.


Comment @coderabbitai help to get the list of available commands and usage tips.

@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 2 times, most recently from dc505ef to ea9ea5a Compare November 29, 2024 15:46
@renovate renovate bot force-pushed the renovate/jsdoc-to-markdown-9.x branch from ea9ea5a to 51f5ec1 Compare July 17, 2025 20:45
@renovate renovate bot force-pushed the renovate/jsdoc-to-markdown-9.x branch from 51f5ec1 to fa250ea Compare October 3, 2025 17:35
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.

1 participant