-
-
Notifications
You must be signed in to change notification settings - Fork 14
Commit b504ef5
authored
chore(deps): bump the typedoc group across 1 directory with 2 updates (#1222)
Bumps the typedoc group with 2 updates in the /tools/docs-gen directory:
[typedoc](https://github.com/TypeStrong/TypeDoc) and
[typedoc-plugin-missing-exports](https://github.com/Gerrit0/typedoc-plugin-missing-exports).
Updates `typedoc` from 0.27.9 to 0.28.1
<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.28.1</h2>
<h3>Features</h3>
<ul>
<li>The <code>TypeDocOptions</code> interface now marks options as
optional so it no longer has to be wrapped in <code>Partial</code>
for use in config files, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2901">#2901</a>.</li>
<li>API: Expose control methods for deferred conversion for plugin use
(typedoc-plugin-missing-exports)</li>
<li>API: Expose method to disable TypeDoc usage of
<code>localStorage</code> without clearing it, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2908">#2908</a>.</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li><code>--watch</code> can now infer entry points from
<code>package.json</code> as supported in non-watch mode, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2899">#2899</a>.</li>
<li><code>@include</code> with regions now works on files with CRLF line
endings, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2902">#2902</a>.</li>
<li>Generated page names now correctly handles UTF-8 characters
requiring more than 16 bits <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2905">#2905</a>.</li>
<li>Fixed a crash when converting <code>module.exports = []</code>, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2909">#2909</a>.</li>
<li>Fixed URL generation which introduced a superfluous <code>./</code>
in relative links, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2910">#2910</a>.</li>
</ul>
<h3>Thanks!</h3>
<ul>
<li><a
href="https://github.com/jsmith2-coveo"><code>@jsmith2-coveo</code></a></li>
<li><a
href="https://github.com/romainmnr"><code>@romainmnr</code></a></li>
</ul>
<h2>v0.28.0</h2>
<h3>Breaking Changes</h3>
<ul>
<li>TypeDoc now expects all input globs paths to be specified with
<code>/</code> path separators, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2825">#2825</a>.</li>
<li>TypeDoc's <code>--entryPointStrategy merge</code> mode now requires
JSON from at least version 0.28.0.</li>
<li>Removed <code>jp</code> translations from <code>lang</code>, to
migrate switch to <code>ja</code>.</li>
<li>File name references in <code>intentionallyNotExported</code> now
use a package name/package relative path instead of an absolute path for
matching.</li>
<li>The <code>source-order</code> sort ordering now considers package
names / package relative paths instead of using the absolute paths to a
file.</li>
<li>TypeDoc will only check for a project README file next to the
discovered <code>package.json</code> file if <code>--readme</code> is
not set
this change improves handling of monorepo setups where some packages
have readme files and others do not, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2875">#2875</a>.</li>
<li>Function-like variable exports will now only be automatically
converted as function types if
they are initialized with a function expression. TypeDoc can be
instructed to convert them as functions
with the <code>@function</code> tag, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2881">#2881</a>.</li>
<li>Object literal type alias types will now be converted in a way which
causes them to be rendered more similarly
to how interfaces are rendered, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2817">#2817</a>.</li>
</ul>
<h3>API Breaking Changes</h3>
<ul>
<li><code>ProjectReflection.getReflectionFromSymbol</code> and
<code>ProjectReflection.getSymbolFromReflection</code> have been moved
to <code>Context</code></li>
<li><code>Path</code> and <code>PathArray</code> parameter types now
always contain normalized paths.</li>
<li>Introduced a <code>Router</code> which is used for URL creation.
<code>Reflection.url</code>,
<code>Reflection.anchor</code>, and
<code>Reflection.hasOwnDocument</code> have been removed.</li>
<li><code>Deserializer.reviveProject(s)</code> no longer accepts an
option to add project documents.</li>
<li><code>Deserializer.reviveProjects</code> now requires an
<code>alwaysCreateEntryPointModule</code> option.</li>
<li><code>Comment.serializeDisplayParts</code> no longer requires a
serializer argument.</li>
<li><code>ReflectionSymbolId.fileName</code> is now optional, TypeDoc
now stores a combination of a package name and package relative path
instead.
The <code>fileName</code> property will be present when initially
created, but is not serialized.</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.28.1 (2025-03-20)</h2>
<h3>Features</h3>
<ul>
<li>The <code>TypeDocOptions</code> interface now marks options as
optional so it no longer has to be wrapped in <code>Partial</code>
for use in config files, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2901">#2901</a>.</li>
<li>API: Expose control methods for deferred conversion for plugin use
(typedoc-plugin-missing-exports)</li>
<li>API: Expose method to disable TypeDoc usage of
<code>localStorage</code> without clearing it, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2908">#2908</a>.</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li><code>--watch</code> can now infer entry points from
<code>package.json</code> as supported in non-watch mode, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2899">#2899</a>.</li>
<li><code>@include</code> with regions now works on files with CRLF line
endings, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2902">#2902</a>.</li>
<li>Generated page names now correctly handles UTF-8 characters
requiring more than 16 bits <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2905">#2905</a>.</li>
<li>Fixed a crash when converting <code>module.exports = []</code>, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2909">#2909</a>.</li>
<li>Fixed URL generation which introduced a superfluous <code>./</code>
in relative links, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2910">#2910</a>.</li>
</ul>
<h3>Thanks!</h3>
<ul>
<li><a
href="https://github.com/jsmith2-coveo"><code>@jsmith2-coveo</code></a></li>
<li><a
href="https://github.com/romainmnr"><code>@romainmnr</code></a></li>
</ul>
<h2>v0.28.0 (2025-03-15)</h2>
<h3>Breaking Changes</h3>
<ul>
<li>TypeDoc now expects all input globs paths to be specified with
<code>/</code> path separators, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2825">#2825</a>.</li>
<li>TypeDoc's <code>--entryPointStrategy merge</code> mode now requires
JSON from at least version 0.28.0.</li>
<li>Removed <code>jp</code> translations from <code>lang</code>, to
migrate switch to <code>ja</code>.</li>
<li>File name references in <code>intentionallyNotExported</code> now
use a package name/package relative path instead of an absolute path for
matching.</li>
<li>The <code>source-order</code> sort ordering now considers package
names / package relative paths instead of using the absolute paths to a
file.</li>
<li>TypeDoc will only check for a project README file next to the
discovered <code>package.json</code> file if <code>--readme</code> is
not set
this change improves handling of monorepo setups where some packages
have readme files and others do not, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2875">#2875</a>.</li>
<li>Function-like variable exports will now only be automatically
converted as function types if
they are initialized with a function expression. TypeDoc can be
instructed to convert them as functions
with the <code>@function</code> tag, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2881">#2881</a>.</li>
<li>Object literal type alias types will now be converted in a way which
causes them to be rendered more similarly
to how interfaces are rendered, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2817">#2817</a>.</li>
</ul>
<h3>API Breaking Changes</h3>
<ul>
<li><code>ProjectReflection.getReflectionFromSymbol</code> and
<code>ProjectReflection.getSymbolFromReflection</code> have been moved
to <code>Context</code></li>
<li><code>Path</code> and <code>PathArray</code> parameter types now
always contain normalized paths.</li>
<li>Introduced a <code>Router</code> which is used for URL creation.
<code>Reflection.url</code>,
<code>Reflection.anchor</code>, and
<code>Reflection.hasOwnDocument</code> have been removed.</li>
<li><code>Deserializer.reviveProject(s)</code> no longer accepts an
option to add project documents.</li>
<li><code>Deserializer.reviveProjects</code> now requires an
<code>alwaysCreateEntryPointModule</code> option.</li>
<li><code>Comment.serializeDisplayParts</code> no longer requires a
serializer argument.</li>
<li><code>ReflectionSymbolId.fileName</code> is now optional, TypeDoc
now stores a combination of a package name and package relative path
instead.
The <code>fileName</code> property will be present when initially
created, but is not serialized.</li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/6090b3e31471cea3728db1b03888bca5703b437e"><code>6090b3e</code></a>
Update changelog for release</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/6421662cd2b16a7385adb61bb6b767a862a6c629"><code>6421662</code></a>
Release v0.28.1</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/c7ac719aceb638bfd89d77e0b9df56a665fd9891"><code>c7ac719</code></a>
Update changelog</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/a49c6c8ae591dff3224d50170f01515d129d44e9"><code>a49c6c8</code></a>
Make clearing TypeDoc fields from local storage optional (<a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2908">#2908</a>)</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/b53a2208ac698ab1a8d74533fd7042d83776e019"><code>b53a220</code></a>
Fix <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2910">#2910</a></li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/34ce994d943b71e14457a0e8f5db986d546057d7"><code>34ce994</code></a>
Fix crash when converting array from module.exports</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/2d95afa72ed84d3a71bc451df6f5c63f73340802"><code>2d95afa</code></a>
Merge pull request <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2906">#2906</a>
from romainmnr/master</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/df1033f086c952253e7f052d5bbe6b5f68bcf90c"><code>df1033f</code></a>
style: remove useless spaces</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/c421520b789c75e47a5904ae3da9a8b2d1edad55"><code>c421520</code></a>
text(createNormalizedUrl): add UTF8 & emoji tests</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/383e164c6a090c9e6d716337513384bcd8cfa489"><code>383e164</code></a>
fix(createNormalizedUrl): replace String.fromCharCode by
String.fromCodePoint</li>
<li>Additional commits viewable in <a
href="https://github.com/TypeStrong/TypeDoc/compare/v0.27.9...v0.28.1">compare
view</a></li>
</ul>
</details>
<br />
Updates `typedoc-plugin-missing-exports` from 3.1.0 to 4.0.0
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/Gerrit0/typedoc-plugin-missing-exports/blob/main/CHANGELOG.md">typedoc-plugin-missing-exports's
changelog</a>.</em></p>
<blockquote>
<h3>4.0.0 (2025-03-21)</h3>
<ul>
<li>BREAKING: Drop support for TypeDoc <0.28.1.</li>
<li>Support TypeDoc ^0.28.1, <a
href="https://redirect.github.com/Gerrit0/typedoc-plugin-missing-exports/issues/31">#31</a>.</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/Gerrit0/typedoc-plugin-missing-exports/commit/411e9cd81fe8cf7bba6d9fe469455a1c2f619ad9"><code>411e9cd</code></a>
Fix publish CI script</li>
<li><a
href="https://github.com/Gerrit0/typedoc-plugin-missing-exports/commit/4154e1dec5584aa4192e3f111f78650b0272adb3"><code>4154e1d</code></a>
Bump version to 4.0.0</li>
<li><a
href="https://github.com/Gerrit0/typedoc-plugin-missing-exports/commit/71b88dec79d13468fc214c20ead7dc454e957138"><code>71b88de</code></a>
Create .gitattributes</li>
<li><a
href="https://github.com/Gerrit0/typedoc-plugin-missing-exports/commit/3c7ffc14381afeb0348223f20f36cec41a5045a9"><code>3c7ffc1</code></a>
Format</li>
<li><a
href="https://github.com/Gerrit0/typedoc-plugin-missing-exports/commit/de8562b4ef179bfa01d757c79bbee672359339fb"><code>de8562b</code></a>
Update changelog</li>
<li><a
href="https://github.com/Gerrit0/typedoc-plugin-missing-exports/commit/17222cb69c491dda23b38f866d1699825f83739e"><code>17222cb</code></a>
Support TypeDoc 0.28</li>
<li><a
href="https://github.com/Gerrit0/typedoc-plugin-missing-exports/commit/e3a292535c73dd5215cb1a9d921dcba0f52421f7"><code>e3a2925</code></a>
WIP: Support TypeDoc 0.28</li>
<li><a
href="https://github.com/Gerrit0/typedoc-plugin-missing-exports/commit/132387410e390d0dd0ac548d51c6e1795f40b753"><code>1323874</code></a>
Merge pull request <a
href="https://redirect.github.com/Gerrit0/typedoc-plugin-missing-exports/issues/29">#29</a>
from max-nextcloud/patch-1</li>
<li><a
href="https://github.com/Gerrit0/typedoc-plugin-missing-exports/commit/5011e5ef6226729d9db6ffebd72a69b25943b278"><code>5011e5e</code></a>
Document installing as dev dependency</li>
<li><a
href="https://github.com/Gerrit0/typedoc-plugin-missing-exports/commit/a60705fa15b5ddb8a83cda87c1f1806fd25e6e27"><code>a60705f</code></a>
Correct supported versions in readme</li>
<li>See full diff in <a
href="https://github.com/Gerrit0/typedoc-plugin-missing-exports/compare/v3.1.0...v4.0.0">compare
view</a></li>
</ul>
</details>
<br />
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>1 parent e5bd7b5 commit b504ef5Copy full SHA for b504ef5
File tree
Expand file treeCollapse file tree
1 file changed
+2
-2
lines changedOpen diff view settings
Filter options
- tools/docs-gen
Expand file treeCollapse file tree
1 file changed
+2
-2
lines changedOpen diff view settings
Collapse file
tools/docs-gen/package.json
Copy file name to clipboardExpand all lines: tools/docs-gen/package.json+2-2Lines changed: 2 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
10 | | - | |
| 9 | + | |
| 10 | + | |
11 | 11 | | |
12 | 12 | | |
0 commit comments