This repository was archived by the owner on Dec 11, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit 3a27705
authored
chore(deps): update dependency jsdoc-to-markdown to v9 (#275)
This PR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown)
| [`8.0.3` ->
`9.0.0`](https://renovatebot.com/diffs/npm/jsdoc-to-markdown/8.0.3/9.0.0)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
---
### Release Notes
<details>
<summary>jsdoc2md/jsdoc-to-markdown (jsdoc-to-markdown)</summary>
###
[`v9.0.0`](https://github.com/jsdoc2md/jsdoc-to-markdown/releases/tag/v9.0.0)
[Compare
Source](https://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://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://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://github.com/jsdoc2md/jsdoc-to-markdown/issues/303)
- Support clever-links, monospace-links, `{@​linkcode}` and
`{@​linkplain}`.
[#​301](https://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://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://github.com/jsdoc2md/dmd/issues/82)
- Added the `--EOL` option to control line-endings. Fixes
[https://github.com/jsdoc2md/dmd/issues/92](https://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://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://github.com/jsdoc2md/jsdoc-api/issues/11)
- Added support for `@hideconstructor`.
[https://github.com/jsdoc2md/dmd/issues/94](https://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://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://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://github.com/jsdoc2md/jsdoc-to-markdown/wiki/How-to-create-one-output-file-per-class).
</details>
---
### Configuration
📅 **Schedule**: Branch creation - "after 2pm on Monday" in timezone
Europe/Zurich, 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.
---
- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box
---
This PR was generated by [Mend Renovate](https://mend.io/renovate/).
View the [repository job
log](https://developer.mend.io/github/adobe/spacecat-audit-post-processor).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC41OS4yIiwidXBkYXRlZEluVmVyIjoiMzguNTkuMiIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOltdfQ==-->
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>1 parent 26f15a9 commit 3a27705Copy full SHA for 3a27705
2 files changed
+278
-473
lines changed
0 commit comments