Closed renovate[bot] closed 3 months ago
Latest commit: 54c1a4faf5aa27b8d9ddc0fa6444b61ffc100b4e
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.
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
This PR contains the following updates:
8.0.3
->9.0.0
Release Notes
jsdoc2md/jsdoc-to-markdown (jsdoc-to-markdown)
### [`v9.0.0`](https://redirect.github.com/jsdoc2md/jsdoc-to-markdown/releases/tag/v9.0.0) [Compare Source](https://redirect.github.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://redirect.github.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://redirect.github.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://redirect.github.com/jsdoc2md/jsdoc-to-markdown/issues/303) - Support clever-links, monospace-links, `{@linkcode}` and `{@linkplain}`. [#301](https://redirect.github.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://redirect.github.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://redirect.github.com/jsdoc2md/dmd/issues/82) - Added the `--EOL` option to control line-endings. Fixes [https://github.com/jsdoc2md/dmd/issues/92](https://redirect.github.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://redirect.github.com/jsdoc2md/jsdoc-api/issues/22) - Can now pass an array of strings to `.source`. [https://github.com/jsdoc2md/jsdoc-api/issues/11](https://redirect.github.com/jsdoc2md/jsdoc-api/issues/11) - Added support for `@hideconstructor`. [https://github.com/jsdoc2md/dmd/issues/94](https://redirect.github.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://redirect.github.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://redirect.github.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://redirect.github.com/jsdoc2md/jsdoc-to-markdown/wiki/How-to-create-one-output-file-per-class).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.
This PR was generated by Mend Renovate. View the repository job log.