Skip to content

Commit

Permalink
build(deps-dev): bump typedoc from 0.25.4 to 0.25.8 (#1030)
Browse files Browse the repository at this point in the history
Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.25.4 to 0.25.8.
<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.8</h2>
<h2>Features</h2>
<ul>
<li>Added a new <code>--sitemapBaseUrl</code> option. When specified, TypeDoc will generate a <code>sitemap.xml</code> in your output folder that describes the site, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2480">#2480</a>.</li>
<li>Added support for the <code>@Class</code> tag. When added to a comment on a variable or function, TypeDoc will convert the member as a class, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2479">#2479</a>.
Note: This should only be used on symbols which actually represent a class, but are not declared as a class for some reason.</li>
<li>Added support for <code>@groupDescription</code> and <code>@categoryDescription</code> to provide a description of groups and categories, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2494">#2494</a>.</li>
<li>API: Exposed <code>Context.getNodeComment</code> for plugin use, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2498">#2498</a>.</li>
</ul>
<h2>Bug Fixes</h2>
<ul>
<li>Fixed an issue where a namespace would not be created for merged function-namespaces which are declared as variables, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2478">#2478</a>.</li>
<li>A class which implements itself will no longer cause a crash when rendering HTML, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2495">#2495</a>.</li>
<li>Variable functions which have construct signatures will no longer be converted as functions, ignoring the construct signatures.</li>
<li>The class hierarchy page will now include classes whose base class is not included in the documentation, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2486">#2486</a>.</li>
<li>Fixed an issue where, if the index section was collapsed when loading the page, all content within it would be hidden until expanded, and a member visibility checkbox was changed.</li>
<li>API: <code>Context.programs</code> will no longer contain duplicates, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2498">#2498</a>.</li>
</ul>
<h2>v0.25.7</h2>
<h3>Bug Fixes</h3>
<ul>
<li>Fixed an issue where a namespace would not be created for merged function-namespaces only containing types, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2476">#2476</a>.</li>
<li>Fixed an infinite loop when converting a union type which directly contained another union type which refers to itself, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2469">#2469</a>.</li>
</ul>
<h2>v0.25.6</h2>
<h3>Bug Fixes</h3>
<ul>
<li>Fixed infinite loop caused by a fix for some complicated union/intersection types, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2468">#2468</a>.</li>
<li>Improved infinite loop detection in type converter to reduce false positives.</li>
</ul>
<h2>v0.25.5</h2>
<h2>Features</h2>
<ul>
<li>Added a new hierarchy.html page to HTML output which displays the full inheritance hierarchy for classes included in the documentation, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/182">#182</a>.</li>
<li>Added a <code>--navigation.includeFolders</code> (default: <code>true</code>) option to create nested navigation for projects which include many entry points, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2388">#2388</a>.</li>
<li>Type parameters on functions/classes can will now link to the &quot;Type Parameters&quot; section, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2322">#2322</a>.
Type parameters have also been changed to have a distinct color from type aliases when rendering, which can be changed with custom CSS.</li>
<li>TypeDoc now provides warnings if a signature comment is directly specified on a signature and contains <code>@param</code> tags which do not apply, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2368">#2368</a>.</li>
<li>Extended reflection preview view for interfaces to include type parameters, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2455">#2455</a>.</li>
<li>Added special cases for converting methods which are documented as returning <code>this</code> or accepting <code>this</code> as a parameter, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2458">#2458</a>.
Note: This will only happen if a method is declared as <code>method(): this</code>, it will not happen if the method implicitly returns <code>this</code>
as the compiler strips that information when creating types for a class instance.</li>
<li>Improved handling of functions with properties. Previous TypeDoc versions would always create a separate
namespace for properties, now, TypeDoc will create a separate namespace if the function is declaration merged
with a namespace. If the properties are added via <code>Object.assign</code> or via property assignment on the function
TypeDoc will now instead add the properties to the function's page, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2461">#2461</a>.</li>
</ul>

</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.25.8 (2024-02-09)</h2>
<h2>Features</h2>
<ul>
<li>Added a new <code>--sitemapBaseUrl</code> option. When specified, TypeDoc will generate a <code>sitemap.xml</code> in your output folder that describes the site, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2480">#2480</a>.</li>
<li>Added support for the <code>@Class</code> tag. When added to a comment on a variable or function, TypeDoc will convert the member as a class, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2479">#2479</a>.
Note: This should only be used on symbols which actually represent a class, but are not declared as a class for some reason.</li>
<li>Added support for <code>@groupDescription</code> and <code>@categoryDescription</code> to provide a description of groups and categories, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2494">#2494</a>.</li>
<li>API: Exposed <code>Context.getNodeComment</code> for plugin use, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2498">#2498</a>.</li>
</ul>
<h2>Bug Fixes</h2>
<ul>
<li>Fixed an issue where a namespace would not be created for merged function-namespaces which are declared as variables, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2478">#2478</a>.</li>
<li>A class which implements itself will no longer cause a crash when rendering HTML, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2495">#2495</a>.</li>
<li>Variable functions which have construct signatures will no longer be converted as functions, ignoring the construct signatures.</li>
<li>The class hierarchy page will now include classes whose base class is not included in the documentation, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2486">#2486</a>.</li>
<li>Fixed an issue where, if the index section was collapsed when loading the page, all content within it would be hidden until expanded, and a member visibility checkbox was changed.</li>
<li>API: <code>Context.programs</code> will no longer contain duplicates, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2498">#2498</a>.</li>
</ul>
<h2>v0.25.7 (2024-01-08)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>Fixed an issue where a namespace would not be created for merged function-namespaces only containing types, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2476">#2476</a>.</li>
<li>Fixed an infinite loop when converting a union type which directly contained another union type which refers to itself, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2469">#2469</a>.</li>
</ul>
<h2>v0.25.6 (2024-01-01)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>Fixed infinite loop caused by a fix for some complicated union/intersection types, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2468">#2468</a>.</li>
<li>Improved infinite loop detection in type converter to reduce false positives.</li>
</ul>
<h2>v0.25.5 (2024-01-01)</h2>
<h2>Features</h2>
<ul>
<li>Added a new hierarchy.html page to HTML output which displays the full inheritance hierarchy for classes included in the documentation, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/182">#182</a>.</li>
<li>Added a <code>--navigation.includeFolders</code> (default: <code>true</code>) option to create nested navigation for projects which include many entry points, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2388">#2388</a>.</li>
<li>Type parameters on functions/classes can will now link to the &quot;Type Parameters&quot; section, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2322">#2322</a>.
Type parameters have also been changed to have a distinct color from type aliases when rendering, which can be changed with custom CSS.</li>
<li>TypeDoc now provides warnings if a signature comment is directly specified on a signature and contains <code>@param</code> tags which do not apply, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2368">#2368</a>.</li>
<li>Extended reflection preview view for interfaces to include type parameters, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2455">#2455</a>.</li>
<li>Added special cases for converting methods which are documented as returning <code>this</code> or accepting <code>this</code> as a parameter, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2458">#2458</a>.
Note: This will only happen if a method is declared as <code>method(): this</code>, it will not happen if the method implicitly returns <code>this</code>
as the compiler strips that information when creating types for a class instance.</li>
<li>Improved handling of functions with properties. Previous TypeDoc versions would always create a separate
namespace for properties, now, TypeDoc will create a separate namespace if the function is declaration merged
with a namespace. If the properties are added via <code>Object.assign</code> or via property assignment on the function
TypeDoc will now instead add the properties to the function's page, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2461">#2461</a>.</li>
</ul>

</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/TypeStrong/typedoc/commit/33db59c052ccbfeeffab1b637689c05723a65710"><code>33db59c</code></a> Update changelog for release</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/20b98dbe0b1cd7455723da1edf6834ddc8d2b777"><code>20b98db</code></a> Bump version to 0.25.8</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/23189493e36f8e134ae4d3ebd76191f65d15772c"><code>2318949</code></a> Include all base classes</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/ece4f31e12c49dfad5aa1aa2b782f6ab5b092010"><code>ece4f31</code></a> Fix circular dep</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/b6c5801be4a50dca1c5be0e9ddd3944f2ed94778"><code>b6c5801</code></a> Fix duplicate programs on context</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/f5f31b0b41e0e729b3dd59ce26398e2c991eb6e7"><code>f5f31b0</code></a> Expose <code>Context.getNodeComment</code>, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2498">#2498</a></li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/d26f76f4f7c979479337bf9018a0e22326a7d4c0"><code>d26f76f</code></a> Add support for <code>@groupDescription</code> and <code>@categoryDescription</code></li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/285b537677335a4664ad702fe0a891ceef577afd"><code>285b537</code></a> Add a test</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/e76d59414c5d0570943cb4a0265f91cf428333ed"><code>e76d594</code></a> Fix crash when class implements itself</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/eb7510b26a2a4b18cfddb76bdd0fe0d1ed2702a2"><code>eb7510b</code></a> Correct custom theme docs, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2490">#2490</a></li>
<li>Additional commits viewable in <a href="https://github.com/TypeStrong/TypeDoc/compare/v0.25.4...v0.25.8">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.25.4&new-version=0.25.8)](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 Feb 13, 2024
1 parent 9a5c231 commit 356a995
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"@docusaurus/module-type-aliases": "^3.1.1",
"@tsconfig/docusaurus": "^2.0.2",
"docusaurus-plugin-typedoc": "^0.21.0",
"typedoc": "^0.25.4",
"typedoc": "^0.25.8",
"typedoc-plugin-markdown": "^3.17.1",
"typescript": "^5.1.6"
},
Expand Down
20 changes: 10 additions & 10 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -13999,7 +13999,7 @@ __metadata:
react: ^18.2.0
react-dom: ^18.2.0
swc-loader: ^0.2.3
typedoc: ^0.25.4
typedoc: ^0.25.8
typedoc-plugin-markdown: ^3.17.1
typescript: ^5.1.6
languageName: unknown
Expand Down Expand Up @@ -25166,15 +25166,15 @@ __metadata:
languageName: node
linkType: hard

