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.13 to 0.26.2 (#1)
Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.25.13 to 0.26.2. <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.2</h2> <h3>Features</h3> <ul> <li>Added a <code>--suppressCommentWarningsInDeclarationFiles</code> option to disable warnings from parsing comments in declaration files, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2611">#2611</a>.</li> <li>Improved comment discovery to more closely match TypeScript's discovery when getting comments for members of interfaces/classes, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2084">#2084</a>, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2545">#2545</a>.</li> </ul> <h3>Bug Fixes</h3> <ul> <li>The <code>text</code> non-highlighted language no longer causes warnings when rendering, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2610">#2610</a>.</li> <li>If a comment on a method is inherited from a parent class, and the child class does not use an <code>@param</code> tag from the parent, TypeDoc will no longer warn about the <code>@param</code> tag.</li> </ul> <h2>v0.26.1</h2> <h3>Features</h3> <ul> <li>Improved Korean translation coverage, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2602">#2602</a>.</li> </ul> <h3>Bug Fixes</h3> <ul> <li>Added <code>@author</code> to the default list of recognized tags, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2603">#2603</a>.</li> <li>Anchor links are no longer incorrectly checked for relative paths, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2604">#2604</a>.</li> <li>Fixed an issue where line numbers reported in error messages could be incorrect, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2605">#2605</a>.</li> <li>Fixed relative link detection for markdown links containing code in their label, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2606">#2606</a>.</li> <li>Fixed an issue with packages mode where TypeDoc would use (much) more memory than required, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2607">#2607</a>.</li> <li>TypeDoc will no longer crash when asked to render highlighted code for an unsupported language, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2609">#2609</a>.</li> <li>Fixed an issue where relatively-linked files would not be copied to the output directory in packages mode.</li> <li>Fixed an issue where modifier tags were not applied to top level modules in packages mode.</li> <li>Fixed an issue where excluded tags were not removed from top level modules in packages mode.</li> <li><code>.jsonc</code> configuration files are now properly read as JSONC, rather than being passed to <code>require</code>.</li> </ul> <h3>Thanks!</h3> <ul> <li><a href="https://github.com/KNU-K"><code>@KNU-K</code></a></li> </ul> <h2>v0.26.0</h2> <h3>Breaking Changes</h3> <ul> <li>Drop support for Node 16.</li> <li>Moved from <code>marked</code> to <code>markdown-it</code> for parsing as marked has moved to an async model which supporting would significantly complicate TypeDoc's rendering code. This means that any projects setting <code>markedOptions</code> needs to be updated to use <code>markdownItOptions</code>. Unlike <code>marked@4</code>, <code>markdown-it</code> pushes lots of functionality to plugins. To use plugins, a JavaScript config file must be used with the <code>markdownItLoader</code> option.</li> <li>Updated Shiki from 0.14 to 1.x. This should mostly be a transparent update which adds another 23 supported languages and 13 supported themes. As Shiki adds additional languages, the time it takes to load the highlighter increases linearly. To avoid rendering taking longer than necessary, TypeDoc now only loads a few common languages. Additional languages can be loaded by setting the <code>--highlightLanguages</code> option.</li> <li>Changed default of <code>--excludePrivate</code> to <code>true</code>.</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.2 (2024-06-24)</h2> <h3>Features</h3> <ul> <li>Added a <code>--suppressCommentWarningsInDeclarationFiles</code> option to disable warnings from parsing comments in declaration files, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2611">#2611</a>.</li> <li>Improved comment discovery to more closely match TypeScript's discovery when getting comments for members of interfaces/classes, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2084">#2084</a>, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2545">#2545</a>.</li> </ul> <h3>Bug Fixes</h3> <ul> <li>The <code>text</code> non-highlighted language no longer causes warnings when rendering, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2610">#2610</a>.</li> <li>If a comment on a method is inherited from a parent class, and the child class does not use an <code>@param</code> tag from the parent, TypeDoc will no longer warn about the <code>@param</code> tag.</li> </ul> <h2>v0.26.1 (2024-06-22)</h2> <h3>Features</h3> <ul> <li>Improved Korean translation coverage, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2602">#2602</a>.</li> </ul> <h3>Bug Fixes</h3> <ul> <li>Added <code>@author</code> to the default list of recognized tags, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2603">#2603</a>.</li> <li>Anchor links are no longer incorrectly checked for relative paths, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2604">#2604</a>.</li> <li>Fixed an issue where line numbers reported in error messages could be incorrect, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2605">#2605</a>.</li> <li>Fixed relative link detection for markdown links containing code in their label, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2606">#2606</a>.</li> <li>Fixed an issue with packages mode where TypeDoc would use (much) more memory than required, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2607">#2607</a>.</li> <li>TypeDoc will no longer crash when asked to render highlighted code for an unsupported language, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2609">#2609</a>.</li> <li>Fixed an issue where relatively-linked files would not be copied to the output directory in packages mode.</li> <li>Fixed an issue where modifier tags were not applied to top level modules in packages mode.</li> <li>Fixed an issue where excluded tags were not removed from top level modules in packages mode.</li> <li><code>.jsonc</code> configuration files are now properly read as JSONC, rather than being passed to <code>require</code>.</li> </ul> <h3>Thanks!</h3> <ul> <li><a href="https://github.com/KNU-K"><code>@KNU-K</code></a></li> </ul> <h1>v0.26.0 (2024-06-22)</h1> <h3>Breaking Changes</h3> <ul> <li>Drop support for Node 16.</li> <li>Moved from <code>marked</code> to <code>markdown-it</code> for parsing as marked has moved to an async model which supporting would significantly complicate TypeDoc's rendering code. This means that any projects setting <code>markedOptions</code> needs to be updated to use <code>markdownItOptions</code>. Unlike <code>marked@4</code>, <code>markdown-it</code> pushes lots of functionality to plugins. To use plugins, a JavaScript config file must be used with the <code>markdownItLoader</code> option.</li> <li>Updated Shiki from 0.14 to 1.x. This should mostly be a transparent update which adds another 23 supported languages and 13 supported themes. As Shiki adds additional languages, the time it takes to load the highlighter increases linearly. To avoid rendering taking longer than necessary, TypeDoc now only loads a few common languages. Additional languages can be loaded by setting the <code>--highlightLanguages</code> option.</li> <li>Changed default of <code>--excludePrivate</code> to <code>true</code>.</li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/TypeStrong/typedoc/commit/e5ba1e8fae25a43fdb8e6ace061243f7a93dadf6"><code>e5ba1e8</code></a> Update changelog for release</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/f20ec832d3f6970006c21c6572b485bc9bf3d2a1"><code>f20ec83</code></a> Bump version to 0.26.2</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/5890d73f8846395588e0ddba1b18fc493143f034"><code>5890d73</code></a> Fix actions</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/16b2694c270ae0bc3c3a092e0c9a1b2d383c1d3b"><code>16b2694</code></a> Update comment discovery to more closely match TS</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/42a1759f09aca4eb6e568e9a0f8c678631380258"><code>42a1759</code></a> Add a test for <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2545">#2545</a></li> <li><a href="https://github.com/TypeStrong/typedoc/commit/657eb4bdae1ac6d9e897bcdb4567d9876f3f6338"><code>657eb4b</code></a> Add suppressCommentWarningsInDeclarationFiles option</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/8ebd7dbb5b12a5c3978d954511b3563c3dcbd339"><code>8ebd7db</code></a> Correctly handle <code>text</code> when highlighting</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/35958735717f0437ad9d0d7fc2274714d3fd1639"><code>3595873</code></a> Update changelog for release</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/81fb64d3544d0b128cc3cf90ed0d5c1ccee9597f"><code>81fb64d</code></a> Bump version to 0.26.1</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/6ef1053513c1feb50ad1934cdcaccbf5967c74d7"><code>6ef1053</code></a> Fix even more packages bugs</li> <li>Additional commits viewable in <a href="https://github.com/TypeStrong/TypeDoc/compare/v0.25.13...v0.26.2">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.2)](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] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
- Loading branch information