Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Bump typedoc from 0.25.4 to 0.25.7 (#713)
Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.25.4 to 0.25.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.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 "Type Parameters" 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> <h3>Bug Fixes</h3> <ul> <li>If both an interface and a variable share a name/symbol, TypeDoc will no longer link to the variable when referenced in a type position, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2106">#2106</a>.</li> <li><code>notDocumented</code> validation will no longer require documentation for data within parameters that cannot be documented via <code>@param</code>, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2291">#2291</a>.</li> <li>"defined in" locations for signatures will now always be contained within the function declaration's location. This prevents defined in sometimes pointing to node_modules, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2307">#2307</a>.</li> <li>Type parameters will now be resolved for arrow-methods on classes like regular class methods, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2320">#2320</a>.</li> <li>TypeDoc now inherits <code>typedocOptions</code> fields from extended tsconfig files, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2334">#2334</a>.</li> <li>Methods which return function types no longer have duplicated comments, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2336">#2336</a>.</li> <li>Comments on function-like type aliases will now show up under the type alias, rather than nested within the type declaration, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2372">#2372</a>.</li> <li>Improved detection of default values for parameters with destructured values, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2430">#2430</a>.</li> <li>Fix crash when converting some complicated union/intersection types, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2451">#2451</a>.</li> <li>Navigation triangle markers should no longer display on a separate line with some font settings, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2457">#2457</a>.</li> <li><code>@group</code> and <code>@category</code> organization is now applied later to allow inherited comments to create groups/categories, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2459">#2459</a>.</li> <li>Conversion order should no longer affect link resolution for classes with properties whose type does not rely on <code>this</code>, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2466">#2466</a>.</li> <li>Keyword syntax highlighting introduced in 0.25.4 was not always applied to keywords.</li> <li>Module reflections now have a custom <code>M</code> icon rather than sharing with the namespace icon. Note: The default CSS still colors both modules and namespaces the same, as it is generally uncommon to have both in a generated site.</li> <li>If all members in a group are hidden from the page, the group will be hidden in the page index on page load.</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.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 "Type Parameters" 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> <h3>Bug Fixes</h3> <ul> <li>If both an interface and a variable share a name/symbol, TypeDoc will no longer link to the variable when referenced in a type position, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2106">#2106</a>.</li> <li><code>notDocumented</code> validation will no longer require documentation for data within parameters that cannot be documented via <code>@param</code>, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2291">#2291</a>.</li> <li>"defined in" locations for signatures will now always be contained within the function declaration's location. This prevents defined in sometimes pointing to node_modules, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2307">#2307</a>.</li> <li>Type parameters will now be resolved for arrow-methods on classes like regular class methods, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2320">#2320</a>.</li> <li>TypeDoc now inherits <code>typedocOptions</code> fields from extended tsconfig files, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2334">#2334</a>.</li> <li>Methods which return function types no longer have duplicated comments, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2336">#2336</a>.</li> <li>Comments on function-like type aliases will now show up under the type alias, rather than nested within the type declaration, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2372">#2372</a>.</li> <li>Improved detection of default values for parameters with destructured values, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2430">#2430</a>.</li> <li>Fix crash when converting some complicated union/intersection types, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2451">#2451</a>.</li> <li>Navigation triangle markers should no longer display on a separate line with some font settings, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2457">#2457</a>.</li> <li><code>@group</code> and <code>@category</code> organization is now applied later to allow inherited comments to create groups/categories, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2459">#2459</a>.</li> <li>Conversion order should no longer affect link resolution for classes with properties whose type does not rely on <code>this</code>, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2466">#2466</a>.</li> <li>Keyword syntax highlighting introduced in 0.25.4 was not always applied to keywords.</li> <li>Module reflections now have a custom <code>M</code> icon rather than sharing with the namespace icon. Note: The default CSS still colors both modules and namespaces the same, as it is generally uncommon to have both in a generated site.</li> <li>If all members in a group are hidden from the page, the group will be hidden in the page index on page load.</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/TypeStrong/typedoc/commit/0dd9d08350a72c285c1b09b65f0da83e33e25dd7"><code>0dd9d08</code></a> Update changelog for release</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/59ead4468981ef379954ff4419cf50c138b3dcdb"><code>59ead44</code></a> Bump version to 0.25.7</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/91c8d1c0c60b753c1b7e71aabab1d8fb8a3c96c2"><code>91c8d1c</code></a> Correct handling of unions of unions</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/7b558b0af03ed4177e3145a6fc337a0046641611"><code>7b558b0</code></a> Fix <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2476">#2476</a></li> <li><a href="https://github.com/TypeStrong/typedoc/commit/972d4f71530d95c4ee96df98152054fcc66990b1"><code>972d4f7</code></a> Update changelog for release</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/759aa647232b685d472e32b1ec76fccbfc6d9ce2"><code>759aa64</code></a> Bump version to 0.25.6</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/99a8da5c0cb5a2ec32a58ae7f0a15c3e38703148"><code>99a8da5</code></a> Improve recursive type detection</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/914f9bbed59b1503a01affb1da381226eccdb5e6"><code>914f9bb</code></a> Fix infinite loop</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/3e2240c87fa61d537d881e9dd919635d56fee842"><code>3e2240c</code></a> Update supported versions in SECURITY</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/f632cd8f0ecaee6e44675f195ca41b89bef8d7cf"><code>f632cd8</code></a> Update changelog for release</li> <li>Additional commits viewable in <a href="https://github.com/TypeStrong/TypeDoc/compare/v0.25.4...v0.25.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.25.4&new-version=0.25.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 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> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Steve Hobbs <[email protected]>
- Loading branch information