"shiki@npm:^0.14.1":
version: 0.14.1
resolution: "shiki@npm:0.14.1"
"shiki@npm:^0.14.7":
version: 0.14.7
resolution: "shiki@npm:0.14.7"
dependencies:
ansi-sequence-parser: ^1.1.0
jsonc-parser: ^3.2.0
vscode-oniguruma: ^1.7.0
vscode-textmate: ^8.0.0
checksum: b19ea337cc84da69d99ca39d109f82946e0c56c11cc4c67b3b91cc14a9479203365fd0c9e0dd87e908f493ab409dc6f1849175384b6ca593ce7da884ae1edca2
checksum: 2aec3b3519df977c4391df9e1825cb496e9a4d7e11395f05a0da77e4fa2f7c3d9d6e6ee94029ac699533017f2b25637ee68f6d39f05f311535c2704d0329b520
languageName: node
linkType: hard

Expand Down Expand Up @@ -26764,19 +26764,19 @@ __metadata:
languageName: node
linkType: hard

"typedoc@npm:^0.25.4":
version: 0.25.4
resolution: "typedoc@npm:0.25.4"
"typedoc@npm:^0.25.8":
version: 0.25.8
resolution: "typedoc@npm:0.25.8"
dependencies:
lunr: ^2.3.9
marked: ^4.3.0
minimatch: ^9.0.3
shiki: ^0.14.1
shiki: ^0.14.7
peerDependencies:
typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x
bin:
typedoc: bin/typedoc
checksum: 6d441baa277c0db4d577db2932a7af316d175415841e2faf2e68e3eda6ad60356c54f56374f89c5233d7bd5c057b0337455e5d484d8463e1445e67c37a6d94eb
checksum: c81992d791ef267e5f94ce0bf0ee98452ac772f4a12a96ad3b18520e7a1f9ba5f6908e48d5e73330fdedb7bfd0b9e0a74073afa5ef75775f76f1c6f3f3fce3a3
languageName: node
linkType: hard

Expand Down

0 comments on commit 356a995

Please sign in to comment.