Skip to content

Commit

Permalink
chore(deps): Bump typedoc from 0.24.8 to 0.25.0 (#234)
Browse files Browse the repository at this point in the history
Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.24.8 to 0.25.0.
<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.25.0</h2>
<h3>Breaking Changes</h3>
<ul>
<li>Bump minimum Node version to 16.</li>
<li>Removed <code>legacy-packages</code> option for <code>--entryPointStrategy</code>.</li>
<li>Changed default value of <code>--categorizeByGroup</code> to <code>false</code>.</li>
<li>Specifying a link as the <code>gitRemote</code> is no longer supported.</li>
<li>An <code>Application</code> instance must now be retrieved via <code>Application.bootstrap</code> or <code>Application.bootstrapWithPlugins</code>, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2268">#2268</a>.</li>
<li>Removed <code>ReflectionKind.ObjectLiteral</code> that was never used by TypeDoc.</li>
<li>Removed deprecated members <code>DefaultThemeRenderContext.comment</code> and <code>DefaultThemeRenderContext.attemptExternalResolution</code>.</li>
</ul>
<h3>Features</h3>
<ul>
<li>Added support for TypeScript 5.2</li>
<li>TypeDoc config files now support options default-exported from an ESM config file, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2268">#2268</a>.</li>
<li>TypeDoc config files may now export a promise containing configuration, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2268">#2268</a>.</li>
<li>Added <code>--preserveLinkText</code> option (defaults to true) which determines whether the reflection name or full link text is included
in the output when no override is specified, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2355">#2355</a>.</li>
<li>Added a no-results placeholder when no search results are available, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2347">#2347</a>.</li>
<li>Implemented several miscellaneous performance improvements to generate docs faster, this took the time to generate TypeDoc's
site from ~5.6 seconds to ~5.4 seconds.</li>
<li>Added <code>--disableGit</code> option to prevent TypeDoc from using Git to try to determine if sources can be linked, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2326">#2326</a>.</li>
<li>Added support for tags <code>@showGroups</code>, <code>@hideGroups</code>, <code>@showCategories</code>, <code>@hideCategories</code> to configure the navigation pane on a
per-reflection basis, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2329">#2329</a>.</li>
<li>With <code>--jsDocCompatibility.defaultTags</code> set, <code>@DefaultValue</code> is now implicitly a code block if the text contains no code, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2370">#2370</a>.</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li>Fixed link discovery if nested (<code>Foo#bar</code>) links were used and <code>--useTsLinkResolution</code> is enabled in some cases, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2360">#2360</a>.</li>
<li>Links with invalid declaration references will no longer silently link to the wrong page in some cases, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2360">#2360</a>.</li>
<li>Fixed duplicate definitions in type hierarchy when using packages mode, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2327">#2327</a>.</li>
<li><code>@inheritdoc</code> was not properly resolved across packages in packages mode, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2331">#2331</a>.</li>
<li>Added warning for attempted <code>@interface</code> use on union types, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2352">#2352</a>.</li>
<li>Fixed misleading type annotation on <code>Theme.getUrls</code>, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2318">#2318</a>.</li>
<li>Fixed duplicate namespace in documentation if <code>@namespace</code> is used on a variable with an associated namespace, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2364">#2364</a>.</li>
<li>Fixed <code>@namespace</code> property discovery if merged with a type and the type was declared first <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2364">#2364</a>.</li>
<li>Tables in markdown are now styled, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2366">#2366</a>.</li>
<li>Sidebar links no longer open in a new tab, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2353">#2353</a>.</li>
<li>Headers now include some padding before rendering text, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2316">#2316</a>.</li>
<li>Symbol locations for signatures on <code>reflection.sources</code> now considers the node's name like non-signature location discovery does.</li>
</ul>
<h3>Thanks!</h3>
<ul>
<li><a href="https://github.com/camc314"><code>@​camc314</code></a></li>
<li><a href="https://github.com/cprussin"><code>@​cprussin</code></a></li>
<li><a href="https://github.com/roggervalf"><code>@​roggervalf</code></a></li>
<li><a href="https://github.com/Th3S4mur41"><code>@​Th3S4mur41</code></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>
<h1>v0.25.0 (2023-08-25)</h1>
<h3>Breaking Changes</h3>
<ul>
<li>Bump minimum Node version to 16.</li>
<li>Removed <code>legacy-packages</code> option for <code>--entryPointStrategy</code>.</li>
<li>Changed default value of <code>--categorizeByGroup</code> to <code>false</code>.</li>
<li>Specifying a link as the <code>gitRemote</code> is no longer supported.</li>
<li>An <code>Application</code> instance must now be retrieved via <code>Application.bootstrap</code> or <code>Application.bootstrapWithPlugins</code>, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2268">#2268</a>.</li>
<li>Removed <code>ReflectionKind.ObjectLiteral</code> that was never used by TypeDoc.</li>
<li>Removed deprecated members <code>DefaultThemeRenderContext.comment</code> and <code>DefaultThemeRenderContext.attemptExternalResolution</code>.</li>
</ul>
<h3>Features</h3>
<ul>
<li>Added support for TypeScript 5.2, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2373">#2373</a>.</li>
<li>TypeDoc config files now support options default-exported from an ESM config file, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2268">#2268</a>.</li>
<li>TypeDoc config files may now export a promise containing configuration, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2268">#2268</a>.</li>
<li>Added <code>--preserveLinkText</code> option (defaults to true) which determines whether the reflection name or full link text is included
in the output when no override is specified, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2355">#2355</a>.</li>
<li>Added a no-results placeholder when no search results are available, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2347">#2347</a>.</li>
<li>Implemented several miscellaneous performance improvements to generate docs faster, this took the time to generate TypeDoc's
site from ~5.6 seconds to ~5.4 seconds.</li>
<li>Added <code>--disableGit</code> option to prevent TypeDoc from using Git to try to determine if sources can be linked, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2326">#2326</a>.</li>
<li>Added support for tags <code>@showGroups</code>, <code>@hideGroups</code>, <code>@showCategories</code>, <code>@hideCategories</code> to configure the navigation pane on a
per-reflection basis, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2329">#2329</a>.</li>
<li>With <code>--jsDocCompatibility.defaultTags</code> set, <code>@DefaultValue</code> is now implicitly a code block if the text contains no code, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2370">#2370</a>.</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li>Fixed link discovery if nested (<code>Foo#bar</code>) links were used and <code>--useTsLinkResolution</code> is enabled in some cases, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2360">#2360</a>.</li>
<li>Links with invalid declaration references will no longer silently link to the wrong page in some cases, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2360">#2360</a>.</li>
<li>Fixed duplicate definitions in type hierarchy when using packages mode, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2327">#2327</a>.</li>
<li><code>@inheritdoc</code> was not properly resolved across packages in packages mode, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2331">#2331</a>.</li>
<li>Added warning for attempted <code>@interface</code> use on union types, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2352">#2352</a>.</li>
<li>Fixed misleading type annotation on <code>Theme.getUrls</code>, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2318">#2318</a>.</li>
<li>Fixed duplicate namespace in documentation if <code>@namespace</code> is used on a variable with an associated namespace, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2364">#2364</a>.</li>
<li>Fixed <code>@namespace</code> property discovery if merged with a type and the type was declared first <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2364">#2364</a>.</li>
<li>Tables in markdown are now styled, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2366">#2366</a>.</li>
<li>Sidebar links no longer open in a new tab, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2353">#2353</a>.</li>
<li>Headers now include some padding before rendering text, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2316">#2316</a>.</li>
<li>Symbol locations for signatures on <code>reflection.sources</code> now considers the node's name like non-signature location discovery does.</li>
</ul>
<h3>Thanks!</h3>
<ul>
<li><a href="https://github.com/camc314"><code>@​camc314</code></a></li>
<li><a href="https://github.com/cprussin"><code>@​cprussin</code></a></li>
<li><a href="https://github.com/roggervalf"><code>@​roggervalf</code></a></li>
<li><a href="https://github.com/Th3S4mur41"><code>@​Th3S4mur41</code></a></li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/TypeStrong/typedoc/commit/8d822e9ac836c94153a61c14795d6160e9b66f8d"><code>8d822e9</code></a> Update changelog for release</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/fc6f64853cde653b10fd8e5e787701d452a858fc"><code>fc6f648</code></a> Bump version to 0.25.0</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/d4db57192c057945b31b8c07072cbd9c5aff0dfc"><code>d4db571</code></a> Add preserveLinkText option</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/3d8ff29664e5177297f5ac4c7cd5427bff1e62b2"><code>3d8ff29</code></a> defaultValue is implicitly code only with JSDoc compat</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/028a1410582151e0699752d932e4c83de095f9d1"><code>028a141</code></a> feat(default-value): treat as code block for better styling (<a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2370">#2370</a>)</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/c83f2c3f24423e8c0e24fc9e7459c35937ed1f3e"><code>c83f2c3</code></a> Add support for TS 5.2</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/5c977aea2e781bf8a97f02b59862df707f966d7b"><code>5c977ae</code></a> Support ESM config files</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/76c918c3c643db58e2e4778946fd76da92926019"><code>76c918c</code></a> Headers now include some padding before rendering text</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/0cc6e58d066cb656093544a53246ec1944929dcf"><code>0cc6e58</code></a> Sidebar links no longer open in a new tab, closes <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2353">#2353</a>.</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/3207ae5686a489eef7ecc91e624adbb2737ef2eb"><code>3207ae5</code></a> Lint</li>
<li>Additional commits viewable in <a href="https://github.com/TypeStrong/TypeDoc/compare/v0.24.8...v0.25.0">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.24.8&new-version=0.25.0)](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 Aug 28, 2023
1 parent cef8c78 commit bc1a314
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
34 changes: 17 additions & 17 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.1.1",
"ts-node": "^10.9.1",
"tslint": "^6.1.3",
"typedoc": "^0.24.8",
"typedoc": "^0.25.0",
"typescript": "^5.0.4"
},
"peerDependencies": {
Expand Down

0 comments on commit bc1a314

Please sign in to comment.