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(deps): update dependency typedoc to v0.22.3 #317

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

Conversation

renovate[bot]
Copy link

@renovate renovate bot commented Jun 18, 2021

WhiteSource Renovate

This PR contains the following updates:

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

Release Notes

TypeStrong/TypeDoc

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-07-29)

Bug Fixes
Thanks!

v0.21.8 (2021-07-28)

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

v0.21.7 (2021-07-27)

Features
  • Support for TypeScript 4.4, closes #​1664

v0.21.6 (2021-07-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-06-31)

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

v0.21.4 (2021-06-12)

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

v0.21.3 (2021-06-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-05-27)

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

v0.21.1 (2021-05-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

v0.21.9

Compare Source

Bug Fixes
Thanks!

v0.21.8

Compare Source

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

v0.21.7

Compare Source

Features
  • Support for TypeScript 4.4, closes #​1664

v0.21.6

Compare Source

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

v0.21.5

Compare Source

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

v0.21.4

Compare Source

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

v0.21.3

Compare Source

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

Compare Source

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

v0.21.1

Compare Source

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

v0.21.0

Compare Source

Breaking Changes
  • Drop support for Node v10
  • Plugins are now passed Application directly
  • Drop support for TypeScript 3.9
Features
  • Improve monorepos by adding support for TS entry points (#​1596)
  • Support for monorepos
  • Support for TypeScript 4.3
  • Add support for sorting reflections based on user criteria, closes #​112
  • Add the --treatWarningsAsErrors option, closes #​1568
  • The exclude option will now remove symbols re-exported from excluded files, closes #​1578
Bug Fixes
  • Correctly handle comments on function type aliases, closes #​799
  • Setters should always have a void return type, closes #​1215
  • Resolve paths in option files according to the config directory, closes #​1598, #​1442
  • Pick up doc comments for properties declared within a class's constructor, closes #​1255
  • Inherit comments from parent methods, closes #​1580
  • Correct handling for intentionally broken references
  • Inheritance from multiple Partial types was incorrectly converted, closes #​1579
Thanks!
  • efokschaner
  • Martin

v0.20.37 (2021-05-16)

Features
Bug Fixes
Thanks!
  • Martin
  • Nick

v0.20.36 (2021-03-23)

Features
  • use 'pretty' option when generating json
  • create 'pretty' option
Bug Fixes
  • Always write to stdout, even if redirected, closes #​1566
  • Create directories when writing JSON output
Thanks!
  • cAttte

v0.20.35 (2021-03-03)

Features
  • Include debugging information in highlighting error messages (#​1561)
Bug Fixes
  • Relax simple expression requirements for default values, closes #​1552
  • Handle #private getters + methods, closes #​1564
Thanks!
  • Masato Makino

v0.20.34 (2021-02-25)

Bug Fixes
  • Crash when converting recursive type alias, closes #​1547
  • Discover module comments for global files, closes #​1549
  • Detect references when export * is used, closes #​1551

v0.20.33 (2021-02-22)

Bug Fixes
  • Static properties of Error class incorrectly converted, closes #​1541, #​572

v0.20.32 (2021-02-14)

Bug Fixes
  • Correct crash with reflection types, closes #​1538

v0.20.31 (2021-02-14)

Bug Fixes
  • readonly tuples were recognized as arrays, closes #​1534
  • Constructors were improperly reported as inherited, closes #​1528, #​1527
Thanks!
  • Vladimir Ivakin

v0.20.30 (2021-02-06)

Bug Fixes
  • Categories should only appear once if specified multiple times, closes #​1522
  • Support JSDocNullableType, JSDocNonNullableType, closes #​1524
  • Remove undefined from optional property types, closes #​1525

v0.20.29 (2021-02-04)

Features
  • Support for TypeScript 4.2, closes #​1517

v0.20.28 (2021-01-23)

Bug Fixes
  • Detect visibility modifiers on accessors, closes #​1516

v0.20.27 (2021-01-20)

Features
  • preserve spaces in code blocks
Bug Fixes
  • Detect and normalize unique symbol names, closes #​1514
Thanks!
  • michaelf

v0.20.26 (2021-01-20)

Bug Fixes
  • Pick up optional/readonly from mapped types, closes #​1509

v0.20.25 (2021-01-15)

Features
  • Support for specifying comments on export declarations, closes #​1504

v0.20.24 (2021-01-11)

Features
  • add support for non .com gh enterprise domains (#​1507)
Thanks!
  • TUNER88

v0.20.23 (2021-01-06)

Bug Fixes
  • Missing namespace members when ns is created by re-exporting an entire module, closes #​1499
  • Set inheritedFrom on accessor signatures, closes #​1497, #​1498
Thanks!
  • Siddharth VP

v0.20.22 (2021-01-06)

Bug Fixes
  • Import from shiki rather than shiki-themes, closes #​1496

v0.20.21 (2021-01-05)

Bug Fixes
  • Missing exported members in file-as-namespace reflection, closes #​1493

v0.20.20 (2021-00-31)

Features
  • add highlight theme option
Bug Fixes
  • Missing comments on optional methods, closes #​1490
  • Avoid crash with removed project reflection, closes #​1489
  • function-namespaces were converted incorrectly, closes #​1483
  • add validation to highlightTheme option
Thanks!
  • Matthias Law

v0.20.19 (2021-00-25)

Features
  • Support for --watch, --preserveWatchOutput, --emit

v0.20.18 (2021-00-24)

Bug Fixes
  • Static methods added to the class manually in JS, closes #​1481

v0.20.17 (2021-00-23)

Features
  • Add support for copying item’s documentation by copying it from another API item
Bug Fixes
  • CommonJS export= with type exports, closes #​1476
Thanks!
  • dergash

v0.20.16 (2021-00-17)

Bug Fixes
  • Comments on projects were broken
  • Constructors were a bit broken

v0.20.15 (2021-00-16)

Features
  • Support for excludeInternal, closes #​1469
  • add option to read more categories from doc
Bug Fixes
  • Crash when converting @types/ws, closes #​1463
  • replace return with continue
  • excludeNotDocumented incorrectly ignored some symbols, closes #​1465
  • Support for JSDoc @enum tags, closes #​1464
Thanks!
  • Bruno Zorić

v0.20.14 (2021-00-09)

Bug Fixes
  • Crash with destructured export const, closes #​1462
  • Add support for optional types, closes #​1312
  • Add support for rest types, closes #​1457
  • Avoid using process.exit (#​1461)
Thanks!
  • Krisztián Balla

v0.20.13 (2021-00-06)

Bug Fixes
  • Use type nodes if converting a regular function, closes #​1454

v0.20.12 (2021-00-05)

Bug Fixes
  • Arrow methods did not have modifiers set properly, closes #​1452
  • Add support for import types, closes #​1453
  • Don't document type arguments if there are none (#​1451)
Thanks!
  • Krisztián Balla

v0.20.11 (2021-00-04)

Bug Fixes
  • Crash when converting a generic with a tuple constraint, closes #​1449

v0.20.10 (2021-00-03)

Bug Fixes
  • Errors due to bad options in tsconfig file were dropped, closes #​1444

v0.20.9 (2021-00-02)

Bug Fixes
  • Regression caused by 1886304
  • Parameter declarations might not exist, closes #​1443

v0.20.8 (2021-00-01)

Bug Fixes
  • CLI should not exit cleanly on unexpected error

v0.20.7 (2020-00-01)

Bug Fixes
  • Tuples could cause a crash

v0.20.6 (2020-00-01)

Features
Bug Fixes
  • Properly resolve type parameters, closes #​1438

v0.20.5 (2020-11-30)

Bug Fixes
  • Functions might not have a parent in global files, closes #​1436

v0.20.4 (2020-11-30)

Bug Fixes
  • --excludeNotDocumented didn't remove reflections, closes #​1435

v0.20.3 (2020-11-29)

Features
  • Improved support for global files, closes #​1424

v0.20.2 (2020-11-29)

Features
  • Better detection for declaration files defining a module
Bug Fixes
  • Negative literal types were converted incorrectly, closes #​1427
  • ArgumentsReader should warn if missing a value, closes #​1429
  • TS 3 converters for null, this types
  • Literal boolean converter in TS 3
  • Map bash, sh, shell to shellscript when highlighting, closes #​1432

v0.20.1 (2020-11-29)

Bug Fixes

v0.20.37

Compare Source

Features
Bug Fixes
Thanks!
  • Martin
  • Nick

Configuration

📅 Schedule: "every weekend" in timezone Asia/Tokyo.

🚦 Automerge: Disabled due to failing status checks.

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, check this box.

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

@renovate renovate bot assigned nju33 Jun 18, 2021
@renovate renovate bot changed the title chore(deps): update dependency typedoc to v0.21.0 chore(deps): update dependency typedoc to v0.21.1 Jun 25, 2021
@renovate renovate bot changed the title chore(deps): update dependency typedoc to v0.21.1 chore(deps): update dependency typedoc to v0.21.2 Jun 27, 2021
@renovate renovate bot changed the title chore(deps): update dependency typedoc to v0.21.2 chore(deps): update dependency typedoc to v0.21.3 Jul 10, 2021
@renovate renovate bot changed the title chore(deps): update dependency typedoc to v0.21.3 chore(deps): update dependency typedoc to v0.21.4 Jul 12, 2021
@renovate renovate bot changed the title chore(deps): update dependency typedoc to v0.21.4 chore(deps): update dependency typedoc to v0.21.5 Jul 31, 2021
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch 2 times, most recently from fecd875 to f06c425 Compare August 8, 2021 13:21
@renovate renovate bot changed the title chore(deps): update dependency typedoc to v0.21.5 chore(deps): update dependency typedoc to v0.21.6 Aug 19, 2021
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch 2 times, most recently from 994ee16 to 2e75f66 Compare August 27, 2021 17:38
@renovate renovate bot changed the title chore(deps): update dependency typedoc to v0.21.6 chore(deps): update dependency typedoc to v0.21.7 Aug 27, 2021
@renovate renovate bot changed the title chore(deps): update dependency typedoc to v0.21.7 chore(deps): update dependency typedoc to v0.21.8 Aug 28, 2021
@renovate renovate bot changed the title chore(deps): update dependency typedoc to v0.21.8 chore(deps): update dependency typedoc to v0.21.9 Aug 29, 2021
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch 2 times, most recently from e12e144 to b18e398 Compare September 4, 2021 10:43
@renovate renovate bot changed the title chore(deps): update dependency typedoc to v0.21.9 chore(deps): update dependency typedoc to v0.22.0 Sep 10, 2021
@renovate renovate bot changed the title chore(deps): update dependency typedoc to v0.22.0 chore(deps): update dependency typedoc to v0.22.1 Sep 10, 2021
@renovate renovate bot changed the title chore(deps): update dependency typedoc to v0.22.1 chore(deps): update dependency typedoc to v0.22.2 Sep 11, 2021
@renovate renovate bot changed the title chore(deps): update dependency typedoc to v0.22.2 chore(deps): update dependency typedoc to v0.22.3 Sep 12, 2021
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.

None yet

2 participants