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.26.11 to 0.27.6 #396

Merged
merged 2 commits into from
Jan 7, 2025

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Dec 30, 2024

Bumps typedoc from 0.26.11 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

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 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)

@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Dec 30, 2024
@dependabot dependabot bot requested a review from a team as a code owner December 30, 2024 00:19
@dependabot dependabot bot added the javascript Pull requests that update Javascript code label Dec 30, 2024
@dependabot dependabot bot requested review from a team as code owners December 30, 2024 00:19
@dependabot dependabot bot requested a review from nadineloepfe December 30, 2024 00:19
Copy link
Contributor

@andrewb1269hg andrewb1269hg left a comment

Choose a reason for hiding this comment

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

Version roll looks good.

@mishomihov00
Copy link
Contributor

@dependabot rebase

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.26.11 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.26.11...v0.27.6)

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

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/typedoc-0.27.6 branch from f99dc7c to 1f6954e Compare January 6, 2025 09:46
Copy link
Contributor

@andrewb1269hg andrewb1269hg left a comment

Choose a reason for hiding this comment

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

Code changes look good but we need to have good checks before merging.

@andrewb1269hg
Copy link
Contributor

@PavelSBorisov it looks like there's an issue with resolving dependencies, can you please take a look at this?

Verified

This commit was signed with the committer’s verified signature.
PavelSBorisov Pavel Borisov
…sion

Signed-off-by: PavelSBorisov <pavel.s.borisov@gmail.com>
Copy link

github-actions bot commented Jan 7, 2025

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 78.65% 523/665
🟡 Branches 64.34% 92/143
🟡 Functions 77.63% 118/152
🟡 Lines 79.94% 494/618

Test suite run success

153 tests passing in 11 suites.

Report generated by 🧪jest coverage report action from 944441e

@PavelSBorisov
Copy link
Member

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.

@andrewb1269hg this should be fixed now, please review again

@andrewb1269hg andrewb1269hg merged commit c8e130d into main Jan 7, 2025
15 checks passed
@andrewb1269hg andrewb1269hg deleted the dependabot/npm_and_yarn/typedoc-0.27.6 branch January 7, 2025 15:02
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 javascript Pull requests that update Javascript code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants