search

MrSwitch / tricks

Tricks and tips in ES
https://adodson.com/tricks/
1 stars 0 forks source link

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

Closed renovate[bot] closed 3 months ago

renovate[bot] commented 3 months ago

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.0.0`](https://togithub.com/jsdoc2md/jsdoc-to-markdown/releases/tag/v9.0.0) [Compare Source](https://togithub.com/jsdoc2md/jsdoc-to-markdown/compare/v8.0.3...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](https://togithub.com/jsdoc2md/jsdoc-to-markdown/discussions/305) 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](https://togithub.com/jsdoc2md/jsdoc-api/issues/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](https://togithub.com/jsdoc2md/jsdoc-to-markdown/issues/303) - Support clever-links, monospace-links, `{@​linkcode}` and `{@​linkplain}`. [#​301](https://togithub.com/jsdoc2md/jsdoc-to-markdown/issues/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. [https://github.com/jsdoc2md/dmd/issues/89](https://togithub.com/jsdoc2md/dmd/issues/89) - Fixed an issue where the dmd internal partials failed to load if a user's directory name contained special glob characters. [https://github.com/jsdoc2md/dmd/issues/82](https://togithub.com/jsdoc2md/dmd/issues/82) - Added the `--EOL` option to control line-endings. Fixes [https://github.com/jsdoc2md/dmd/issues/92](https://togithub.com/jsdoc2md/dmd/issues/92). - Fixed an issue where setting `{ pedantic: false }` confused the underlying jsdoc. [https://github.com/jsdoc2md/jsdoc-api/issues/22](https://togithub.com/jsdoc2md/jsdoc-api/issues/22) - Can now pass an array of strings to `.source`. [https://github.com/jsdoc2md/jsdoc-api/issues/11](https://togithub.com/jsdoc2md/jsdoc-api/issues/11) - Added support for `@hideconstructor`. [https://github.com/jsdoc2md/dmd/issues/94](https://togithub.com/jsdoc2md/dmd/issues/94) - Print a warning when the most common mistake is detected (`@module` tag required) [https://github.com/jsdoc2md/dmd/issues/96](https://togithub.com/jsdoc2md/dmd/issues/96) - Fixed an issue where a `@example` was excluded in the output if the doclet did not contain a description. [https://github.com/jsdoc2md/jsdoc-parse/issues/33](https://togithub.com/jsdoc2md/jsdoc-parse/issues/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](https://togithub.com/jsdoc2md/jsdoc-to-markdown/wiki/How-to-create-one-output-file-per-class). ### [`v8.0.3`](https://togithub.com/jsdoc2md/jsdoc-to-markdown/compare/v8.0.2...v8.0.3) [Compare Source](https://togithub.com/jsdoc2md/jsdoc-to-markdown/compare/v8.0.2...v8.0.3) ### [`v8.0.2`](https://togithub.com/jsdoc2md/jsdoc-to-markdown/compare/v8.0.1...v8.0.2) [Compare Source](https://togithub.com/jsdoc2md/jsdoc-to-markdown/compare/v8.0.1...v8.0.2) ### [`v8.0.1`](https://togithub.com/jsdoc2md/jsdoc-to-markdown/compare/v8.0.0...v8.0.1) [Compare Source](https://togithub.com/jsdoc2md/jsdoc-to-markdown/compare/v8.0.0...v8.0.1)

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.

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

github-actions[bot] commented 2 months ago

:tada: This PR is included in version 2.0.1-rc.1 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

github-actions[bot] commented 2 months ago

:tada: This PR is included in version 2.0.1 :tada:

The release is available on:

Your semantic-release bot :package::rocket: