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.

Sign up for GitHub

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

Jump to bottom

[Snyk] Upgrade typedoc from 0.23.28 to 0.25.8 #12

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Snyk] Upgrade typedoc from 0.23.28 to 0.25.8 #12

wants to merge 1 commit into from

Conversation

B020239
Copy link
Owner

@B020239 B020239 commented Mar 9, 2024

This PR was automatically created by Snyk using the credentials of a real user.


Snyk has created this PR to upgrade typedoc from 0.23.28 to 0.25.8.

ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.

  • The recommended version is 26 versions ahead of your current version.
  • The recommended version was released a month ago, on 2024-02-09.

The recommended version fixes:

Severity Issue PriorityScore (*) Exploit Maturity
Incomplete List of Disallowed Inputs
SNYK-JS-BABELTRAVERSE-5962462		 572/1000
Why? Proof of Concept exploit, CVSS 9.3		 Proof of Concept
Improper Authorization
SNYK-JS-REACTDEVTOOLSCORE-6023999		 572/1000
Why? Proof of Concept exploit, CVSS 9.3		 Proof of Concept

(*) Note that the real score may have changed since the PR was raised.

Release notes
Package name: typedoc
  • 0.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.
    • The class hierarchy page will now include classes whose base class is not included in the documentation, #2486.
    • Fixed an issue where, if the index section was collapsed when loading the page, all content within it would be hidden until expanded, and a member visibility checkbox was changed.
    • API: Context.programs will no longer contain duplicates, #2498.
  • 0.25.7 - 2024-01-08

    Bug Fixes

    • Fixed an issue where a namespace would not be created for merged function-namespaces only containing types, #2476.
    • Fixed an infinite loop when converting a union type which directly contained another union type which refers to itself, #2469.
  • 0.25.6 - 2024-01-01

    Bug Fixes

    • Fixed infinite loop caused by a fix for some complicated union/intersection types, #2468.
    • Improved infinite loop detection in type converter to reduce false positives.
  • 0.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.
  • 0.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.
    • gitRevision will now be replaced in sourceLinkTemplate, #2434.
    • Improved handling of function-modules created with Object.assign, #2436.
    • TypeDoc will no longer warn about duplicate comments with warnings which point to a single comment, #2437
    • Fixed an infinite loop when skipLibCheck is used to ignore some compiler errors, #2438.
    • @ example tag titles will now be rendered in the example heading, #2440.
    • Correctly handle transient symbols in @ namespace-created namespaces, #2444.
    • TypeDoc no longer displays the "Hierarchy" section if there is no inheritance hierarchy to display.
    • Direct links to individual signatures no longer results in the signature being partially scrolled off the screen.

    Thanks!

  • 0.25.3 - 2023-10-29
    Read more
  • 0.25.2 - 2023-10-08
    Read more
  • 0.25.1 - 2023-09-04
    Read more
  • 0.25.0 - 2023-08-25
    Read more
  • 0.24.8 - 2023-06-04
    Read more
  • 0.24.7 - 2023-05-08
  • 0.24.6 - 2023-04-24
  • 0.24.5 - 2023-04-22
  • 0.24.4 - 2023-04-16
  • 0.24.3 - 2023-04-16
  • 0.24.2 - 2023-04-15
  • 0.24.1 - 2023-04-09
  • 0.24.0 - 2023-04-08
  • 0.24.0-beta.8 - 2023-04-03
  • 0.24.0-beta.7 - 2023-03-26
  • 0.24.0-beta.6 - 2023-03-25
  • 0.24.0-beta.5 - 2023-03-25
  • 0.24.0-beta.4 - 2023-03-25
  • 0.24.0-beta.3 - 2023-03-12
  • 0.24.0-beta.2 - 2023-03-06
  • 0.24.0-beta.1 - 2023-03-05
  • 0.23.28 - 2023-03-19
from typedoc GitHub release notes
Commit messages
Package name: typedoc

Compare

Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.

For more information:

🧐 View latest project report

🛠 Adjust upgrade PR settings

🔕 Ignore this dependency or unsubscribe from future upgrade PRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Investigate flaky test test-debug-signal-cluster
2 participants
@B020239 @snyk-bot