hubmapconsortium / ccf-asct-reporter

HRA ASCT+B Reporter
https://hubmapconsortium.github.io/ccf-asct-reporter/
10 stars 5 forks source link

npm: bump typedoc from 0.23.28 to 0.25.5 #795

Closed dependabot[bot] closed 10 months ago

dependabot[bot] commented 11 months ago

Bumps typedoc from 0.23.28 to 0.25.5.

Release notes

Sourced from typedoc's releases.

v0.25.5

Features

  • Added a new hierarchy.html page to HTML output which displays the full inheritance hierarchy for classes included in the documentation, #182.
  • Added a --navigation.includeFolders (default: true) option to create nested navigation for projects which include many entry points, #2388.
  • Type parameters on functions/classes can will now link to the "Type Parameters" section, #2322. Type parameters have also been changed to have a distinct color from type aliases when rendering, which can be changed with custom CSS.
  • TypeDoc now provides warnings if a signature comment is directly specified on a signature and contains @param tags which do not apply, #2368.
  • Extended reflection preview view for interfaces to include type parameters, #2455.
  • Added special cases for converting methods which are documented as returning this or accepting this as a parameter, #2458. Note: This will only happen if a method is declared as method(): this, it will not happen if the method implicitly returns this as the compiler strips that information when creating types for a class instance.
  • Improved handling of functions with properties. Previous TypeDoc versions would always create a separate namespace for properties, now, TypeDoc will create a separate namespace if the function is declaration merged with a namespace. If the properties are added via Object.assign or via property assignment on the function TypeDoc will now instead add the properties to the function's page, #2461.

Bug Fixes

  • If both an interface and a variable share a name/symbol, TypeDoc will no longer link to the variable when referenced in a type position, #2106.
  • notDocumented validation will no longer require documentation for data within parameters that cannot be documented via @param, #2291.
  • "defined in" locations for signatures will now always be contained within the function declaration's location. This prevents defined in sometimes pointing to node_modules, #2307.
  • Type parameters will now be resolved for arrow-methods on classes like regular class methods, #2320.
  • TypeDoc now inherits typedocOptions fields from extended tsconfig files, #2334.
  • Methods which return function types no longer have duplicated comments, #2336.
  • Comments on function-like type aliases will now show up under the type alias, rather than nested within the type declaration, #2372.
  • Improved detection of default values for parameters with destructured values, #2430.
  • Fix crash when converting some complicated union/intersection types, #2451.
  • Navigation triangle markers should no longer display on a separate line with some font settings, #2457.
  • @group and @category organization is now applied later to allow inherited comments to create groups/categories, #2459.
  • Conversion order should no longer affect link resolution for classes with properties whose type does not rely on this, #2466.
  • Keyword syntax highlighting introduced in 0.25.4 was not always applied to keywords.
  • Module reflections now have a custom M icon rather than sharing with the namespace icon. Note: The default CSS still colors both modules and namespaces the same, as it is generally uncommon to have both in a generated site.
  • If all members in a group are hidden from the page, the group will be hidden in the page index on page load.

v0.25.4

Features

  • Added support for TypeScript 5.3, #2446.
  • TypeDoc will now render interfaces as code at the top of the page describing interfaces, #2449. This can be controlled through the new DefaultThemeRenderContext.reflectionPreview helper.
  • Improved type rendering to highlight keywords differently than symbols.

Bug Fixes

  • Fixed automatic declaration file resolution on Windows, #2416.
  • Fixed default option values on options declared by plugins in packages mode, #2433.

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.25.5 (2024-01-01)

Features

  • Added a new hierarchy.html page to HTML output which displays the full inheritance hierarchy for classes included in the documentation, #182.
  • Added a --navigation.includeFolders (default: true) option to create nested navigation for projects which include many entry points, #2388.
  • Type parameters on functions/classes can will now link to the "Type Parameters" section, #2322. Type parameters have also been changed to have a distinct color from type aliases when rendering, which can be changed with custom CSS.
  • TypeDoc now provides warnings if a signature comment is directly specified on a signature and contains @param tags which do not apply, #2368.
  • Extended reflection preview view for interfaces to include type parameters, #2455.
  • Added special cases for converting methods which are documented as returning this or accepting this as a parameter, #2458. Note: This will only happen if a method is declared as method(): this, it will not happen if the method implicitly returns this as the compiler strips that information when creating types for a class instance.
  • Improved handling of functions with properties. Previous TypeDoc versions would always create a separate namespace for properties, now, TypeDoc will create a separate namespace if the function is declaration merged with a namespace. If the properties are added via Object.assign or via property assignment on the function TypeDoc will now instead add the properties to the function's page, #2461.

Bug Fixes

  • If both an interface and a variable share a name/symbol, TypeDoc will no longer link to the variable when referenced in a type position, #2106.
  • notDocumented validation will no longer require documentation for data within parameters that cannot be documented via @param, #2291.
  • "defined in" locations for signatures will now always be contained within the function declaration's location. This prevents defined in sometimes pointing to node_modules, #2307.
  • Type parameters will now be resolved for arrow-methods on classes like regular class methods, #2320.
  • TypeDoc now inherits typedocOptions fields from extended tsconfig files, #2334.
  • Methods which return function types no longer have duplicated comments, #2336.
  • Comments on function-like type aliases will now show up under the type alias, rather than nested within the type declaration, #2372.
  • Improved detection of default values for parameters with destructured values, #2430.
  • Fix crash when converting some complicated union/intersection types, #2451.
  • Navigation triangle markers should no longer display on a separate line with some font settings, #2457.
  • @group and @category organization is now applied later to allow inherited comments to create groups/categories, #2459.
  • Conversion order should no longer affect link resolution for classes with properties whose type does not rely on this, #2466.
  • Keyword syntax highlighting introduced in 0.25.4 was not always applied to keywords.
  • Module reflections now have a custom M icon rather than sharing with the namespace icon. Note: The default CSS still colors both modules and namespaces the same, as it is generally uncommon to have both in a generated site.
  • If all members in a group are hidden from the page, the group will be hidden in the page index on page load.

v0.25.4 (2023-11-26)

Features

  • Added support for TypeScript 5.3, #2446.
  • TypeDoc will now render interfaces as code at the top of the page describing interfaces, #2449. This can be controlled through the new DefaultThemeRenderContext.reflectionPreview helper.
  • Improved type rendering to highlight keywords differently than symbols.

Bug Fixes

  • Fixed automatic declaration file resolution on Windows, #2416.
  • Fixed default option values on options declared by plugins in packages mode, #2433.

... (truncated)

Commits
  • f632cd8 Update changelog for release
  • 500706d Bump version to 0.25.5
  • 2ce3796 Add hierarchy.html page to docs
  • 0117c99 Add --navigation.includeFolders
  • 65c83a9 Conversion order should not affect link resolution
  • a0aa060 Link to type parameters on functions/classes
  • 5e108b6 Add warnings for bad @param tags
  • 1963bd1 Update dependencies
  • 2a7b4d0 Code cleanup
  • 6150075 Detect default values on destructured parameters
  • 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 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)
sonarcloud[bot] commented 11 months ago

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

dependabot[bot] commented 10 months ago

Superseded by #810.