Skip to content

Commit

Permalink
chore(deps): Bump typedoc from 0.23.28 to 0.24.0 (#553)
Browse files Browse the repository at this point in the history
Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.23.28 to 0.24.0.
<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.24.0</h2>
<h3>Breaking Changes</h3>
<ul>
<li><code>@link</code>, <code>@linkcode</code> and <code>@linkplain</code> tags will now be resolved with TypeScript's link resolution by default. The <code>useTsLinkResolution</code> option
can be used to turn this behavior off, but be aware that doing so will mean your links will be resolved differently by editor tooling and TypeDoc.</li>
<li>TypeDoc will no longer automatically load plugins from <code>node_modules</code>. Specify the <code>--plugin</code> option to indicate which modules should be loaded.</li>
<li>The <code>packages</code> entry point strategy will now run TypeDoc in each provided package directory and then merge the results together.
The previous <code>packages</code> strategy has been preserved under <code>legacy-packages</code> and will be removed in 0.25. If the new strategy does not work
for your use case, please open an issue.</li>
<li>Removed <code>--logger</code> option, to disable all logging, set the <code>logLevel</code> option to <code>none</code>.</li>
<li>Dropped support for legacy <code>[[link]]</code>s, removed deprecated <code>Reflection.findReflectionByName</code>.</li>
<li>Added <code>@overload</code> to default ignored tags.</li>
</ul>
<h3>API Breaking Changes</h3>
<ul>
<li>The <code>label</code> property on <code>Reflection</code> has moved to <code>Comment</code>.</li>
<li>The default value of the <code>out</code> option has been changed from <code>&quot;&quot;</code> to <code>&quot;./docs&quot;</code>, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2195">#2195</a>.</li>
<li>Renamed <code>DeclarationReflection#version</code> to <code>DeclarationReflection#projectVersion</code> to match property on <code>ProjectReflection</code>.</li>
<li>Removed unused <code>Reflection#originalName</code>.</li>
<li>Removed <code>Reflection#kindString</code>, use <code>ReflectionKind.singularString(reflection.kind)</code> or <code>ReflectionKind.pluralString(reflection.kind)</code> instead.</li>
<li>The <code>named-tuple-member</code> and <code>template-literal</code> type kind have been replaced with <code>namedTupleMember</code> and <code>templateLiteral</code>, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2100">#2100</a>.</li>
<li>Properties related to rendering are no longer stored on <code>Reflection</code>, including <code>url</code>, <code>anchor</code>, <code>hasOwnDocument</code>, and <code>cssClasses</code>.</li>
<li><code>Application.bootstrap</code> will no longer load plugins. If you want to load plugins, use <code>Application.bootstrapWithPlugins</code> instead, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/1635">#1635</a>.</li>
<li>The options passed to <code>Application.bootstrap</code> will now be applied both before <em>and</em> after reading options files, which may cause a change in configuration
if using a custom script to run TypeDoc that includes some options, but other options are set in config files.</li>
<li>Moved <code>sources</code> property previously declared on base <code>Reflection</code> class to <code>DeclarationReflection</code> and <code>SignatureReflection</code>.</li>
<li>Moved <code>relevanceBoost</code> from <code>ContainerReflection</code> to <code>DeclarationReflection</code> since setting it on the parent class has no effect.</li>
<li>Removed internal <code>ReferenceType.getSymbol</code>, reference types no longer reference the <code>ts.Symbol</code> to enable generation from serialized JSON.</li>
<li><code>OptionsReader.priority</code> has been renamed to <code>OptionsReader.order</code> to more accurately reflect how it works.</li>
<li><code>ReferenceType</code>s which point to type parameters will now always be intentionally broken since they were never linked and should not be warned about when validating exports.</li>
<li><code>ReferenceType</code>s now longer include an <code>id</code> property for their target. They now instead include a <code>target</code> property.</li>
<li>Removed <code>Renderer.addExternalSymbolResolver</code>, use <code>Converter.addExternalSymbolResolver</code> instead.</li>
<li>Removed <code>CallbackLogger</code>.</li>
<li>Removed <code>SerializeEventData</code> from serialization events.</li>
<li>A <code>PageEvent</code> is now required for <code>getRenderContext</code>. If caching the context object, <code>page</code> must be updated when <code>getRenderContext</code> is called.</li>
<li><code>PageEvent</code> no longer includes the <code>template</code> property. The <code>Theme.render</code> method is now expected to take the template to render the page with as its second argument.</li>
<li>Removed <code>secondaryNavigation</code> member on <code>DefaultThemeRenderContext</code>.</li>
<li>Renamed <code>navigation</code> to <code>sidebar</code> on <code>DefaultThemeRenderContext</code> and <code>navigation.begin</code>/<code>navigation.end</code> hooks to <code>sidebar.begin</code>/<code>sidebar.end</code>.</li>
</ul>
<h3>Features</h3>
<ul>
<li>Added <code>--useTsLinkResolution</code> option (on by default) which tells TypeDoc to use TypeScript's <code>@link</code> resolution.</li>
<li>Added <code>--jsDocCompatibility</code> option (on by default) which controls TypeDoc's automatic detection of code blocks in <code>@example</code> and <code>@default</code> tags.</li>
<li>Reworked default theme navigation to add support for a page table of contents, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/1478">#1478</a>, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2189">#2189</a>.</li>
<li>Added support for <code>@interface</code> on type aliases to tell TypeDoc to convert the fully resolved type as an interface, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/1519">#1519</a></li>
<li>Added support for <code>@namespace</code> on variable declarations to tell TypeDoc to convert the variable as a namespace, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2055">#2055</a>.</li>
<li>Added support for <code>@prop</code>/<code>@Property</code> to specify documentation for a child property of a symbol, intended for use with <code>@interface</code>.</li>
<li>TypeDoc will now produce more informative error messages for options which cannot be set from the cli, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2022">#2022</a>.</li>
<li>TypeDoc will now attempt to guess what option you may have meant if given an invalid option name.</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>
<h1>v0.24.0 (2023-04-08)</h1>
<h3>Breaking Changes</h3>
<ul>
<li><code>@link</code>, <code>@linkcode</code> and <code>@linkplain</code> tags will now be resolved with TypeScript's link resolution by default. The <code>useTsLinkResolution</code> option
can be used to turn this behavior off, but be aware that doing so will mean your links will be resolved differently by editor tooling and TypeDoc.</li>
<li>TypeDoc will no longer automatically load plugins from <code>node_modules</code>. Specify the <code>--plugin</code> option to indicate which modules should be loaded.</li>
<li>The <code>packages</code> entry point strategy will now run TypeDoc in each provided package directory and then merge the results together.
The previous <code>packages</code> strategy has been preserved under <code>legacy-packages</code> and will be removed in 0.25. If the new strategy does not work
for your use case, please open an issue.</li>
<li>Removed <code>--logger</code> option, to disable all logging, set the <code>logLevel</code> option to <code>none</code>.</li>
<li>Dropped support for legacy <code>[[link]]</code>s, removed deprecated <code>Reflection.findReflectionByName</code>.</li>
<li>Added <code>@overload</code> to default ignored tags.</li>
</ul>
<h3>API Breaking Changes</h3>
<ul>
<li>The <code>label</code> property on <code>Reflection</code> has moved to <code>Comment</code>.</li>
<li>The default value of the <code>out</code> option has been changed from <code>&quot;&quot;</code> to <code>&quot;./docs&quot;</code>, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2195">#2195</a>.</li>
<li>Renamed <code>DeclarationReflection#version</code> to <code>DeclarationReflection#projectVersion</code> to match property on <code>ProjectReflection</code>.</li>
<li>Removed unused <code>Reflection#originalName</code>.</li>
<li>Removed <code>Reflection#kindString</code>, use <code>ReflectionKind.singularString(reflection.kind)</code> or <code>ReflectionKind.pluralString(reflection.kind)</code> instead.</li>
<li>The <code>named-tuple-member</code> and <code>template-literal</code> type kind have been replaced with <code>namedTupleMember</code> and <code>templateLiteral</code>, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2100">#2100</a>.</li>
<li>Properties related to rendering are no longer stored on <code>Reflection</code>, including <code>url</code>, <code>anchor</code>, <code>hasOwnDocument</code>, and <code>cssClasses</code>.</li>
<li><code>Application.bootstrap</code> will no longer load plugins. If you want to load plugins, use <code>Application.bootstrapWithPlugins</code> instead, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/1635">#1635</a>.</li>
<li>The options passed to <code>Application.bootstrap</code> will now be applied both before <em>and</em> after reading options files, which may cause a change in configuration
if using a custom script to run TypeDoc that includes some options, but other options are set in config files.</li>
<li>Moved <code>sources</code> property previously declared on base <code>Reflection</code> class to <code>DeclarationReflection</code> and <code>SignatureReflection</code>.</li>
<li>Moved <code>relevanceBoost</code> from <code>ContainerReflection</code> to <code>DeclarationReflection</code> since setting it on the parent class has no effect.</li>
<li>Removed internal <code>ReferenceType.getSymbol</code>, reference types no longer reference the <code>ts.Symbol</code> to enable generation from serialized JSON.</li>
<li><code>OptionsReader.priority</code> has been renamed to <code>OptionsReader.order</code> to more accurately reflect how it works.</li>
<li><code>ReferenceType</code>s which point to type parameters will now always be intentionally broken since they were never linked and should not be warned about when validating exports.</li>
<li><code>ReferenceType</code>s now longer include an <code>id</code> property for their target. They now instead include a <code>target</code> property.</li>
<li>Removed <code>Renderer.addExternalSymbolResolver</code>, use <code>Converter.addExternalSymbolResolver</code> instead.</li>
<li>Removed <code>CallbackLogger</code>.</li>
<li>Removed <code>SerializeEventData</code> from serialization events.</li>
<li>A <code>PageEvent</code> is now required for <code>getRenderContext</code>. If caching the context object, <code>page</code> must be updated when <code>getRenderContext</code> is called.</li>
<li><code>PageEvent</code> no longer includes the <code>template</code> property. The <code>Theme.render</code> method is now expected to take the template to render the page with as its second argument.</li>
<li>Removed <code>secondaryNavigation</code> member on <code>DefaultThemeRenderContext</code>.</li>
<li>Renamed <code>navigation</code> to <code>sidebar</code> on <code>DefaultThemeRenderContext</code> and <code>navigation.begin</code>/<code>navigation.end</code> hooks to <code>sidebar.begin</code>/<code>sidebar.end</code>.</li>
</ul>
<h3>Features</h3>
<ul>
<li>Added <code>--useTsLinkResolution</code> option (on by default) which tells TypeDoc to use TypeScript's <code>@link</code> resolution.</li>
<li>Added <code>--jsDocCompatibility</code> option (on by default) which controls TypeDoc's automatic detection of code blocks in <code>@example</code> and <code>@default</code> tags.</li>
<li>Reworked default theme navigation to add support for a page table of contents, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/1478">#1478</a>, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2189">#2189</a>.</li>
<li>Added support for <code>@interface</code> on type aliases to tell TypeDoc to convert the fully resolved type as an interface, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/1519">#1519</a></li>
<li>Added support for <code>@namespace</code> on variable declarations to tell TypeDoc to convert the variable as a namespace, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2055">#2055</a>.</li>
<li>Added support for <code>@prop</code>/<code>@Property</code> to specify documentation for a child property of a symbol, intended for use with <code>@interface</code>.</li>
<li>TypeDoc will now produce more informative error messages for options which cannot be set from the cli, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2022">#2022</a>.</li>
<li>TypeDoc will now attempt to guess what option you may have meant if given an invalid option name.</li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/TypeStrong/typedoc/commit/7a696ae1eba1e403bc03c729a951f850c01e4ef4"><code>7a696ae</code></a> Update changelog for release</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/4a762ace54ed2ff609596cab9fa79156ddc11ae4"><code>4a762ac</code></a> Bump version to 0.24.0</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/29069e0a02ba3d1487e2f825de31f9e1ec4d014d"><code>29069e0</code></a> Merge pull request <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2210">#2210</a> from TypeStrong/beta</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/27f550f3c88a34b54917ef723450df9e55d56672"><code>27f550f</code></a> Fix broken links in example</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/0c105ec7a025044aae143f692fe6315c481badc3"><code>0c105ec</code></a> One last bugfix</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/864db5780a6afc771df87e8c52e5b2b85e580e73"><code>864db57</code></a> Add jsDocCompatibility option</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/14c325b2d30ad5db885008f78878b51119bda0d4"><code>14c325b</code></a> Remove unused import</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/7fdb0aab26018a13fdbc4b536116ce4b167f4457"><code>7fdb0aa</code></a> Refactor tests to play better with Mocha test explorer</li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/234899df6cfcb488a880908ee348207e57964243"><code>234899d</code></a> Fix <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2220">#2220</a></li>
<li><a href="https://github.com/TypeStrong/typedoc/commit/ad480a454fd0bed18ed1c6449c229616013c801e"><code>ad480a4</code></a> Bump version to 0.24.0-beta.8</li>
<li>Additional commits viewable in <a href="https://github.com/TypeStrong/TypeDoc/compare/v0.23.28...v0.24.0">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.23.28&new-version=0.24.0)](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 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
dependabot[bot] authored Apr 9, 2023
1 parent aab5c07 commit 42af9a8
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
15 changes: 8 additions & 7 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
"ts-jest": "^27.1.4",
"ts-node": "^10.9.1",
"tslint": "^6.1.3",
"typedoc": "^0.23.28",
"typedoc": "^0.24.0",
"typescript": "^4.7.4"
},
"prettier": "@relaycorp/shared-config/.prettierrc.json",
Expand Down

0 comments on commit 42af9a8

Please sign in to comment.