kpt-functions-sdk icon indicating copy to clipboard operation
kpt-functions-sdk copied to clipboard

[Snyk] Upgrade typedoc from 0.22.17 to 0.23.8

Open snyk-bot opened this issue 3 years ago • 0 comments

Snyk has created this PR to upgrade typedoc from 0.22.17 to 0.23.8.

merge advice :information_source: 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 18 versions ahead of your current version.
  • The recommended version was released 23 days ago, on 2022-07-17.
Release notes
Package name: typedoc
  • 0.23.8 - 2022-07-17

    Features

    • Added defined in links for classes, enums, #180.
    • Added support for *.ghe.com and *.github.us GitHub enterprise domains for source links, #2001.
    • Expose Converter.parseRawComment for plugins to parse additional markdown files, #2004.

    Bug Fixes

    • TypeDoc will no longer emit a warning for {@ link} containing a URL, #1980.
    • excludeNotDocumented will no longer remove functions/methods/accessors which are documented, #1994.
    • Fixed missing sources property on signature reflections #1996.

    Thanks!

  • 0.23.7 - 2022-07-09

    Bug Fixes

    • Tags must now contain whitespace after the tag name to be parsed as a tag, @ jest/globals in a comment will no longer be parsed as a tag #1990.
    • The private member visibility option will now be respected in generated sites, #1992.
    • Overload rendering will no longer be broken if JavaScript is disabled, #453.
    • All overloads are now shown at once rather than requiring clicks to see the documentation for each signature, #1100.
  • 0.23.6 - 2022-07-08

    Features

    • Improved support for --entryPointStrategy Packages. TypeDoc will now load package-specific configurations from package.json typedoc field. This configuration allows configuring a custom display name (typedoc.displayName) field, entry point (typedoc.entryPoint - this is equivalent and will override typedocMain), and path to a readme file to be rendered at the top of the package page (typedoc.readmeFile), #1658.
    • The --includeVersion option will now be respected by --entryPointStrategy Packages. Also, for this combination, missing version field in the root package.json will not issue a warning.
    • The navigation partial will now call the new settings, primaryNavigation, and secondaryNavigation partials, #1987.

    Bug Fixes

    • All warnings will be reported instead of only the first warning of a given type, #1981.
    • Include references will no longer be incorrectly parsed as links, #1986.
    • The generated schema.json on the website will now use enum values rather than enum names if possible.

    Thanks!

  • 0.23.5 - 2022-07-02

    Features

    • The DEBUG_SEARCH_WEIGHTS global variable can now be set on window to add search scoring information in the search results.
    • TypeDoc's icons are now available on DefaultThemeRenderContext.icons for use/modification by themes.
  • 0.23.4 - 2022-07-02

    Bug Fixes

    • TypeDoc no longer ignores project references if --entryPointStrategy Packages is set, #1976.
    • Boost computations are now done when creating the search index, resulting in a smaller search.js generated file.

    Features

    • The --exclude option will now be respected by --entryPointStrategy Packages and can be used to exclude package directories, #1959.
    • TypeDoc now emits an IndexEvent on the Renderer when preparing the search index, #1953.
    • Added new --searchInComments option to include comment text in the search index, #1553.
      Turning this option on will increase the size of your search index, potentially by an order of magnitude.
  • 0.23.3 - 2022-07-01

    Bug Fixes

    • Function properties in type space will no longer be interpreted as methods, #1637.
    • TypeDoc will no longer crash if a comment contains an empty @ example tag, #1967.
    • TypeDoc will now detect attempted inheritance from accessors and inherit from the getter or setter, #1968.
    • intentionallyNotExported will now properly respect qualified names, #1972.
    • Fixed missing namespace comments on export * as NS declarations, #1973.
    • Fixed missing comments on export const x = () => 123 function variables, #1973.
    • Exported variable functions with properties will now be converted as a function+namespace instead of a variable+namespace, #1651.
    • Validation warnings caused by missing documentation will now be formatted like other warnings which reference a declaration.
    • TypeDoc will no longer warn if both the get and set signatures of an accessor have a comment.

    Features

    • Added --htmlLang option to set the lang attribute in the generated HTML. Defaults to en, #1951.
    • Added --basePath option to override TypeDoc's detected root directory, #1924.
    • Added support for TypeDoc specific :getter and :setter meaning keywords in declaration references.
    • Warnings caused by comment contents will now do a better job of including the location of the text that caused the warning.
  • 0.23.2 - 2022-06-28

    Bug Fixes

    • Module comments will no longer be inappropriately attached to signatures, #1962.
    • Projects with a single entry point will now parse @ module comments in the entry point, #1963.
    • Removed duplicate "in comment" warning when parsing comments, #1964.
    • Reflections with a boost of <= 0 due to searchCategoryBoosts or searchGroupBoosts will be excluded from search.
  • 0.23.1 - 2022-06-26

    Bug Fixes

    • If a declaration has multiple comments associated with it, the last one should be used, #1961.
  • 0.23.0 - 2022-06-26 Read more
  • 0.23.0-beta.7 - 2022-06-25
  • 0.23.0-beta.6 - 2022-06-25
  • 0.23.0-beta.5 - 2022-06-20
  • 0.23.0-beta.4 - 2022-06-04
  • 0.23.0-beta.3 - 2022-06-03
  • 0.23.0-beta.2 - 2022-05-30
  • 0.23.0-beta.1 - 2022-04-19
  • 0.23.0-beta.0 - 2022-04-17
  • 0.22.18 - 2022-06-25

    Features

    • Relaxed restrictions on @ enum style enums to also permit non-literal strings and numbers, #1956.

    Bug Fixes

    • searchGroupBoosts was only computing the boost for the first reflection in a group, #1958.

    Thanks!

  • 0.22.17 - 2022-06-01
from typedoc GitHub release notes
Commit messages
Package name: typedoc
  • 5611232 Bump version to 0.23.8
  • f41f6c8 Do not emit warnings on urls within `@ link` tags
  • 9ed9f01 Update changelog
  • c14857e Merge branch 'master' into cary-hu/master
  • 3663469 Add tests, also fix accessors while we're here
  • ec9efa0 Fix source links for signatures
  • 70ab81a Expose `Converter.parseRawComment`
  • e13a8f7 Update changelog
  • 9e23a1d Add more Github Enterprise URLs
  • 7cff286 remove test case
  • 0f74511 fix formatting error
  • d527647 fix some warning
  • 7322a66 fix excludeNotDocumented behavior
  • dd15e08 Update changelog for release
  • 809e207 Bump version to 0.23.7
  • 7ceda7b Require whitespace after a tag name
  • c6e9bf9 Fix overload rendering
  • e4fbb1c Fix private filter
  • 5060fe2 Update changelog for release
  • c09ff78 Bump version to 0.23.6
  • 59a33de Partials: settings, primaryNavigation, secondaryNavigation
  • d9de9f7 Update changelog
  • 3dfb539 Do not attempt to resolve includes as links
  • 83a2735 Improve support for `--entryPointStrategy Packages` (#1977)

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

snyk-bot avatar Aug 10 '22 01:08 snyk-bot