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

chore: bump typedoc from 0.25.4 to 0.25.11 #215

Closed
wants to merge 1 commit into from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Mar 6, 2024

Bumps typedoc from 0.25.4 to 0.25.11.

Release notes

Sourced from typedoc's releases.

v0.25.11

Bug Fixes

  • Fixed an issue introduced with 0.25.10 which causes the page index to initially render empty, #2514.
  • "On This Page" section is now smarter when handling page headings which do not follow the normal h1>h2>h3 process, #2515.

v0.25.10

Bug Fixes

  • Constructed references to enum types will be properly linked with @interface, #2508.
  • Comments on property-methods will no longer be duplicated in generated documentation, #2509.
  • Reduced rendered docs size by writing icons to a referenced SVG asset, #2505. For TypeDoc's docs, this reduced the rendered documentation size by ~30%.
  • The HTML docs now attempt to reduce repaints caused by dynamically loading the navigation, #2491.
  • When navigating to a link that contains an anchor, the page will now be properly highlighted in the page navigation.

v0.25.9

Features

  • Literal numeric unions will now be sorted during conversion, #2502.

Bug Fixes

  • Module readmes will now be included in JSON output, #2500.
  • Fixed crash when --excludeNotDocumented was used and the project contained a reference to a removed signature, #2496.
  • Fixed crash when converting an infinitely recursive type via a new --maxTypeConversionDepth option, #2507.
  • Type links in "Parameters" and "Type Parameters" sections of the page will now be correctly colored.

Thanks!

v0.25.8

Features

  • Added a new --sitemapBaseUrl option. When specified, TypeDoc will generate a sitemap.xml in your output folder that describes the site, #2480.
  • Added support for the @class tag. When added to a comment on a variable or function, TypeDoc will convert the member as a class, #2479. Note: This should only be used on symbols which actually represent a class, but are not declared as a class for some reason.
  • Added support for @groupDescription and @categoryDescription to provide a description of groups and categories, #2494.
  • API: Exposed Context.getNodeComment for plugin use, #2498.

Bug Fixes

  • Fixed an issue where a namespace would not be created for merged function-namespaces which are declared as variables, #2478.
  • A class which implements itself will no longer cause a crash when rendering HTML, #2495.
  • Variable functions which have construct signatures will no longer be converted as functions, ignoring the construct signatures.

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.25.11 (2024-03-06)

Bug Fixes

  • Fixed an issue introduced with 0.25.10 which causes the page index to initially render empty, #2514.
  • "On This Page" section is now smarter when handling page headings which do not follow the normal h1>h2>h3 process, #2515.

v0.25.10 (2024-03-03)

Bug Fixes

  • Constructed references to enum types will be properly linked with @interface, #2508.
  • Comments on property-methods will no longer be duplicated in generated documentation, #2509.
  • Reduced rendered docs size by writing icons to a referenced SVG asset, #2505. For TypeDoc's docs, this reduced the rendered documentation size by ~30%.
  • The HTML docs now attempt to reduce repaints caused by dynamically loading the navigation, #2491.
  • When navigating to a link that contains an anchor, the page will now be properly highlighted in the page navigation.

v0.25.9 (2024-02-26)

Features

  • Literal numeric unions will now be sorted during conversion, #2502.

Bug Fixes

  • Module readmes will now be included in JSON output, #2500.
  • Fixed crash when --excludeNotDocumented was used and the project contained a reference to a removed signature, #2496.
  • Fixed crash when converting an infinitely recursive type via a new --maxTypeConversionDepth option, #2507.
  • Type links in "Parameters" and "Type Parameters" sections of the page will now be correctly colored.

Thanks!

v0.25.8 (2024-02-09)

Features

  • Added a new --sitemapBaseUrl option. When specified, TypeDoc will generate a sitemap.xml in your output folder that describes the site, #2480.
  • Added support for the @class tag. When added to a comment on a variable or function, TypeDoc will convert the member as a class, #2479. Note: This should only be used on symbols which actually represent a class, but are not declared as a class for some reason.
  • Added support for @groupDescription and @categoryDescription to provide a description of groups and categories, #2494.
  • API: Exposed Context.getNodeComment for plugin use, #2498.

Bug Fixes

  • Fixed an issue where a namespace would not be created for merged function-namespaces which are declared as variables, #2478.
  • A class which implements itself will no longer cause a crash when rendering HTML, #2495.
  • Variable functions which have construct signatures will no longer be converted as functions, ignoring the construct signatures.

... (truncated)

Commits
  • 9a1a5af Update changelog for release
  • c72c621 Bump version to 0.25.11
  • 649c1fe Disable sitemap for base config to make comparisons easier
  • edd6b6b Improve weird header handling
  • 9124254 Fix empty index
  • b0796cb Update changelog for release
  • e16a236 Bump version to 0.25.10
  • 657045c Fix duplicate comments caused by signatures
  • 9751e31 Improve doc HTML output
  • 88d787c Fix links to constructed enum references
  • 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)

Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.25.4 to 0.25.11.
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.25.4...v0.25.11)

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

Signed-off-by: dependabot[bot] <[email protected]>
Copy link
Contributor Author

dependabot bot commented on behalf of github Mar 6, 2024

The following labels could not be found: Dependencies.

Copy link

codecov bot commented Mar 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.93%. Comparing base (a62fd2a) to head (6a6c5c3).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #215   +/-   ##
=======================================
  Coverage   99.93%   99.93%           
=======================================
  Files          65       65           
  Lines        7795     7795           
  Branches      659      659           
=======================================
  Hits         7790     7790           
  Misses          5        5           

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

Copy link
Contributor Author

dependabot bot commented on behalf of github Mar 11, 2024

Superseded by #218.

@dependabot dependabot bot closed this Mar 11, 2024
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/typedoc-0.25.11 branch March 11, 2024 07:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants