Skip to content

Commit

Permalink
Merge #1722
Browse files Browse the repository at this point in the history
1722: build(deps-dev): bump typedoc from 0.25.13 to 0.26.7 r=flevi29 a=dependabot[bot]

Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.25.13 to 0.26.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.26.7</h2>
<h3>Features</h3>
<ul>
<li>Support TypeScript 5.6, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2699">#2699</a>.</li>
<li>Added <code>customJs</code> option to include a script tag in generated HTML output, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2650">#2650</a>.</li>
<li>Added <code>markdownLinkExternal</code> option to treat <code>http[s]://</code> links in markdown documents and comments as external to be opened in a new tab, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2679">#2679</a>.</li>
<li>Added <code>navigation.excludeReferences</code> option to prevent re-exports from appearing in the left hand navigation, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2685">#2685</a>.</li>
<li>Added support for the <code>`@abstract</code>` tag, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2692">#2692</a>.</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li>Fixed an issue where links in packages mode would be resolved incorrectly, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2680">#2680</a>.</li>
<li><code>`@link</code>` tags to symbols which are not included in the documentation will produce invalid link warnings again, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2681">#2681</a>.</li>
<li>Fixed handling of <code>`@param</code>` tags on comments attached to function callback parameters, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2683">#2683</a>.</li>
<li>The <code>alphabetical</code> and <code>alphabetical-ignoring-documents</code> sort options now use <code>localeCompare</code> to sort, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2684">#2684</a>.</li>
<li>Fixed incorrect placement of parameter default values in some signatures with a <code>this</code> parameter, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2698">#2698</a>.</li>
</ul>
<h3>Thanks!</h3>
<ul>
<li><a href="https://github.com/Aryakoste"><code>`@​Aryakoste</code></a></li>`
<li><a href="https://github.com/waynemwashuma"><code>`@​waynemwashuma</code></a></li>`
</ul>
<h2>v0.26.6</h2>
<h3>Features</h3>
<ul>
<li>Use of the <code>`@extends</code>` block tag no longer produces warnings, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2659">#2659</a>.
This tag should only be used in JavaScript projects to specify the type parameters used when extending a parent class. It will not be rendered.</li>
<li>Added new <code>navigation.compactFolders</code> option to prevent TypeDoc from compacting folders, similar to the VSCode option. <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2667">#2667</a>.</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li>The <code>suppressCommentWarningsInDeclarationFiles</code> option now correctly ignores warnings in <code>.d.cts</code> and <code>.d.mts</code> files, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2647">#2647</a>.</li>
<li>Restored re-exports in the page navigation menu, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2671">#2671</a>.</li>
<li>JSON serialized projects will no longer contain reflection IDs for other projects created in the same run. <a href="https://redirect.github.com/Gerrit0/typedoc-plugin-zod/issues/0">Gerrit0/typedoc-plugin-zod0</a>.</li>
<li>In packages mode the reflection ID counter will no longer be reset when converting projects. This previously could result in links to files not working as expected.</li>
</ul>
<h2>v0.26.5</h2>
<h3>Features</h3>
<ul>
<li>TypeDoc now exposes array option defaults under <code>OptionDefaults</code>, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2640">#2640</a>.</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li>Constructor parameters which share a name with a property on a parent class will no longer inherit the comment on the parent class, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2636">#2636</a>.</li>
<li>Packages mode will now attempt to use the comment declared in the comment class for inherited members, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2622">#2622</a>.</li>
<li>TypeDoc no longer crashes when <code>`@document</code>` includes an empty file, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2638">#2638</a>.</li>
<li>API: Event listeners added later with the same priority will be called later, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2643">#2643</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.26.7 (2024-09-09)</h2>
<h3>Features</h3>
<ul>
<li>Support TypeScript 5.6, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2699">#2699</a>.</li>
<li>Added <code>customJs</code> option to include a script tag in generated HTML output, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2650">#2650</a>.</li>
<li>Added <code>markdownLinkExternal</code> option to treat <code>http[s]://</code> links in markdown documents and comments as external to be opened in a new tab, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2679">#2679</a>.</li>
<li>Added <code>navigation.excludeReferences</code> option to prevent re-exports from appearing in the left hand navigation, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2685">#2685</a>.</li>
<li>Added support for the <code>`@abstract</code>` tag, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2692">#2692</a>.</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li>Fixed an issue where links in packages mode would be resolved incorrectly, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2680">#2680</a>.</li>
<li><code>`@link</code>` tags to symbols which are not included in the documentation will produce invalid link warnings again, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2681">#2681</a>.</li>
<li>Fixed handling of <code>`@param</code>` tags on comments attached to function callback parameters, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2683">#2683</a>.</li>
<li>The <code>alphabetical</code> and <code>alphabetical-ignoring-documents</code> sort options now use <code>localeCompare</code> to sort, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2684">#2684</a>.</li>
<li>Fixed incorrect placement of parameter default values in some signatures with a <code>this</code> parameter, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2698">#2698</a>.</li>
</ul>
<h3>Thanks!</h3>
<ul>
<li><a href="https://github.com/Aryakoste"><code>`@​Aryakoste</code></a></li>`
<li><a href="https://github.com/waynemwashuma"><code>`@​waynemwashuma</code></a></li>`
</ul>
<h2>v0.26.6 (2024-08-18)</h2>
<h3>Features</h3>
<ul>
<li>Use of the <code>`@extends</code>` block tag no longer produces warnings, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2659">#2659</a>.
This tag should only be used in JavaScript projects to specify the type parameters used when extending a parent class. It will not be rendered.</li>
<li>Added new <code>navigation.compactFolders</code> option to prevent TypeDoc from compacting folders, similar to the VSCode option. <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2667">#2667</a>.</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li>The <code>suppressCommentWarningsInDeclarationFiles</code> option now correctly ignores warnings in <code>.d.cts</code> and <code>.d.mts</code> files, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2647">#2647</a>.</li>
<li>Restored re-exports in the page navigation menu, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2671">#2671</a>.</li>
<li>JSON serialized projects will no longer contain reflection IDs for other projects created in the same run. <a href="https://redirect.github.com/Gerrit0/typedoc-plugin-zod/issues/0">Gerrit0/typedoc-plugin-zod0</a>.</li>
<li>In packages mode the reflection ID counter will no longer be reset when converting projects. This previously could result in links to files not working as expected.</li>
</ul>
<h2>v0.26.5 (2024-07-21)</h2>
<h3>Features</h3>
<ul>
<li>TypeDoc now exposes array option defaults under <code>OptionDefaults</code>, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2640">#2640</a>.</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li>Constructor parameters which share a name with a property on a parent class will no longer inherit the comment on the parent class, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2636">#2636</a>.</li>
<li>Packages mode will now attempt to use the comment declared in the comment class for inherited members, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2622">#2622</a>.</li>
<li>TypeDoc no longer crashes when <code>`@document</code>` includes an empty file, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2638">#2638</a>.</li>
<li>API: Event listeners added later with the same priority will be called later, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2643">#2643</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/c56c47816a47176355c25e67a8353a8ac5f463c8"><code>c56c478</code></a> Update changelog for release</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/c9b31359ce1d9d203918a0eb6d441395731b5fd2"><code>c9b3135</code></a> Bump version to 0.26.7</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/dc887b32b07ff8b43c553c9066d5ce9436cbad9e"><code>dc887b3</code></a> Rebuild specs</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/e10ab3e3ed269095f21d7ce0a23c4f2ba8a89366"><code>e10ab3e</code></a> Add support for TypeScript 5.6</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/15ba2dd5a62a5993f77beff44b00b7d9487a3bde"><code>15ba2dd</code></a> Merge pull request <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2693">#2693</a> from waynemwashuma/master</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/f4d71994fe7ffec1f0dc85072fb6deae63682113"><code>f4d7199</code></a> Merge branch 'master' into waynemwashuma/master</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/1ec446198d67a4e3912588947f823dd4f01c0afe"><code>1ec4461</code></a> Fully support <code>`@abstract</code>` tag</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/0682459efdcff3eea5922ae1d63679dc64421cd9"><code>0682459</code></a> Ignore deprecation lint</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/afd77e6015339982374e6e878dc252b621d267e9"><code>afd77e6</code></a> Finish customJs feature</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/12ba3d5586020d696c06e41fe92b941b6f29edab"><code>12ba3d5</code></a> Merge pull request <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2663">#2663</a> from Aryakoste/custom-js</li>
<li>Additional commits viewable in <a href="https://github.com/TypeStrong/TypeDoc/compare/v0.25.13...v0.26.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.13&new-version=0.26.7)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

You can trigger a rebase of this PR 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>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
  • Loading branch information
meili-bors[bot] and dependabot[bot] authored Sep 25, 2024
2 parents 1236082 + 87bb7a6 commit 0d23860
Show file tree
Hide file tree
Showing 2 changed files with 256 additions and 44 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@
"rollup-plugin-typescript2": "^0.36.0",
"shx": "^0.3.2",
"ts-jest": "^29.2.5",
"typedoc": "^0.25.13",
"typedoc": "^0.26.7",
"typescript": "^5.4.5"
},
"packageManager": "yarn@1.22.22"
Expand Down
Loading

0 comments on commit 0d23860

Please sign in to comment.