Skip to content

Commit

Permalink
chore(deps): bump typedoc from 0.23.11 to 0.24.7 (#266)
Browse files Browse the repository at this point in the history
Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.23.11 to 0.24.7.
<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.24.7</h2>
<h3>Features</h3>
<ul>
<li>TypeDoc will now allow conversion without any entry points to support &quot;readme only&quot; packages, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2264">#2264</a>.</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li>Category children are now sorted according to the <code>sort</code> option, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2272">#2272</a>.</li>
<li>Inline tags no longer require a space after the tag name to be parsed as a tag, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2273">#2273</a>.</li>
<li>Fixed module/namespace links in navigation when viewed in Safari, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2275">#2275</a>.</li>
</ul>
<h2>v0.24.6</h2>
<h3>Features</h3>
<ul>
<li>Improved error messaging if a provided entry point could not be converted into a documented module reflection, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2242">#2242</a>.</li>
<li>API: Added support for <code>g</code>, <code>circle</code>, <code>ellipse</code>, <code>polygon</code>, and <code>polyline</code> svg elements, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2259">#2259</a>.</li>
<li>Extended <code>jsDocCompatibility</code> option with <code>inheritDocTag</code> to ignore fully lowercase <code>inheritDoc</code> tags and
<code>ignoreUnescapedBraces</code> to disable warnings about unescaped <code>{</code> and <code>}</code> characters in comments.</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li><code>--useTsLinkResolution</code> is no longer ignored within block tags, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2260">#2260</a>.</li>
<li>The current namespace will also be expanded in the navigation on page load, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2260">#2260</a>.</li>
<li>Fixed flicker of navigation pane when reloading a page caused by updating expansion state after the page was loaded.</li>
<li>Fixed an infinite loop if more than one entry point was provided, and all entry points were the same.</li>
</ul>
<h3>Thanks!</h3>
<ul>
<li><a href="https://github.com/FlippieCoetser"><code>@​FlippieCoetser</code></a></li>
</ul>
<h2>v0.24.5</h2>
<h3>Features</h3>
<ul>
<li>Categories and groups can now be shown in the navigation, added <code>--navigation.includeCategories</code>
and <code>--navigation.includeGroups</code> to control this behavior. The <code>--categorizeByGroup</code> option also
effects this behavior. If <code>categorizeByGroup</code> is set (the default) and <code>navigation.includeGroups</code> is
<em>not</em> set, the value of <code>navigation.includeCategories</code> will be effectively ignored since categories
will be created only within groups, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/1532">#1532</a>.</li>
<li>Added support for discovering a &quot;module&quot; comment on global files, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2165">#2165</a>.</li>
<li>Added copy code to clipboard button, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2153">#2153</a>.</li>
<li>Function <code>@returns</code> blocks will now be rendered with the return type, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2180">#2180</a>.</li>
<li>Added <code>--groupOrder</code> option to specify the sort order of groups, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2251">#2251</a>.</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li>Type parameter constraints now respect the <code>--hideParameterTypesInTitle</code> option, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2226">#2226</a>.</li>
<li>Even more contrast fixes, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2248">#2248</a>.</li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</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.24.7 (2023-05-08)</h2>
<h3>Features</h3>
<ul>
<li>TypeDoc will now allow conversion without any entry points to support &quot;readme only&quot; packages, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2264">#2264</a>.</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li>Category children are now sorted according to the <code>sort</code> option, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2272">#2272</a>.</li>
<li>Inline tags no longer require a space after the tag name to be parsed as a tag, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2273">#2273</a>.</li>
<li>Fixed module/namespace links in navigation when viewed in Safari, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2275">#2275</a>.</li>
</ul>
<h2>v0.24.6 (2023-04-24)</h2>
<h3>Features</h3>
<ul>
<li>Improved error messaging if a provided entry point could not be converted into a documented module reflection, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2242">#2242</a>.</li>
<li>API: Added support for <code>g</code>, <code>circle</code>, <code>ellipse</code>, <code>polygon</code>, and <code>polyline</code> svg elements, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2259">#2259</a>.</li>
<li>Extended <code>jsDocCompatibility</code> option with <code>inheritDocTag</code> to ignore fully lowercase <code>inheritDoc</code> tags and
<code>ignoreUnescapedBraces</code> to disable warnings about unescaped <code>{</code> and <code>}</code> characters in comments.</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li><code>--useTsLinkResolution</code> is no longer ignored within block tags, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2260">#2260</a>.</li>
<li>The current namespace will also be expanded in the navigation on page load, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2260">#2260</a>.</li>
<li>Fixed flicker of navigation pane when reloading a page caused by updating expansion state after the page was loaded.</li>
<li>Fixed an infinite loop if more than one entry point was provided, and all entry points were the same.</li>
</ul>
<h3>Thanks!</h3>
<ul>
<li><a href="https://github.com/FlippieCoetser"><code>@​FlippieCoetser</code></a></li>
</ul>
<h2>v0.24.5 (2023-04-22)</h2>
<h3>Features</h3>
<ul>
<li>Categories and groups can now be shown in the navigation, added <code>--navigation.includeCategories</code>
and <code>--navigation.includeGroups</code> to control this behavior. The <code>--categorizeByGroup</code> option also
effects this behavior. If <code>categorizeByGroup</code> is set (the default) and <code>navigation.includeGroups</code> is
<em>not</em> set, the value of <code>navigation.includeCategories</code> will be effectively ignored since categories
will be created only within groups, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/1532">#1532</a>.</li>
<li>Added support for discovering a &quot;module&quot; comment on global files, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2165">#2165</a>.</li>
<li>Added copy code to clipboard button, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2153">#2153</a>.</li>
<li>Function <code>@returns</code> blocks will now be rendered with the return type, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2180">#2180</a>.</li>
<li>Added <code>--groupOrder</code> option to specify the sort order of groups, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2251">#2251</a>.</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li>Type parameter constraints now respect the <code>--hideParameterTypesInTitle</code> option, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2226">#2226</a>.</li>
<li>Even more contrast fixes, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2248">#2248</a>.</li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/TypeStrong/typedoc/commit/c5d1ec5c7c35004467e83b38e8aa2442d0e76d33"><code>c5d1ec5</code></a> Update changelog for release</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/075698181873a21bafbe76a6d15d4534320add88"><code>0756981</code></a> Bump version to 0.24.7</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/a4028d72ff2efd5685f068daa3e29dad09999055"><code>a4028d7</code></a> Update changelog</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/56abed5b92d1ab26e8a16b3bbf9ecc3e20f6e68f"><code>56abed5</code></a> Fix navigation on Safari, hopefully fixes <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2275">#2275</a></li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/515e8b7636945f5956e17ed4945f0ce1163877a1"><code>515e8b7</code></a> Fix inline tag parsing</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/26df2accb340178d34bf2057b829f8e851450c1c"><code>26df2ac</code></a> Support readme only packages</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/eb181508c24fc6e297823a569494695dbfea20bc"><code>eb18150</code></a> Fix <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2272">#2272</a> category sort order</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/5d38df12def8e4fe94fde75fbbf31f9b7992ea1c"><code>5d38df1</code></a> Add a test for <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2270">#2270</a></li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/af63d9e4e1a43816fd1825fdf0ec2ddc730abdbc"><code>af63d9e</code></a> Update changelog for release</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/50f89680bef3e1d0c4f6ab419973e7ba993802c2"><code>50f8968</code></a> Bump version to 0.24.6</li>
<li>Additional commits viewable in <a href="https://github.com/TypeStrong/TypeDoc/compare/v0.23.11...v0.24.7">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.23.11&new-version=0.24.7)](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 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 May 25, 2023
1 parent 1842395 commit 8da2287
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 58 deletions.
131 changes: 74 additions & 57 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 @@ -61,7 +61,7 @@
"ts-jest": "^28.0.8",
"ts-node": "^10.9.1",
"tslint": "^6.1.3",
"typedoc": "^0.23.11",
"typedoc": "^0.24.7",
"typescript": "^4.7.4"
},
"peerDependencies": {
Expand Down

0 comments on commit 8da2287

Please sign in to comment.