chore(deps): update doc-dependencies #2037

renovate · 2023-04-11T12:17:49Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
@types/react (source)	`~18.0.32` -> `~18.0.35`
typedoc (source)	`~0.23.28` -> `~0.24.1`
vitepress (source)	`1.0.0-alpha.64` -> `1.0.0-alpha.65`

Release Notes

TypeStrong/TypeDoc

`v0.24.1`

Compare Source

Bug Fixes

Improve detection for legacy JSDoc @example tags, #2222.
The page footer will now appear at the bottom of the page even if the page is short, #2223.

`v0.24.0`

Compare Source

Breaking Changes

@link, @linkcode and @linkplain tags will now be resolved with TypeScript's link resolution by default. The useTsLinkResolution option
can be used to turn this behavior off, but be aware that doing so will mean your links will be resolved differently by editor tooling and TypeDoc.
TypeDoc will no longer automatically load plugins from node_modules. Specify the --plugin option to indicate which modules should be loaded.
The packages entry point strategy will now run TypeDoc in each provided package directory and then merge the results together.
The previous packages strategy has been preserved under legacy-packages and will be removed in 0.25. If the new strategy does not work
for your use case, please open an issue.
Removed --logger option, to disable all logging, set the logLevel option to none.
Dropped support for legacy [[link]]s, removed deprecated Reflection.findReflectionByName.
Added @overload to default ignored tags.

API Breaking Changes

The label property on Reflection has moved to Comment.
The default value of the out option has been changed from "" to "./docs", #2195.
Renamed DeclarationReflection#version to DeclarationReflection#projectVersion to match property on ProjectReflection.
Removed unused Reflection#originalName.
Removed Reflection#kindString, use ReflectionKind.singularString(reflection.kind) or ReflectionKind.pluralString(reflection.kind) instead.
The named-tuple-member and template-literal type kind have been replaced with namedTupleMember and templateLiteral, #2100.
Properties related to rendering are no longer stored on Reflection, including url, anchor, hasOwnDocument, and cssClasses.
Application.bootstrap will no longer load plugins. If you want to load plugins, use Application.bootstrapWithPlugins instead, #1635.
The options passed to Application.bootstrap will now be applied both before and after reading options files, which may cause a change in configuration
if using a custom script to run TypeDoc that includes some options, but other options are set in config files.
Moved sources property previously declared on base Reflection class to DeclarationReflection and SignatureReflection.
Moved relevanceBoost from ContainerReflection to DeclarationReflection since setting it on the parent class has no effect.
Removed internal ReferenceType.getSymbol, reference types no longer reference the ts.Symbol to enable generation from serialized JSON.
OptionsReader.priority has been renamed to OptionsReader.order to more accurately reflect how it works.
ReferenceTypes which point to type parameters will now always be intentionally broken since they were never linked and should not be warned about when validating exports.
ReferenceTypes now longer include an id property for their target. They now instead include a target property.
Removed Renderer.addExternalSymbolResolver, use Converter.addExternalSymbolResolver instead.
Removed CallbackLogger.
Removed SerializeEventData from serialization events.
A PageEvent is now required for getRenderContext. If caching the context object, page must be updated when getRenderContext is called.
PageEvent no longer includes the template property. The Theme.render method is now expected to take the template to render the page with as its second argument.
Removed secondaryNavigation member on DefaultThemeRenderContext.
Renamed navigation to sidebar on DefaultThemeRenderContext and navigation.begin/navigation.end hooks to sidebar.begin/sidebar.end.

Features

