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

chore: Update dependency typedoc to v0.22.7 #2089

Merged
merged 1 commit into from
Nov 2, 2021
Merged

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Nov 1, 2021

WhiteSource Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
typedoc (source) 0.21.9 -> 0.22.7 age adoption passing confidence

Release Notes

TypeStrong/TypeDoc

v0.22.7

Compare Source

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!

v0.22.6

Compare Source

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!

v0.22.5

Compare Source

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!

v0.22.4

Compare Source

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!

v0.22.3

Compare Source

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.

v0.22.2

Compare Source

Bug Fixes
  • Fix background color of tables in dark mode, closes #​1684.

v0.22.1

Compare Source

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.

v0.22.0

Compare Source

Breaking Changes
  • The packages and entryPoints options have been combined.
    To migrate configurations which used packages, replace packages with entryPoints and set entryPointStrategy to packages.
  • Renamed disableOutputCheck to cleanOutputDir to more clearly reflect its behavior.
  • The highlightTheme option has been split into lightHighlightTheme and darkHighlightTheme.
  • Removed poorly documented / poorly behaved toc option.
  • HTML output is now rendered with JSX instead of Handlebars, closes #​1631.
    This change provides major performance benefits, reducing rendering time by up to 10x for several benchmarked projects.
    It also allows themes to be easily type checked, preventing mistakes when creating custom themes.
    Removing Handlebars also fixed memory leaks when --watch was specified due to Handlebar's caching mechanism.
    This change breaks all existing custom themes, so a theme created for v0.21 or earlier will not work in v0.22.
    See internal-docs/custom-themes.md for documentation on how to create a custom theme in v0.22.
  • Removed the minimal theme that has been mostly broken for a long time.
  • Changed the default entryPointStrategy from expand to resolve.
Features
  • Added support for light/dark mode to the default theme, closes #​1641.
  • Added support for custom CSS with the new customCss option, closes #​1060.
  • Added support for linking to third party documentation sites, closes #​131. See internal-docs/third-party-symbols.md
    for documentation on how to create a plugin which enables this.
    Support for linking to MDN for global types is provided by typedoc-plugin-mdn-links.
  • Added entryPointStrategy to reduce confusion from new TypeDoc users on handling of entry points.
    There are three possible options:
    Option Behavior
    resolve (default) Expects all entry points to be contained within the root level tsconfig project. If a directory is given, includes <directory>/index as the entry point.
    expand Expects all entry points to be contained within the root level tsconfig project. If a directory is given, files within it are recursively expanded. This was the default behavior in v0.21.
    packages Corresponds to --packages in v0.21, behaves as documented in the Monorepo section in the readme.
  • Added support for typedocMain in package.json when using the packages strategy for resolving entry points.
  • Produce warnings when documentation is missing exports, closes #​1653. If using TypeDoc's API, this behavior is available through calling application.validate(project).
  • Added support for detecting "as const enums", closes #​1675.
  • Added hideLegend option, closes #​1108.
  • Added performance measurements to debug logging (--logLevel Verbose)
  • String literal indexed access types will create links to their referencing member if possible, closes #​1226.
Bug Fixes
  • Support inclusion patterns when expanding input files, closes #​1399.
  • Arrow keys can no longer select hidden search results.
  • The Legend header will no longer be included if there is nothing in the legend.
  • If a non-function uses @param, the name will not be dropped when rendering, closes #​1410.
API Breaking Changes
  • TypeDoc now specifies the "export" key in package.json, preventing plugins from importing internal paths.
    TypeDoc should now export all necessary structures (potentially marked with @internal if likely to change) from the root export.
  • The ReflectionKind values for Project, Module, Namespace, and Enum have changed.
  • Removed deprecated logger functions.
  • Dropped support for legacy plugins which use export=. Plugins are now required to export a load function.
  • Remove TypeParameterType, references to type parameters have produced a ReferenceType since v0.20.0.
  • Types no longer have a clone method. It inconsistently performed deep or shallow clones, and was not used by TypeDoc.
  • Types no longer contain an equals method. It was occasionally correct for medium-complexity types, and always incorrect for more complicated types.
Thanks!

v0.21.9 (2021-08-29)

Bug Fixes
Thanks!

v0.21.8 (2021-08-28)

Features
  • Upgrade Shiki to 0.9.8, adds support for several new highlighting languages
Thanks!

v0.21.7 (2021-08-27)

Features
  • Support for TypeScript 4.4, closes #​1664

v0.21.6 (2021-08-19)

Features
  • Add support for NO_COLOR environment variable (#​1650)
Bug Fixes
  • Handle undefined symbols in query types, closes #​1660
Thanks!

v0.21.5 (2021-07-31)

Features
Bug Fixes
  • Implicitly set noEmit unless --emit is provided, closes #​1639
Thanks!

v0.21.4 (2021-07-12)

Bug Fixes
  • Constructors did not have source information set, closes #​1626

v0.21.3 (2021-07-10)

Breaking Changes
  • Options may not be set once conversion starts. Enables a small perf improvement.
Bug Fixes
  • Improve detection for "property methods" to convert as methods, closes #​1624
  • Two members differing only by case produced broken links, closes #​1585
  • Resolve some memory leaks
Thanks!

v0.21.2 (2021-06-27)

Bug Fixes
  • Postpone resolution of inherited classes until their parents have been resolved, closes #​1580

v0.21.1 (2021-06-25)

Bug Fixes
  • Exclude empty modules from documentation, closes #​1607
  • readme could not be set to none in a config file, closes #​1608
  • Correctly handle minimatch excludes on Windows, closes #​1610

Configuration

📅 Schedule: "on the first day of the month" (UTC).

🚦 Automerge: Enabled.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, click this checkbox.

This PR has been generated by WhiteSource Renovate. View repository job log here.

@renovate renovate bot force-pushed the renovate/typedoc-0.x branch 8 times, most recently from c4ce121 to 9cb0051 Compare November 2, 2021 15:36
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from 9cb0051 to eb3098d Compare November 2, 2021 17:41
@renovate renovate bot merged commit 4e3b1b5 into main Nov 2, 2021
@renovate renovate bot deleted the renovate/typedoc-0.x branch November 2, 2021 19:09
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