Skip to content

Commit

Permalink
chore(deps): Bump typedoc from 0.27.3 to 0.27.5 (#300)
Browse files Browse the repository at this point in the history
Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.27.3 to 0.27.5.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a href="https://github.com/TypeStrong/TypeDoc/releases">typedoc's releases</a>.</em></p>
<blockquote>
<h2>v0.27.5</h2>
<h3>Bug Fixes</h3>
<ul>
<li>Possibly Breaking: TypeDoc will no longer render anchors within the page for
deeply nested properties. This only affects links to properties of
properties of types, which did not have a clickable link exposed so are
unlikely to have been linked to. Furthermore, these links were not always
created by TypeDoc, only being created if all parent properties contained
comments, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2808">#2808</a>.</li>
<li>TypeDoc will now warn if a property which does not have a URL within the
rendered document and the parent property/page will be linked to instead,
<a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2808">#2808</a>. These warnings can be disabled with the <code>validation.rewrittenLink</code>
option.</li>
<li>Fix restoration of groups/categories including documents, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2801">#2801</a>.</li>
<li>Fixed missed relative paths within markdown link references in documents.</li>
<li>Improved handling of incomplete inline code blocks within markdown.</li>
<li>Direct <code>https://</code> links under the <code>hostedBaseUrl</code> option's URL will no
longer be treated as external, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2809">#2809</a>.</li>
</ul>
<h3>Thanks!</h3>
<ul>
<li><a href="https://github.com/SacDeNoeuds"><code>@​SacDeNoeuds</code></a></li>
</ul>
<h2>v0.27.4</h2>
<h3>Features</h3>
<ul>
<li>API: Introduced new <code>Converter.EVENT_CREATE_PROJECT</code> event which fires when a project is created by the converter, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2800">#2800</a>.</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li>Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2796">#2796</a>.</li>
<li><code>@include</code> and <code>@includecode</code> now work for comments on the entry point for projects with a single entry point, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2800">#2800</a>.</li>
<li>Cascaded modifier tags will no longer be copied into type literals, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2802">#2802</a>.</li>
<li><code>@summary</code> now works to describe functions within modules, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2803">#2803</a>.</li>
<li>Corrected navigation showing module link as current when not on module page, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2805">#2805</a>.</li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a href="https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md">typedoc's changelog</a>.</em></p>
<blockquote>
<h2>v0.27.5 (2024-12-14)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>Possibly Breaking: TypeDoc will no longer render anchors within the page for
deeply nested properties. This only affects links to properties of
properties of types, which did not have a clickable link exposed so are
unlikely to have been linked to. Furthermore, these links were not always
created by TypeDoc, only being created if all parent properties contained
comments, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2808">#2808</a>.</li>
<li>TypeDoc will now warn if a property which does not have a URL within the
rendered document and the parent property/page will be linked to instead,
<a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2808">#2808</a>. These warnings can be disabled with the <code>validation.rewrittenLink</code>
option.</li>
<li>Fix restoration of groups/categories including documents, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2801">#2801</a>.</li>
<li>Fixed missed relative paths within markdown link references in documents.</li>
<li>Improved handling of incomplete inline code blocks within markdown.</li>
<li>Direct <code>https://</code> links under the <code>hostedBaseUrl</code> option's URL will no
longer be treated as external, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2809">#2809</a>.</li>
</ul>
<h3>Thanks!</h3>
<ul>
<li><a href="https://github.com/SacDeNoeuds"><code>@​SacDeNoeuds</code></a></li>
</ul>
<h2>v0.27.4 (2024-12-09)</h2>
<h3>Features</h3>
<ul>
<li>API: Introduced new <code>Converter.EVENT_CREATE_PROJECT</code> event which fires when a project is created by the converter, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2800">#2800</a>.</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li>Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2796">#2796</a>.</li>
<li><code>@include</code> and <code>@includecode</code> now work for comments on the entry point for projects with a single entry point, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2800">#2800</a>.</li>
<li>Cascaded modifier tags will no longer be copied into type literals, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2802">#2802</a>.</li>
<li><code>@summary</code> now works to describe functions within modules, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2803">#2803</a>.</li>
<li>Corrected navigation showing module link as current when not on module page, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2805">#2805</a>.</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/TypeStrong/typedoc/commit/80e23a8d28b11274387dfdbd4337d91dd828f65e"><code>80e23a8</code></a> Update changelog for release</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/9ffaf1daecfc36c8951bba06ee143a608028bb31"><code>9ffaf1d</code></a> Bump version to 0.27.5</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/d9ec2dddcc7fd2193fdfb443c29fe508650b086b"><code>d9ec2dd</code></a> Treat links under hostedBaseUrl as internal</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/8acc237b5ba3ff42e2fcd7469447f164a41eb496"><code>8acc237</code></a> Correct mismatched check between renderingIsUseful and applyAnchorUrl</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/9eb1e05639735c143379f84c83ece7730c9984b3"><code>9eb1e05</code></a> Produce warnings if links cannot be resolved</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/e4f991ddc19d80ed491a02ab774e108bc47d8970"><code>e4f991d</code></a> Update bug report template to ask reporters to disable plugins</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/b45d5ea1ed61e3325e77e709e8873c88d89fbf4c"><code>b45d5ea</code></a> Fix multiple issues with markdown parsing</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/ddc64e551b8e1cbdf281d537f6cf32986b689e5a"><code>ddc64e5</code></a> Update docs, changelog</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/9d8737e2070d9caadb54528499169a02cd83e1f8"><code>9d8737e</code></a> Update JSX extension docs</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/993c0f5bb9a4ab8ac21915b374b3fac3518312fa"><code>993c0f5</code></a> expose html global jsx attributes to enable extending them for custom element...</li>
<li>Additional commits viewable in <a href="https://github.com/TypeStrong/TypeDoc/compare/v0.27.3...v0.27.5">compare view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=typedoc&package-manager=npm_and_yarn&previous-version=0.27.3&new-version=0.27.5)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)


</details>
  • Loading branch information
dependabot[bot] authored Dec 16, 2024
1 parent 3c828b7 commit a45bda3
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
14 changes: 7 additions & 7 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
"ts-jest": "^29.2.5",
"ts-node": "^10.9.2",
"tslint": "^6.1.3",
"typedoc": "^0.27.3",
"typedoc": "^0.27.5",
"typescript": "^5.0.4"
},
"peerDependencies": {
Expand Down

0 comments on commit a45bda3

Please sign in to comment.