Added --useTsLinkResolution option (on by default) which tells TypeDoc to use TypeScript's @link resolution.
Added --jsDocCompatibility option (on by default) which controls TypeDoc's automatic detection of code blocks in @example and @default tags.
Reworked default theme navigation to add support for a page table of contents, #1478, #2189.
Added support for @interface on type aliases to tell TypeDoc to convert the fully resolved type as an interface, #1519
Added support for @namespace on variable declarations to tell TypeDoc to convert the variable as a namespace, #2055.
Added support for @prop/@property to specify documentation for a child property of a symbol, intended for use with @interface.
TypeDoc will now produce more informative error messages for options which cannot be set from the cli, #2022.
TypeDoc will now attempt to guess what option you may have meant if given an invalid option name.
Plugins may now return a Promise<void> from their load function, #185.
TypeDoc now supports plugins written with ESM, #1635.
Added Renderer.preRenderAsyncJobs and Renderer.postRenderAsyncJobs, which may be used by plugins to perform async processing for rendering, #185.
Note: Conversion is still intentionally a synchronous process to ensure stability of converted projects between runs.
TypeDoc options may now be set under the typedocOptions key in package.json, #2112.
Added --cacheBust option to tell TypeDoc to include include the generation time in files, #2124.
Added --excludeReferences option to tell TypeDoc to omit re-exports of a symbol already included from the documentation.
Introduced new render hooks pageSidebar.begin and pageSidebar.end.

Bug Fixes

TypeDoc will now ignore package.json files not containing a name field, #2190.
Fixed @inheritDoc on signatures (functions, methods, constructors, getters, setters) being unable to inherit from a non-signature.
Interfaces/classes created via extending a module will no longer contain variables/functions where the member should have been converted as properties/methods, #2150.
TypeDoc will now ignore a leading v in versions, #2212.
Category titles now render with the same format in the page index and heading title, #2196.
Fixed crash when using typeof on a reference with type arguments, #2220.
Fixed broken anchor links generated to signatures nested within objects.

Thanks!

v0.23.28 (2023-03-19)

Features

Added support for TypeScript 5.0, #2201.
- const type parameters.
- JSDoc @overload tag.
- JSDoc @satisfies tag.

v0.23.27 (2023-03-16)

Features

Added --treatValidationWarningsAsErrors to treat only validation warnings as errors without treating all warnings as errors, #2199.

Bug Fixes

Fixed a bug where optional properties were not appropriately marked as optional, #2200.
Fixed shifted navigation pane on devices 1024px wide, #2191.
Add missing @private and @protected tags to typedoc/tsdoc.json, #2187.

Thanks!

@futurGH

v0.23.26 (2023-02-26)

Features

Added Application.EVENT_VALIDATE_PROJECT event for plugins which implement custom validation, #2183.
Plugins may now return an object from external symbol resolvers, #2066.
Expose Comment.displayPartsToMarkdown on for themes overwriting the comment helper, #2115.

Bug Fixes

Fix crash when converting export default undefined, #2175.
Fix error in console when clicking on headings in the readme, #2170.
TypeDoc will now ignore parameters of callback parameters when validating that all parameters have documentation, #2154.

Thanks!

v0.23.25 (2023-02-11)

Breaking Changes

Upgraded Shiki, if your highlight theme was set to material-<theme>, the value will need to be changed to
material-theme-<theme>, see the Shiki release notes.

Features

Added new excludeNotDocumentedKinds variable to control which reflection types can be removed
by the excludeNotDocumented option, #2162.
Added typedoc.jsonc, typedoc.config.js, typedoc.config.cjs, typedoc.cjs to the list of files
which TypeDoc will automatically use as configuration files.

Bug Fixes

Entry points under node_modules will no longer be ignored, #2151.
Corrected behavior of excludeNotDocumented on arrow function-variables, #2156.
Added package.json to exports declaration.

Thanks!

v0.23.24 (2023-01-07)

Bug Fixes

Fixed an issue where signature comments were preferred over property comments for indirectly created function-properties, #2135.
Fixed symlink handling when expanding entry points, #2130.

Thanks!

@boneskull

v0.23.23 (2022-12-18)

Features

Added ts.Signature to emitted EVENT_CREATE_SIGNATURE event, #2002.

Bug Fixes

Links to members hidden by filter settings now temporarily override the filter, #2092.
If src/ and src/x are specified as entry points, src/ will no longer be ignored, #2121.

v0.23.22 (2022-12-11)

Features

Add support for defining the kind sort order, #2109.

Bug Fixes

Normalize all file paths on Windows, #2113.
Fix @link tags within lists, #2103.

v0.23.21 (2022-11-14)

Features

Added support for a catch-all wildcard in externalSymbolLinkMappings, #2102.
Added support for TypeScript 4.9.

Thanks!

@mistic100

v0.23.20 (2022-11-03)

Bug Fixes

Fixed comment discovery for @inheritDoc if inheriting from a function type alias, #2087.

v0.23.19 (2022-10-28)

Bug Fixes

Fixed title link if titleLink option was not specified, #2085.

Thanks!

@krisztianb

v0.23.18 (2022-10-23)

Features

Improved error reporting when failing to find entry points, #2080, #2082.

Bug Fixes

Constructor parameter-properties will now use the @param comment for the parameter if available, #1261.
Fixed display of object types containing methods, #1788.
Fixed conversion of intrinsic string mapping types when converting without a type node, #2079.

v0.23.17 (2022-10-18)

Features

Added titleLink, navigationLinks and sidebarLinks options to add additional links to the rendered output, #1830.
Added sourceLinkTemplate option to allow more flexible specification of remote urls.
Deprecated now redundant gitRevision detection starting with https?:// introduced in v0.23.16, #2068.

Thanks!

@futurGH

v0.23.16 (2022-10-10)

Features

Object types will now be pretty printed, #1793.
Added support for specifying the tsconfig.json file in packages mode with { "typedoc": { "tsconfig": "tsconfig.lib.json" }} in package.json, #2061.
In packages mode, readme files will now be automatically included if present, #2065.
Added support for specifying the base file url for links to source code, #2068.

Bug Fixes

Private parameter properties will no longer be ignored, #2064.

Thanks!

@captainTorch

v0.23.15 (2022-09-18)

Features

TypeDoc will now treat @typedef {import("foo").Bar<Z>} Baz type declarations which forward type parameters to the imported
symbol as re-exports of that symbol, #2044.

Bug Fixes

TypeDoc will now prefer comments on variable declarations over signature comments, #2042.
Fixed double rendering of "Type Parameters" header, #2054.
Fixed double rendering of "Hierarchy" header, #2053.
Removed unused widgets.png and widgets@2x.png files from generated assets folder.

v0.23.14 (2022-09-03)

Features

Added support for defining one-off external link mappings with externalSymbolLinkMappings see
the documentation for usage examples and caveats, #2030.
External link resolvers defined with addUnknownSymbolResolver will now be checked when resolving @link tags, #2030.
Note: To support this, resolution will now happen during conversion, and as such, Renderer.addUnknownSymbolResolver has been
soft deprecated in favor of Converter.addUnknownSymbolResolver. Plugins should update to use the method on Converter.
DefaultThemeRenderContext.attemptExternalResolution has also been deprecated since it will repeat work done during conversion,
use ReferenceType.externalUrl instead.
Added Converter.addUnknownSymbolResolver for use by plugins supporting external links.

Bug Fixes

Fixed conversion of object literal types containing construct signatures, #2036.
Fixed centering of title bar on wide displays, actually this time, #2046.

v0.23.13 (2022-09-01)

Bug Fixes

Fixed packages mode bug introduced in 0.23.12, #2043.

v0.23.12 (2022-08-31)

Features

Added a new ParameterType.Object for declaring object options which will be shallowly merged when read from user configuration.
Added a new Application.EVENT_BOOTSTRAP_END event emitted when Application.bootstrap is called.

Bug Fixes

TypeDoc will now work properly in packages mode when converting packages outside the current working directory, #2043.
Fixed deprecation warning for isIdentifierOrPrivateIdentifier.
Fixed centering of title bar on wide displays, #2046.

Thanks!

@citkane

v0.23.11 (2022-08-26)

Features

