Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build(deps-dev): bump typedoc from 0.27.2 to 0.27.6 #1817

Merged
merged 2 commits into from
Jan 2, 2025

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jan 1, 2025

Bumps typedoc from 0.27.2 to 0.27.6.

Release notes

Sourced from typedoc's releases.

v0.27.6

Features

  • Added ignoredHighlightLanguages option to specify languages which will be allowed in code blocks but not highlighted, #2819.

Bug Fixes

  • @include and @includeCode now work in the readme file, #2814.
  • TypeDoc will now avoid making references to references, #2811.
  • Fixed output specific option specification, #2818.
  • Improved type reference conversion to avoid including defaulted type arguments, #2820.
  • Fixed parsing of declaration references which include a module and a local reference, #2810.
  • Improved link resolution logic to prioritize type alias properties with the same symbol over type literal properties within function parameters.

v0.27.5

Bug Fixes

  • 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, #2808.
  • 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, #2808. These warnings can be disabled with the validation.rewrittenLink option.
  • Fix restoration of groups/categories including documents, #2801.
  • Fixed missed relative paths within markdown link references in documents.
  • Improved handling of incomplete inline code blocks within markdown.
  • Direct https:// links under the hostedBaseUrl option's URL will no longer be treated as external, #2809.

Thanks!

v0.27.4

Features

  • API: Introduced new Converter.EVENT_CREATE_PROJECT event which fires when a project is created by the converter, #2800.

Bug Fixes

  • Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, #2796.

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.27.6 (2024-12-26)

Features

  • Added ignoredHighlightLanguages option to specify languages which will be allowed in code blocks but not highlighted, #2819.

Bug Fixes

  • @include and @includeCode now work in the readme file, #2814.
  • TypeDoc will now avoid making references to references, #2811.
  • Fixed output specific option specification, #2818.
  • Improved type reference conversion to avoid including defaulted type arguments, #2820.
  • Fixed parsing of declaration references which include a module and a local reference, #2810.
  • Improved link resolution logic to prioritize type alias properties with the same symbol over type literal properties within function parameters.

v0.27.5 (2024-12-14)

Bug Fixes

  • 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, #2808.
  • 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, #2808. These warnings can be disabled with the validation.rewrittenLink option.
  • Fix restoration of groups/categories including documents, #2801.
  • Fixed missed relative paths within markdown link references in documents.
  • Improved handling of incomplete inline code blocks within markdown.
  • Direct https:// links under the hostedBaseUrl option's URL will no longer be treated as external, #2809.

Thanks!

v0.27.4 (2024-12-09)

Features

  • API: Introduced new Converter.EVENT_CREATE_PROJECT event which fires when a project is created by the converter, #2800.

Bug Fixes

  • Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, #2796.

... (truncated)

Commits
  • 9a1a719 Update changelog for release
  • 44bffe8 Release v0.27.6
  • d626468 Fix @link with declaration reference using !~
  • 9e667d0 Add ignoredHighlightLanguages option
  • 9b62f09 Fix output specific option specification
  • 53fa22e Avoid including defaulted type arguments
  • b9177b4 Update contributing docs
  • 23008f6 Improve link resolution prioritization
  • 2c10f67 Avoid references to references
  • 016e6a1 Lock npm to 10 for CI
  • Additional commits viewable in compare view

Dependabot compatibility score

You can trigger a rebase of this PR by commenting @dependabot rebase.


Dependabot commands and options

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)

Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.27.2 to 0.27.6.
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.27.2...v0.27.6)

---
updated-dependencies:
- dependency-name: typedoc
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file skip-changelog The PR will not appear in the release changelogs labels Jan 1, 2025
Copy link

codecov bot commented Jan 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.20%. Comparing base (c324219) to head (b492d49).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1817   +/-   ##
=======================================
  Coverage   98.20%   98.20%           
=======================================
  Files          18       18           
  Lines        1562     1562           
  Branches      333      333           
=======================================
  Hits         1534     1534           
  Misses         28       28           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@flevi29 flevi29 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bors merge

meili-bors bot added a commit that referenced this pull request Jan 2, 2025
1817: build(deps-dev): bump typedoc from 0.27.2 to 0.27.6 r=flevi29 a=dependabot[bot]

Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.27.2 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>
<h2>v0.27.4</h2>
<h3>Features</h3>
<ul>
<li>API: Introduced new <code>Converter.EVENT_CREATE_PROJECT</code> event which fires when a project is created by the converter, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2800">#2800</a>.</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li>Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2796">#2796</a>.</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.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>
<h2>v0.27.4 (2024-12-09)</h2>
<h3>Features</h3>
<ul>
<li>API: Introduced new <code>Converter.EVENT_CREATE_PROJECT</code> event which fires when a project is created by the converter, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2800">#2800</a>.</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li>Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, <a href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2796">#2796</a>.</li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</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.2...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.2&new-version=0.27.6)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

You can trigger a rebase of this PR 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>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: F. Levi <[email protected]>
Copy link
Contributor

meili-bors bot commented Jan 2, 2025

Build succeeded!

And happy new year! 🎉

@meili-bors meili-bors bot merged commit 549d8d9 into main Jan 2, 2025
7 checks passed
@meili-bors meili-bors bot deleted the dependabot/npm_and_yarn/typedoc-0.27.6 branch January 2, 2025 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file skip-changelog The PR will not appear in the release changelogs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant