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

[Snyk] Upgrade typedoc from 0.19.2 to 0.22.8 #12

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

Conversation

snyk-bot
Copy link

Snyk has created this PR to upgrade typedoc from 0.19.2 to 0.22.8.

merge advice
ℹ️ 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 104 versions ahead of your current version.
  • The recommended version was released 22 days ago, on 2021-11-07.

The recommended version fixes:

Severity Issue PriorityScore (*) Exploit Maturity
Regular Expression Denial of Service (ReDoS)
SNYK-JS-MARKED-1070800
589/1000
Why? Has a fix available, CVSS 7.5
No Known Exploit

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

Release notes
Package name: typedoc
  • 0.22.8 - 2021-11-07

    Features

    • Added hooks which can be used to inject HTML without completely replacing a template, #1773.
      See the documentation in custom-themes.md for details.

    Bug Fixes

    • Actually fixed @ category tag incorrectly appearing on function types if used on a type alias, #1745.
    • Fix error in console when a page contains no documentation items.

    Thanks!

  • 0.22.7 - 2021-10-25

    Features

    • Added support for GitHub enterprise projects with a githubprivate.com domain, #1743.
    • Added support for GitLab repositories, #1728.

    Bug Fixes

    • Replaced O(n^2) with O(1) implementation for determining unique IDs in a rendered page, #1755.
    • Fixed crash with when running in very large repositories, #1744.
    • Fixed visible gap after footer in dark mode if hideGenerator is set, #1749.
    • Fixed @ category tag incorrectly appearing on function types if used on a type alias, #1745.
    • Fixed incorrect JS to apply themes on page load, #1709 (again).
    • Accessors and index signatures are now properly marked as inherited on declaration creation, #1742.

    Thanks!

  • 0.22.6 - 2021-10-17

    Features

    • Added support for displaying identifiers & property access expressions in initializers, #1730.
    • Expanded support for variables tagged with @ enum to all variables whose property types are string literals, #1740.

    Bug Fixes

    • Fixed flash when navigating to a second page when OS theme does not match selected theme, #1709.
    • Fixed improper quoting of as const style enums, #1727.
    • Fixed handling of @ typeParam on type aliases, #1733.
    • Fixed handling of comment tags on function type aliases, #1734.
    • Paths in warnings about non-exported symbols are now consistently displayed across platforms, #1738.

    Thanks!

  • 0.22.5 - 2021-10-02

    Features

    • TypeDoc will now recognize @ param comments for destructured parameters and rename __namedParameters to the name specified
      in the @ param comment if the number of @ param comments match the number of parameters, resolves #1703.
    • The intentionallyNotExported option may now include file names/paths to limit its scope, for example, the following
      will suppress warnings from Foo in src/foo.ts not being exported, but will not suppress warnings if another Foo
      declared in src/utils/foo.ts is not exported.
      {
          "intentionallyNotExported": ["src/foo.ts:Foo"]
      }
    • The --emit option can now be used to more finely control what TypeDoc will emit.
      Value Behavior
      both Emit both documentation and JS.
      docs Emit documentation, but not JS (default).
      none Emit nothing, just convert and run validation.
      true Alias for both, for backwards compatibility. Will be removed in 0.23.
      false Alias for docs, for backwards compatibility. Will be removed in 0.23.

    Bug Fixes

    • TypeDoc will now only create one highlighter for rendering code, saving ~200-500ms for rendering time.
    • For compatibility with JSDoc, TypeDoc will now strip <caption> elements from @ example tags, resolves #1679.
    • TypeScript's emitDeclarationOnly compiler option is now supported, resolves #1716.
    • Fixed discovery of tsconfig.json when the provided path ends in .json, resolves #1712.
    • Fixed a crash when converting the globalThis namespace, could only be caused by a plugin.

    Thanks!

  • 0.22.4 - 2021-09-18

    Features

    • Flag option types like validation can now be set to true/false to enable/disable all flags within them.
    • Source code links now work with Bitbucket repositories, resolves #1615.
    • Added githubPages option (default: true), which will create a .nojekyll page in the generated output, resolves #1680.
    • MarkdownEvent is now exported, resolves #1696.

    Bug Fixes

    • Fixed the hamburger menu not being visible on mobile devices, fixes #1699.
    • Comments on function implementations with overloaded signatures will now be correctly handled, fixes #1697.

    Thanks!

  • 0.22.3 - 2021-09-12

    Bug Fixes

    • Switched the default highlighting themes back to light-plus and dark-plus, they were accidentally set to min-light and min-dark in v0.22.0.

    Features

    • Added new validation option which can be used to disable checks for non-exported symbols.
      On the command line, this can be specified with --validation.notExported true, or in an options file with:
      {
          "validation": {
              "notExported": true
          }
      }
    • Added invalidLink to validation option, deprecated listInvalidSymbolLinks, which will be removed in 0.23.
  • 0.22.2 - 2021-09-11

    Bug Fixes

    • Fix background color of tables in dark mode, closes #1684.
  • 0.22.1 - 2021-09-10

    Bug Fixes

    • Validation for non-exported symbols will now only produce one warning per symbol, instead of one warning per reference.
    • Syntax highlighting when the preferred color scheme is dark but dark theme is not explicitly selected will now properly use the dark highlighting theme.
  • 0.22.0 - 2021-09-10
    Read more
  • 0.22.0-beta.10 - 2021-09-05
  • 0.22.0-beta.9 - 2021-09-05
  • 0.22.0-beta.8 - 2021-09-04
  • 0.22.0-beta.7 - 2021-09-04
  • 0.22.0-beta.6 - 2021-08-30
  • 0.22.0-beta.5 - 2021-08-29
  • 0.22.0-beta.4 - 2021-08-19
  • 0.22.0-beta.2 - 2021-08-17
  • 0.22.0-beta.1 - 2021-08-13
  • 0.22.0-beta.0 - 2021-08-01
  • 0.21.9 - 2021-08-29

    Bug Fixes

    Thanks!

    • John Haugeland
  • 0.21.8 - 2021-08-28
  • 0.21.7 - 2021-08-27
  • 0.21.6 - 2021-08-19
  • 0.21.5 - 2021-07-31
  • 0.21.4 - 2021-07-12
  • 0.21.3 - 2021-07-10
  • 0.21.2 - 2021-06-27
  • 0.21.1 - 2021-06-25
  • 0.21.0 - 2021-06-18
  • 0.21.0-beta.4 - 2021-06-16
  • 0.21.0-beta.3 - 2021-06-15
  • 0.21.0-beta.2 - 2021-06-06
  • 0.21.0-beta.1 - 2021-06-05
  • 0.20.37 - 2021-06-16
  • 0.20.36 - 2021-04-23
  • 0.20.35 - 2021-04-03
  • 0.20.34 - 2021-03-25
  • 0.20.33 - 2021-03-22
  • 0.20.32 - 2021-03-14
  • 0.20.31 - 2021-03-14
  • 0.20.30 - 2021-03-06
  • 0.20.29 - 2021-03-04
  • 0.20.28 - 2021-02-23
  • 0.20.27 - 2021-02-20
  • 0.20.26 - 2021-02-20
  • 0.20.25 - 2021-02-15
  • 0.20.24 - 2021-02-11
  • 0.20.23 - 2021-02-06
  • 0.20.22 - 2021-02-06
  • 0.20.21 - 2021-02-05
  • 0.20.20 - 2021-01-31
  • 0.20.19 - 2021-01-25
  • 0.20.18 - 2021-01-24
  • 0.20.17 - 2021-01-23
  • 0.20.16 - 2021-01-17
  • 0.20.15 - 2021-01-16
  • 0.20.14 - 2021-01-09
  • 0.20.13 - 2021-01-06
  • 0.20.12 - 2021-01-05
  • 0.20.11 - 2021-01-04
  • 0.20.10 - 2021-01-03
  • 0.20.9 - 2021-01-02
  • 0.20.8 - 2021-01-01
  • 0.20.7 - 2021-01-01
  • 0.20.6 - 2021-01-01
  • 0.20.5 - 2020-12-30
  • 0.20.4 - 2020-12-30
  • 0.20.3 - 2020-12-29
  • 0.20.2 - 2020-12-29
  • 0.20.1 - 2020-12-29
  • 0.20.0 - 2020-12-28
  • 0.20.0-beta.33 - 2020-12-28
  • 0.20.0-beta.32 - 2020-12-27
  • 0.20.0-beta.31 - 2020-12-27
  • 0.20.0-beta.30 - 2020-12-27
  • 0.20.0-beta.29 - 2020-12-26
  • 0.20.0-beta.28 - 2020-12-26
  • 0.20.0-beta.27 - 2020-12-09
  • 0.20.0-beta.26 - 2020-12-07
  • 0.20.0-beta.25 - 2020-12-05
  • 0.20.0-beta.24 - 2020-11-28
  • 0.20.0-beta.23 - 2020-11-28
  • 0.20.0-beta.22 - 2020-11-28
  • 0.20.0-beta.21 - 2020-11-28
  • 0.20.0-beta.20 - 2020-11-28
  • 0.20.0-beta.19 - 2020-11-27
  • 0.20.0-beta.18 - 2020-11-27
  • 0.20.0-beta.17 - 2020-11-27
  • 0.20.0-beta.16 - 2020-11-26
  • 0.20.0-beta.15 - 2020-11-26
  • 0.20.0-beta.14 - 2020-11-26
  • 0.20.0-beta.13 - 2020-11-26
  • 0.20.0-beta.12 - 2020-11-25
  • 0.20.0-beta.11 - 2020-11-25
  • 0.20.0-beta.10 - 2020-11-25
  • 0.20.0-beta.9 - 2020-11-25
  • 0.20.0-beta.8 - 2020-11-02
  • 0.20.0-beta.7 - 2020-11-01
  • 0.20.0-beta.6 - 2020-11-01
  • 0.20.0-beta.5 - 2020-11-01
  • 0.20.0-beta.4 - 2020-10-25
  • 0.20.0-beta.3 - 2020-10-25
  • 0.20.0-beta.2 - 2020-10-25
  • 0.20.0-beta.1 - 2020-10-23
  • 0.19.2 - 2020-09-21
from typedoc GitHub release notes
Commit messages
Package name: typedoc
  • 69ffaec Bump version
  • 3f7489b Upgrade dependencies
  • 8c707b3 Add support for hooks within templates
  • 0853a1a Fix error on README page with expanded entry points
  • 774aa36 Fix schema generation for mapped options
  • 07a2d58 Fix @ category tag for real
  • 78c779b Merge pull request #1777 from RunDevelopment/issue1768
  • 2820068 Removed unused `no-js` class
  • 4cd215a Merge pull request #1775 from srmagura/example
  • ea4ed68 Merge pull request #1774 from srmagura/fix-changelog-months
  • 95dae10 Tweak the example's typedoc.json
  • 2e15113 Fix months being off by one in CHANGELOG
  • ae8bee9 Update changelog for release
  • 151138f Update lowest Node version used by CI
  • 55995ca Bump version to 0.22.7
  • 1ca522f Upgrade dependencies
  • 8528190 Update changelog
  • cae6ada Merge pull request #1762 from srmagura/package-lock
  • 4ca5e71 Merge pull request #1761 from srmagura/gitlab
  • a2a9cd4 Update CHANGELOG.md (GitLab)
  • 53ed8bd Implement GitLab source linking
  • 8c44bb3 Rename GitHubPlugin to SourceLinkPlugin
  • c045c3a Update package-lock.json
  • 89537bc Merge pull request #1754 from RunDevelopment/issue1746

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant