Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(deps): Bump typedoc from 0.27.4 to 0.27.6 (#236)
Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.27.4 to 0.27.6. <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.27.6</h2> <h3>Features</h3> <ul> <li>Added <code>ignoredHighlightLanguages</code> option to specify languages which will be allowed in code blocks but not highlighted, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2819">#2819</a>.</li> </ul> <h3>Bug Fixes</h3> <ul> <li><code>@include</code> and <code>@includecode</code> now work in the readme file, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2814">#2814</a>.</li> <li>TypeDoc will now avoid making references to references, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2811">#2811</a>.</li> <li>Fixed output specific option specification, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2818">#2818</a>.</li> <li>Improved type reference conversion to avoid including defaulted type arguments, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2820">#2820</a>.</li> <li>Fixed parsing of declaration references which include a module and a local reference, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2810">#2810</a>.</li> <li>Improved link resolution logic to prioritize type alias properties with the same symbol over type literal properties within function parameters.</li> </ul> <h2>v0.27.5</h2> <h3>Bug Fixes</h3> <ul> <li>Possibly Breaking: TypeDoc will no longer render anchors within the page for deeply nested properties. This only affects links to properties of properties of types, which did not have a clickable link exposed so are unlikely to have been linked to. Furthermore, these links were not always created by TypeDoc, only being created if all parent properties contained comments, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2808">#2808</a>.</li> <li>TypeDoc will now warn if a property which does not have a URL within the rendered document and the parent property/page will be linked to instead, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2808">#2808</a>. These warnings can be disabled with the <code>validation.rewrittenLink</code> option.</li> <li>Fix restoration of groups/categories including documents, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2801">#2801</a>.</li> <li>Fixed missed relative paths within markdown link references in documents.</li> <li>Improved handling of incomplete inline code blocks within markdown.</li> <li>Direct <code>https://</code> links under the <code>hostedBaseUrl</code> option's URL will no longer be treated as external, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2809">#2809</a>.</li> </ul> <h3>Thanks!</h3> <ul> <li><a href="https://github.com/SacDeNoeuds"><code>@SacDeNoeuds</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> <h2>v0.27.6 (2024-12-26)</h2> <h3>Features</h3> <ul> <li>Added <code>ignoredHighlightLanguages</code> option to specify languages which will be allowed in code blocks but not highlighted, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2819">#2819</a>.</li> </ul> <h3>Bug Fixes</h3> <ul> <li><code>@include</code> and <code>@includecode</code> now work in the readme file, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2814">#2814</a>.</li> <li>TypeDoc will now avoid making references to references, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2811">#2811</a>.</li> <li>Fixed output specific option specification, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2818">#2818</a>.</li> <li>Improved type reference conversion to avoid including defaulted type arguments, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2820">#2820</a>.</li> <li>Fixed parsing of declaration references which include a module and a local reference, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2810">#2810</a>.</li> <li>Improved link resolution logic to prioritize type alias properties with the same symbol over type literal properties within function parameters.</li> </ul> <h2>v0.27.5 (2024-12-14)</h2> <h3>Bug Fixes</h3> <ul> <li>Possibly Breaking: TypeDoc will no longer render anchors within the page for deeply nested properties. This only affects links to properties of properties of types, which did not have a clickable link exposed so are unlikely to have been linked to. Furthermore, these links were not always created by TypeDoc, only being created if all parent properties contained comments, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2808">#2808</a>.</li> <li>TypeDoc will now warn if a property which does not have a URL within the rendered document and the parent property/page will be linked to instead, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2808">#2808</a>. These warnings can be disabled with the <code>validation.rewrittenLink</code> option.</li> <li>Fix restoration of groups/categories including documents, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2801">#2801</a>.</li> <li>Fixed missed relative paths within markdown link references in documents.</li> <li>Improved handling of incomplete inline code blocks within markdown.</li> <li>Direct <code>https://</code> links under the <code>hostedBaseUrl</code> option's URL will no longer be treated as external, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2809">#2809</a>.</li> </ul> <h3>Thanks!</h3> <ul> <li><a href="https://github.com/SacDeNoeuds"><code>@SacDeNoeuds</code></a></li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/TypeStrong/typedoc/commit/9a1a719380422a2d9901910bb9f74e4c8e3f5382"><code>9a1a719</code></a> Update changelog for release</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/44bffe80ebeede3dac1d9a970a43d5f2159af71e"><code>44bffe8</code></a> Release v0.27.6</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/d62646802456126e3697afee269520f7b02275a9"><code>d626468</code></a> Fix <code>@link</code> with declaration reference using <code>!~</code></li> <li><a href="https://github.com/TypeStrong/typedoc/commit/9e667d06519f8c43df69ac0dbb3e6ac407ea1775"><code>9e667d0</code></a> Add ignoredHighlightLanguages option</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/9b62f0947dfb88801abad981789adb5939af37cf"><code>9b62f09</code></a> Fix output specific option specification</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/53fa22e577e174776c7c8f101c21c7c4e973a8c2"><code>53fa22e</code></a> Avoid including defaulted type arguments</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/b9177b46ac9246d4d955663e01fb523b649c23d0"><code>b9177b4</code></a> Update contributing docs</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/23008f617c34144c7e7a963a5aca1b2b04104c3e"><code>23008f6</code></a> Improve link resolution prioritization</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/2c10f676799e70f1fa5c45863e93c4cce9aa9de1"><code>2c10f67</code></a> Avoid references to references</li> <li><a href="https://github.com/TypeStrong/typedoc/commit/016e6a169fc0930afc5e031726c2d397b496133c"><code>016e6a1</code></a> Lock npm to 10 for CI</li> <li>Additional commits viewable in <a href="https://github.com/TypeStrong/TypeDoc/compare/v0.27.4...v0.27.6">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.27.4&new-version=0.27.6)](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