Skip to content

Conversation

@renovate
Copy link
Contributor

@renovate renovate bot commented Sep 1, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
jsdoc-to-markdown ^8.0.0 -> ^9.0.0 age adoption passing 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.

v8.0.3

Compare Source

v8.0.2

Compare Source

v8.0.1

Compare Source


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 becomes conflicted, 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 da99368 to 54a88a9 Compare August 10, 2025 12:46
@renovate renovate bot force-pushed the renovate/jsdoc-to-markdown-9.x branch from 54a88a9 to 12cc2ec Compare October 3, 2025 17:24
@renovate renovate bot force-pushed the renovate/jsdoc-to-markdown-9.x branch from 12cc2ec to f88c1cf Compare October 21, 2025 10:58
@renovate renovate bot force-pushed the renovate/jsdoc-to-markdown-9.x branch from f88c1cf to 05849f0 Compare November 10, 2025 20:39
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