Added support for TypeScript 4.8.
Introduced a skipErrorChecking option which instructs TypeDoc to not ask TypeScript for compiler errors
before attempting to generate documentation. Turning this on may improve generation speed, but could also
cause a crash if your code contains compiler errors.
Added support for JS entry points when using packages mode, #2037.

Bug Fixes

Fixed crash when converting abstract mixin class, #2011.
Readme files within monorepos now have @link tags resolved, #2029.
Correctly resolve unqualified links to class members within parameters, #2031.
TypeDoc will now consider other reflections with the same name as parents when resolving links, #2033.
The "Hierarchy" and "Type Parameters" helpers on DefaultThemeRenderContext now contain all the HTML for their sections of the page, #2038.

Thanks!

v0.23.10 (2022-07-31)

Features

Added support for detecting comments directly before parameters as the parameter comment, #2019.
Added support for using the comment directly before a constructor parameter that declares a property as the property comment, #2019.
Improved schema generation to give better autocomplete for the sort option.
Optional properties are now visually distinguished in the index/sidebar by rendering prop as prop?, #2023.
DefaultThemeRenderContext.markdown now also accepts a CommentDisplayPart[] for rendering, #2004.
Expose Converter.resolveLinks method for use with Converter.parseRawComment, #2004.

Bug Fixes

Fixed schema URL for TSDoc preventing the use of typedoc/tsdoc.json in TSDoc extends, #2015.
Improved detection of package names in repositories using pnpm, #2017.
Fixed missing JSDoc style @typedef comments for properties, #2020.

Thanks!

v0.23.9 (2022-07-24)

Bug Fixes

TypeDoc will no longer skip entry points which have no exports, #2007.
If using "entryPointStrategy": "expand", this change may result in new pages being added to your documentation.
If this is not desired, you can use the exclude option to filter them out.
Fixed missing comments on callable variable-functions constructed indirectly, #2008.
Packages mode will now respect the --includeVersion flag, #2010.
Fixed multiple reflections mapping to the same file name on case insensitive file systems, #2012.

v0.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!

v0.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.

v0.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!

v0.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.

v0.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.

v0.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.

v0.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.

v0.23.1 (2022-06-26)

Bug Fixes

If a declaration has multiple comments associated with it, the last one should be used, #1961.

vuejs/vitepress

`v1.0.0-alpha.65`

Compare Source

Bug Fixes

build: remove extra line at end of code blocks (#2191) (a681fd1)

Configuration

📅 Schedule: Branch creation - "before 3am on Monday" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

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

👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.

If you want to rebase/retry this PR, check this box

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

ST-DDT · 2023-04-12T12:14:13Z

Adds the fixes from TypeStrong/typedoc#2219

renovate · 2023-04-12T19:48:15Z

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠ Warning: custom changes will be lost.

codecov · 2023-04-12T19:55:39Z

Codecov Report

Merging #2037 (9f47cbd) into next (89c4cf3) will decrease coverage by 0.01%.
The diff coverage is n/a.

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #2037      +/-   ##
==========================================
- Coverage   99.61%   99.60%   -0.01%     
==========================================
  Files        2535     2535              
  Lines      241583   241583              
  Branches     1284     1278       -6     
==========================================
- Hits       240655   240639      -16     
- Misses        901      917      +16     
  Partials       27       27

see 2 files with indirect coverage changes

ST-DDT · 2023-04-12T20:19:50Z

The change from:

faker/test/scripts/apidoc/__snapshots__/signature.spec.ts.snap

Line 697 in cdfb5f0

"type": "'binary' | 'css' | 'decimal' | 'hex'",

to

faker/test/scripts/apidoc/__snapshots__/signature.spec.ts.snap

Line 678 in 9f47cbd

"type": "'hex' | ColorFormat",

is caused by typedoc-plugin-missing-exports no longer being compatible.

Plugin not compatible with TypeDoc 0.24.x Gerrit0/typedoc-plugin-missing-exports#19

We currently avoid that issue for our actual docs page by exporting all(?) our types publicly.

renovate bot requested a review from a team as a code owner April 11, 2023 12:17

renovate bot added the c: dependencies Pull requests that adds/updates a dependency label Apr 11, 2023

renovate bot force-pushed the renovate/doc-dependencies branch 3 times, most recently from 36118f5 to 0b9a74f Compare April 12, 2023 11:28

renovate bot force-pushed the renovate/doc-dependencies branch 2 times, most recently from 8c420b1 to 21cf14d Compare April 12, 2023 15:57

chore(deps): update doc-dependencies

cdfb5f0

renovate bot force-pushed the renovate/doc-dependencies branch from 21cf14d to cdfb5f0 Compare April 12, 2023 16:05

chore: update code

f35b029

ST-DDT added 2 commits April 12, 2023 21:48

Merge branch 'next' into renovate/doc-dependencies

acb9c28

chore: improve understandability

9f47cbd

ST-DDT added this to the v8 - None milestone specific tasks milestone Apr 12, 2023

ST-DDT requested a review from a team April 12, 2023 20:20

ST-DDT approved these changes Apr 12, 2023

View reviewed changes

ST-DDT requested a review from a team April 12, 2023 20:20

Shinigami92 approved these changes Apr 12, 2023

View reviewed changes

ST-DDT merged commit 5b689f9 into next Apr 12, 2023
17 checks passed

ST-DDT deleted the renovate/doc-dependencies branch April 12, 2023 20:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(deps): update doc-dependencies #2037

chore(deps): update doc-dependencies #2037

renovate bot commented Apr 11, 2023 •

edited

ST-DDT commented Apr 12, 2023 •

edited

renovate bot commented Apr 12, 2023

codecov bot commented Apr 12, 2023 •

edited

ST-DDT commented Apr 12, 2023 •

edited

chore(deps): update doc-dependencies #2037

chore(deps): update doc-dependencies #2037

Conversation

renovate bot commented Apr 11, 2023 • edited

Release Notes

v0.24.1

Bug Fixes

v0.24.0

Breaking Changes

API Breaking Changes

Features

Bug Fixes

Thanks!

v0.23.28 (2023-03-19)

Features

v0.23.27 (2023-03-16)

Features

Bug Fixes

Thanks!

v0.23.26 (2023-02-26)

Features

Bug Fixes

Thanks!

v0.23.25 (2023-02-11)

Breaking Changes

Features

Bug Fixes

Thanks!

v0.23.24 (2023-01-07)

Bug Fixes

Thanks!

v0.23.23 (2022-12-18)

Features

Bug Fixes

v0.23.22 (2022-12-11)

Features

Bug Fixes

v0.23.21 (2022-11-14)

Features

Thanks!

v0.23.20 (2022-11-03)

Bug Fixes

v0.23.19 (2022-10-28)

Bug Fixes

Thanks!

v0.23.18 (2022-10-23)

Features

Bug Fixes

v0.23.17 (2022-10-18)

Features

Thanks!

v0.23.16 (2022-10-10)

Features

Bug Fixes

Thanks!

v0.23.15 (2022-09-18)

Features

Bug Fixes

v0.23.14 (2022-09-03)

Features

Bug Fixes

v0.23.13 (2022-09-01)

Bug Fixes

v0.23.12 (2022-08-31)

Features

Bug Fixes

Thanks!

v0.23.11 (2022-08-26)

Features

Bug Fixes

Thanks!

v0.23.10 (2022-07-31)

Features

Bug Fixes

Thanks!

v0.23.9 (2022-07-24)

Bug Fixes

v0.23.8 (2022-07-17)

Features

Bug Fixes

renovate bot commented Apr 11, 2023 •

edited

`v0.24.1`

`v0.24.0`

`v1.0.0-alpha.65`

ST-DDT commented Apr 12, 2023 •

edited

codecov bot commented Apr 12, 2023 •

edited

ST-DDT commented Apr 12, 2023 •

edited