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.25.4 to 0.26.11 #45

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

[Snyk] Upgrade typedoc from 0.25.4 to 0.26.11 #45

wants to merge 1 commit into from
+1 −1

Conversation

nerdy-tech-com-gitub
Copy link
Owner

@nerdy-tech-com-gitub nerdy-tech-com-gitub commented Dec 8, 2024 •
edited by sourcery-ai bot
Loading

snyk-top-banner

Snyk has created this PR to upgrade typedoc from 0.25.4 to 0.26.11.

ℹ️ 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 27 versions ahead of your current version.

  • The recommended version was released on a month ago.

Issues fixed by the recommended upgrade:

Issue Score Exploit Maturity
high severity Regular Expression Denial of Service (ReDoS)
SNYK-JS-CROSSSPAWN-8303230		 169 Proof of Concept
medium severity Regular Expression Denial of Service (ReDoS)
SNYK-JS-PATHTOREGEXP-7925106		 169 Proof of Concept
Release notes
Package name: typedoc
  • 0.26.11 - 2024-11-01

    Features

    • If hostedBaseUrl is set to the root page on a website, TypeDoc will now include WebSite structured data, #2760.

    Bug Fixes

    • Fix support for ESM config files with Node 23, #2752.
    • Fix type errors when using "module": "ESNext" and importing TypeDoc, #2747.
    • Inherited comments on overloaded methods now consider the overload position when inheriting a comment, #2755.
  • 0.26.10 - 2024-10-16

    Bug Fixes

    • Fixed missing space on page headers, #2748.
  • 0.26.9 - 2024-10-11

    Features

    • Added headings option to control optional headings, #2729.
    • Updated Chinese translations, #2739.
    • Added a folder icon to page navigation elements which are not links, #2741.

    Bug Fixes

    • externalSymbolLinkMappings now uses the TypeScript reported link target if available, #2725.
    • TypeDoc will no longer omit the modules page if a project contains only modules/documents, #2730.
    • Fixed missing breadcrumbs on project page, #2728.
    • TypeDoc will no longer render an empty readme page if no readme was found.

    Thanks!

  • 0.26.8 - 2024-10-04

    Features

    • Updated Chinese translations, #2706.
    • Exported constants no longer render the type and default value if they are the same, #2717.
    • The HTML output now wraps tag blocks with <div> tags and includes the tag name in a class name, #2723.

    Bug Fixes

    • Correctly handle external link resolver link text when referencing an external symbol, #2700.
    • Big integer literals are now supported as default values, #2721.
    • Corrected handling of @ link tags present in comments at the start of source files.
    • The index will now display when a module only contains documents, #2722.
    • ReflectionSymbolId.pos no longer references the position before any doc comments for a symbol.
      This could cause typedoc-plugin-dt-links to produce links which didn't go to the expected location in a file.

    Thanks!

  • 0.26.7 - 2024-09-09

    Features

    • Support TypeScript 5.6, #2699.
    • Added customJs option to include a script tag in generated HTML output, #2650.
    • Added markdownLinkExternal option to treat http[s]:// links in markdown documents and comments as external to be opened in a new tab, #2679.
    • Added navigation.excludeReferences option to prevent re-exports from appearing in the left hand navigation, #2685.
    • Added support for the @ abstract tag, #2692.

    Bug Fixes

    • Fixed an issue where links in packages mode would be resolved incorrectly, #2680.
    • @ link tags to symbols which are not included in the documentation will produce invalid link warnings again, #2681.
    • Fixed handling of @ param tags on comments attached to function callback parameters, #2683.
    • The alphabetical and alphabetical-ignoring-documents sort options now use localeCompare to sort, #2684.
    • Fixed incorrect placement of parameter default values in some signatures with a this parameter, #2698.

    Thanks!

  • 0.26.6 - 2024-08-18

    Features

    • Use of the @ extends block tag no longer produces warnings, #2659.
      This tag should only be used in JavaScript projects to specify the type parameters used when extending a parent class. It will not be rendered.
    • Added new navigation.compactFolders option to prevent TypeDoc from compacting folders, similar to the VSCode option. #2667.

    Bug Fixes

    • The suppressCommentWarningsInDeclarationFiles option now correctly ignores warnings in .d.cts and .d.mts files, #2647.
    • Restored re-exports in the page navigation menu, #2671.
    • JSON serialized projects will no longer contain reflection IDs for other projects created in the same run. Gerrit0/typedoc-plugin-zod#6.
    • In packages mode the reflection ID counter will no longer be reset when converting projects. This previously could result in links to files not working as expected.
  • 0.26.5 - 2024-07-21

    Features

    • TypeDoc now exposes array option defaults under OptionDefaults, #2640.

    Bug Fixes

    • Constructor parameters which share a name with a property on a parent class will no longer inherit the comment on the parent class, #2636.
    • Packages mode will now attempt to use the comment declared in the comment class for inherited members, #2622.
    • TypeDoc no longer crashes when @ document includes an empty file, #2638.
    • API: Event listeners added later with the same priority will be called later, #2643.

    Thanks!

  • 0.26.4 - 2024-07-10

    Bug Fixes

    • The page navigation sidebar no longer incorrectly includes re-exports if the same member is exported with multiple names #2625.
    • Page navigation now ensures the current page is visible when the page is first loaded, #2626.
    • If a relative linked image is referenced multiple times, TypeDoc will no longer sometimes produce invalid links to the image #2627.
    • @ link tags will now be validated in referenced markdown documents, #2629.
    • @ link tags are now resolved in project documents, #2629.
    • HTML/JSON output generated by TypeDoc now contains a trailing newline, #2632.
    • TypeDoc now correctly handles markdown documents with CRLF line endings, #2628.
    • @ hidden is now properly applied when placed in a function implementation comment, #2634.
    • Comments on re-exports are now rendered.

    Thanks!

  • 0.26.3 - 2024-06-28

    Features

    • "On This Page" navigation now includes the page groups in collapsible sections, #2616.

    Bug Fixes

    • mailto: links are no longer incorrectly recognized as relative paths, #2613.
    • Added @ since to the default list of recognized tags, #2614.
    • Relative paths to directories will no longer cause the directory to be copied into the media directory, #2617.
  • 0.26.2 - 2024-06-24

    Features

    • Added a --suppressCommentWarningsInDeclarationFiles option to disable warnings from
      parsing comments in declaration files, #2611.
    • Improved comment discovery to more closely match TypeScript's discovery when getting comments
      for members of interfaces/classes, #2084, #2545.

    Bug Fixes

    • The text non-highlighted language no longer causes warnings when rendering, #2610.
    • If a comment on a method is inherited from a parent class, and the child class does not
      use an @ param tag from the parent, TypeDoc will no longer warn about the @ param tag.
  • 0.26.1 - 2024-06-22
  • 0.26.0 - 2024-06-22
  • 0.26.0-beta.5 - 2024-06-16
  • 0.26.0-beta.4 - 2024-06-16
  • 0.26.0-beta.3 - 2024-06-09
  • 0.26.0-beta.2 - 2024-06-01
  • 0.26.0-beta.1 - 2024-05-06
  • 0.26.0-beta.0 - 2024-05-04
  • 0.25.13 - 2024-04-07
  • 0.25.12 - 2024-03-10
  • 0.25.11 - 2024-03-06
  • 0.25.10 - 2024-03-03
  • 0.25.9 - 2024-02-26
  • 0.25.8 - 2024-02-09
  • 0.25.7 - 2024-01-08
  • 0.25.6 - 2024-01-01
  • 0.25.5 - 2024-01-01
  • 0.25.4 - 2023-11-26
