Skip to content

Commit

Permalink
chore(deps): bump typedoc from 0.26.11 to 0.27.2 in /tools/docs-gen i…
Browse files Browse the repository at this point in the history
…n the typedoc group across 1 directory (#1186)

Bumps the typedoc group with 1 update in the /tools/docs-gen directory:
[typedoc](https://github.com/TypeStrong/TypeDoc).

Updates `typedoc` from 0.26.11 to 0.27.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.27.2</h2>
<h3>Bug Fixes</h3>
<ul>
<li>Fix crash with TypeScript 5.5.x, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2789">#2789</a>.</li>
</ul>
<h2>v0.27.1</h2>
<h3>Bug Fixes</h3>
<ul>
<li>Include classes which inherit from another package in class
hierarchy in packages mode, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2467">#2467</a>.</li>
<li>Fixed handling of <code>@categoryDescription</code> and
<code>@groupDescription</code> on module pages, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2787">#2787</a>.</li>
<li>Fixed automatic discovery of entry points in packages mode.</li>
<li>Reverted accidental style change for hierarchy page introduced in
0.27.0</li>
<li>The hierarchy Expand/Collapse link will now only appear if the
hierarchies are different.</li>
</ul>
<h2>v0.27.0 (2024-11-27)</h2>
<h3>Breaking Changes</h3>
<ul>
<li>Convert to ESM to enable easier use of ESM-only dependencies.</li>
<li>Drop support for TypeScript &lt;5.0, no longer supported by
DefinitelyTyped</li>
<li>Relaxed requirements for file names and generated url fragments.
This may
result in a different file name structure, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2714">#2714</a>.</li>
<li>Anchors to document headings and reflections within a HTML generated
pages
have changed. They can be partially restored to the previous format by
setting <code>--sluggerConfiguration.lowercase false</code>. This change
was made to
more closely match the default behavior of GitHub's markdown rendering
and
VSCode's autocomplete when creating a relative link to an external
markdown
file.</li>
<li>Removed the <code>hideParameterTypesInTitle</code> option, this was
originally added as
a workaround for many signatures overflowing the available horizontal
space
in rendered pages. TypeDoc now has logic to wrap types/signatures
smartly,
so this option is no longer necessary.</li>
<li>Changed the default <code>kindSortOrder</code> to put references
last.</li>
<li>Changed the default <code>sort</code> order to use
<code>alphabetical-ignoring-documents</code>
instead of <code>alphabetical</code>.</li>
<li>Changed default of
<code>suppressCommentWarningsInDeclarationFiles</code> to
<code>true</code></li>
<li>API: Constructor signatures now use the parent class name as their
name
(e.g. <code>X</code>, not <code>new X</code>)</li>
<li>API: <code>@group</code>, <code>@category</code>,
<code>@groupDescription</code> and <code>@categoryDescription</code>
will no longer be removed from the reflections they are present on. They
are
skipped during rendering with the <code>notRenderedTags</code>
option.</li>
</ul>
<h3>Features</h3>
<ul>
<li>Add support for TypeScript 5.7</li>
<li>TypeDoc will now discover entry points from
<code>package.json</code> exports if they
are not provided manually, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/1937">#1937</a>.</li>
<li>Relative links to markdown files may now include
<code>#anchor</code> links to</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.27.2 (2024-11-29)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>Fix crash with TypeScript 5.5.x, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2789">#2789</a>.</li>
</ul>
<h2>v0.27.1 (2024-11-28)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>Include classes which inherit from another package in class
hierarchy in packages mode, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2467">#2467</a>.</li>
<li>Fixed handling of <code>@categoryDescription</code> and
<code>@groupDescription</code> on module pages, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2787">#2787</a>.</li>
<li>Fixed automatic discovery of entry points in packages mode.</li>
<li>Reverted accidental style change for hierarchy page introduced in
0.27.0</li>
<li>The hierarchy Expand/Collapse link will now only appear if the
hierarchies are different.</li>
</ul>
<h2>v0.27.0 (2024-11-27)</h2>
<h3>Breaking Changes</h3>
<ul>
<li>Convert to ESM to enable easier use of ESM-only dependencies.</li>
<li>Drop support for TypeScript &lt;5.0, no longer supported by
DefinitelyTyped</li>
<li>Relaxed requirements for file names and generated url fragments.
This may
result in a different file name structure, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2714">#2714</a>.</li>
<li>Anchors to document headings and reflections within a HTML generated
pages
have changed. They can be partially restored to the previous format by
setting <code>--sluggerConfiguration.lowercase false</code>. This change
was made to
more closely match the default behavior of GitHub's markdown rendering
and
VSCode's autocomplete when creating a relative link to an external
markdown
file.</li>
<li>Removed the <code>hideParameterTypesInTitle</code> option, this was
originally added as
a workaround for many signatures overflowing the available horizontal
space
in rendered pages. TypeDoc now has logic to wrap types/signatures
smartly,
so this option is no longer necessary.</li>
<li>Changed the default <code>kindSortOrder</code> to put references
last.</li>
<li>Changed the default <code>sort</code> order to use
<code>alphabetical-ignoring-documents</code>
instead of <code>alphabetical</code>.</li>
<li>Changed default of
<code>suppressCommentWarningsInDeclarationFiles</code> to
<code>true</code></li>
<li>API: Constructor signatures now use the parent class name as their
name
(e.g. <code>X</code>, not <code>new X</code>)</li>
<li>API: <code>@group</code>, <code>@category</code>,
<code>@groupDescription</code> and <code>@categoryDescription</code>
will no longer be removed from the reflections they are present on. They
are
skipped during rendering with the <code>notRenderedTags</code>
option.</li>
</ul>
<h3>Features</h3>
<ul>
<li>Add support for TypeScript 5.7</li>
<li>TypeDoc will now discover entry points from
<code>package.json</code> exports if they
are not provided manually, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/1937">#1937</a>.</li>
<li>Relative links to markdown files may now include
<code>#anchor</code> links to</li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/23e2c99c1ded520e0374ddf0f7f36b828e7e08a0"><code>23e2c99</code></a>
Update changelog for release</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/b6b9b019e6f6c6887706f063b0e8d36702966926"><code>b6b9b01</code></a>
Bump version to 0.27.2</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/ea631e0934b522938dfebac13b8ba89bf2037385"><code>ea631e0</code></a>
Fix external.d.ts unit test</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/7d38048f334404a4901c36e1fc6bcdaa25e89690"><code>7d38048</code></a>
Fix crash with TS 5.5.x</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/c3842c1d8336d65199161904498d58cc446eb74c"><code>c3842c1</code></a>
Minor improvements to API docs</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/663ce5498c5ca90a851cb635903dc3b715dd4372"><code>663ce54</code></a>
Add maintenance status to site</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/193b02ee44cc359ac3b79509a9382c6d200d1d97"><code>193b02e</code></a>
Simplify plugin/theme list generation on site</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/9a520d778b82e00949147471bf4b00a2a2aebf6b"><code>9a520d7</code></a>
Simpler handling of changelog in site</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/6142a5ee7671f5ccf3a110a7f7d076f7e20f3ce0"><code>6142a5e</code></a>
Update changelog for release</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/1ce36a41e5fbbef59fda8869ae121d40ffdc4038"><code>1ce36a4</code></a>
Bump version to 0.27.1</li>
<li>Additional commits viewable in <a
href="https://github.com/TypeStrong/TypeDoc/compare/v0.26.11...v0.27.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.26.11&new-version=0.27.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 <dependency name> major version` will close this
group update PR and stop Dependabot creating any more for the specific
dependency's major version (unless you unignore this specific
dependency's major version or upgrade to it yourself)
- `@dependabot ignore <dependency name> minor version` will close this
group update PR and stop Dependabot creating any more for the specific
dependency's minor version (unless you unignore this specific
dependency's minor version or upgrade to it yourself)
- `@dependabot ignore <dependency name>` will close this group update PR
and stop Dependabot creating any more for the specific dependency
(unless you unignore this specific dependency or upgrade to it yourself)
- `@dependabot unignore <dependency name>` will remove all of the ignore
conditions of the specified dependency
- `@dependabot unignore <dependency name> <ignore condition>` will
remove the ignore condition of the specified dependency and ignore
conditions


</details>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
  • Loading branch information
dependabot[bot] authored Nov 30, 2024
1 parent 1b921dd commit ccab204
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion tools/docs-gen/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"node": ">=20"
},
"dependencies": {
"typedoc": "^0.26.3",
"typedoc": "^0.27.2",
"typedoc-plugin-missing-exports": "^3.0.0"
}
}

0 comments on commit ccab204

Please sign in to comment.