from typedoc GitHub release notes

Important

  • Check the changes in this PR to ensure they won't cause issues with your project.
  • This PR was automatically created by Snyk using the credentials of a real user.
  • Max score is 1000. Note that the real score may have changed since the PR was raised.

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:

Summary by Sourcery

Build:

  • Upgrade typedoc from version 0.25.4 to 0.26.11 in the package.json file.

@snyk-bot
fix: upgrade typedoc from 0.25.4 to 0.26.11
aadf28b 
Snyk has created this PR to upgrade typedoc from 0.25.4 to 0.26.11.

See this package in npm:
typedoc

See this project in Snyk:
https://app.snyk.io/org/nerds-github/project/1ce64081-e07a-4bf8-bb78-d92e784e5df0?utm_source=github&utm_medium=referral&page=upgrade-pr
@sourcery-ai Sourcery AI
Copy link

sourcery-ai bot commented Dec 8, 2024 •
edited
Loading

Reviewer's Guide by Sourcery

This PR upgrades the typedoc dependency from version 0.25.4 to 0.26.11 to address security vulnerabilities and include new features. The upgrade spans 27 versions and fixes two security issues: a high severity ReDoS vulnerability in cross-spawn and a medium severity ReDoS vulnerability in path-to-regexp.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Update typedoc development dependency to latest version
  • Bump version from 0.25.4 to 0.26.11
  • Fix high severity ReDoS vulnerability in cross-spawn dependency
  • Fix medium severity ReDoS vulnerability in path-to-regexp dependency
 packages/artifact/package.json
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Dec 8, 2024
View reviewed changes
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

We have skipped reviewing this pull request. Here's why:

  • It seems to have been created by a bot ('[Snyk]' found in title). We assume it knows what it's doing!
  • We don't review packaging changes - Let us know if you'd like us to change this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nerdy-tech-com-gitub @snyk-bot