codecov[bot]
commented
1 year ago Codecov Report
Patch and project coverage have no change.
Comparison is base (
91a1819) 100.00% compared to head (c9065db) 100.00%.
Additional details and impacted files
```diff @@ Coverage Diff @@ ## main #39 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 36 36 Lines 916 916 Branches 183 183 ========================================= Hits 916 916 ```:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
This PR contains the following updates:
^0.24.8->^0.25.0Release Notes
TypeStrong/TypeDoc (typedoc)
### [`v0.25.0`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0250-2023-08-25) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.24.8...v0.25.0) ##### Breaking Changes - Bump minimum Node version to 16. - Removed `legacy-packages` option for `--entryPointStrategy`. - Changed default value of `--categorizeByGroup` to `false`. - Specifying a link as the `gitRemote` is no longer supported. - An `Application` instance must now be retrieved via `Application.bootstrap` or `Application.bootstrapWithPlugins`, [#2268](https://togithub.com/TypeStrong/TypeDoc/issues/2268). - Removed `ReflectionKind.ObjectLiteral` that was never used by TypeDoc. - Removed deprecated members `DefaultThemeRenderContext.comment` and `DefaultThemeRenderContext.attemptExternalResolution`. ##### Features - Added support for TypeScript 5.2, [#2373](https://togithub.com/TypeStrong/TypeDoc/issues/2373). - TypeDoc config files now support options default-exported from an ESM config file, [#2268](https://togithub.com/TypeStrong/TypeDoc/issues/2268). - TypeDoc config files may now export a promise containing configuration, [#2268](https://togithub.com/TypeStrong/TypeDoc/issues/2268). - Added `--preserveLinkText` option (defaults to true) which determines whether the reflection name or full link text is included in the output when no override is specified, [#2355](https://togithub.com/TypeStrong/TypeDoc/issues/2355). - Added a no-results placeholder when no search results are available, [#2347](https://togithub.com/TypeStrong/TypeDoc/issues/2347). - Implemented several miscellaneous performance improvements to generate docs faster, this took the time to generate TypeDoc's site from ~5.6 seconds to ~5.4 seconds. - Added `--disableGit` option to prevent TypeDoc from using Git to try to determine if sources can be linked, [#2326](https://togithub.com/TypeStrong/TypeDoc/issues/2326). - Added support for tags `@showGroups`, `@hideGroups`, `@showCategories`, `@hideCategories` to configure the navigation pane on a per-reflection basis, [#2329](https://togithub.com/TypeStrong/TypeDoc/issues/2329). - With `--jsDocCompatibility.defaultTags` set, `@defaultValue` is now implicitly a code block if the text contains no code, [#2370](https://togithub.com/TypeStrong/TypeDoc/issues/2370). ##### Bug Fixes - Fixed link discovery if nested (`Foo#bar`) links were used and `--useTsLinkResolution` is enabled in some cases, [#2360](https://togithub.com/TypeStrong/TypeDoc/issues/2360). - Links with invalid declaration references will no longer silently link to the wrong page in some cases, [#2360](https://togithub.com/TypeStrong/TypeDoc/issues/2360). - Fixed duplicate definitions in type hierarchy when using packages mode, [#2327](https://togithub.com/TypeStrong/TypeDoc/issues/2327). - `@inheritDoc` was not properly resolved across packages in packages mode, [#2331](https://togithub.com/TypeStrong/TypeDoc/issues/2331). - Added warning for attempted `@interface` use on union types, [#2352](https://togithub.com/TypeStrong/TypeDoc/issues/2352). - Fixed misleading type annotation on `Theme.getUrls`, [#2318](https://togithub.com/TypeStrong/TypeDoc/issues/2318). - Fixed duplicate namespace in documentation if `@namespace` is used on a variable with an associated namespace, [#2364](https://togithub.com/TypeStrong/TypeDoc/issues/2364). - Fixed `@namespace` property discovery if merged with a type and the type was declared first [#2364](https://togithub.com/TypeStrong/TypeDoc/issues/2364). - Tables in markdown are now styled, [#2366](https://togithub.com/TypeStrong/TypeDoc/issues/2366). - Sidebar links no longer open in a new tab, [#2353](https://togithub.com/TypeStrong/TypeDoc/issues/2353). - Headers now include some padding before rendering text, [#2316](https://togithub.com/TypeStrong/TypeDoc/issues/2316). - Symbol locations for signatures on `reflection.sources` now considers the node's name like non-signature location discovery does. ##### Thanks! - [@camc314](https://togithub.com/camc314) - [@cprussin](https://togithub.com/cprussin) - [@roggervalf](https://togithub.com/roggervalf) - [@Th3S4mur41](https://togithub.com/Th3S4mur41) #### v0.24.8 (2023-06-04) ##### Features - Added support for TypeScript 5.1, [#2296](https://togithub.com/TypeStrong/TypeDoc/issues/2296). - Added `navigation.fullTree` to control rendering the full navigation tree on each page, [#2287](https://togithub.com/TypeStrong/TypeDoc/issues/2287). This option will likely be replaced in 0.25 with dynamic loading of the full tree. - TypeDoc's `--pretty` option now also controls whether generated HTML contains line breaks, [#2287](https://togithub.com/TypeStrong/TypeDoc/issues/2287). - Optimized icon caching to reduce file size in generated HTML documentation, [#2287](https://togithub.com/TypeStrong/TypeDoc/issues/2287). - Render property description of "roughly top level" object types, [#2276](https://togithub.com/TypeStrong/TypeDoc/issues/2276). - Added `MarkdownEvent.INCLUDE` for plugins, [#2284](https://togithub.com/TypeStrong/TypeDoc/issues/2284). ##### Bug Fixes - When rendering functions/methods, TypeDoc will now render the comment summary above the parameters/return type, and any other block tags in the order they are defined in the comment, [#2285](https://togithub.com/TypeStrong/TypeDoc/issues/2285). - Comments are no longer removed from classes/interfaces containing call signatures, [#2290](https://togithub.com/TypeStrong/TypeDoc/issues/2290). ##### Thanks! - [@krisztianb](https://togithub.com/krisztianb) - [@WikiRik](https://togithub.com/WikiRik) #### v0.24.7 (2023-05-08) ##### Features - TypeDoc will now allow conversion without any entry points to support "readme only" packages, [#2264](https://togithub.com/TypeStrong/TypeDoc/issues/2264). ##### Bug Fixes - Category children are now sorted according to the `sort` option, [#2272](https://togithub.com/TypeStrong/TypeDoc/issues/2272). - Inline tags no longer require a space after the tag name to be parsed as a tag, [#2273](https://togithub.com/TypeStrong/TypeDoc/issues/2273). - Fixed module/namespace links in navigation when viewed in Safari, [#2275](https://togithub.com/TypeStrong/TypeDoc/issues/2275). #### v0.24.6 (2023-04-24) ##### Features - Improved error messaging if a provided entry point could not be converted into a documented module reflection, [#2242](https://togithub.com/TypeStrong/TypeDoc/issues/2242). - API: Added support for `g`, `circle`, `ellipse`, `polygon`, and `polyline` svg elements, [#2259](https://togithub.com/TypeStrong/TypeDoc/issues/2259). - Extended `jsDocCompatibility` option with `inheritDocTag` to ignore fully lowercase `inheritDoc` tags and `ignoreUnescapedBraces` to disable warnings about unescaped `{` and `}` characters in comments. ##### Bug Fixes - `--useTsLinkResolution` is no longer ignored within block tags, [#2260](https://togithub.com/TypeStrong/TypeDoc/issues/2260). - The current namespace will also be expanded in the navigation on page load, [#2260](https://togithub.com/TypeStrong/TypeDoc/issues/2260). - Fixed flicker of navigation pane when reloading a page caused by updating expansion state after the page was loaded. - Fixed an infinite loop if more than one entry point was provided, and all entry points were the same. ##### Thanks! - [@FlippieCoetser](https://togithub.com/FlippieCoetser) #### v0.24.5 (2023-04-22) ##### Features - Categories and groups can now be shown in the navigation, added `--navigation.includeCategories` and `--navigation.includeGroups` to control this behavior. The `--categorizeByGroup` option also effects this behavior. If `categorizeByGroup` is set (the default) and `navigation.includeGroups` is *not* set, the value of `navigation.includeCategories` will be effectively ignored since categories will be created only within groups, [#1532](https://togithub.com/TypeStrong/TypeDoc/issues/1532). - Added support for discovering a "module" comment on global files, [#2165](https://togithub.com/TypeStrong/TypeDoc/issues/2165). - Added copy code to clipboard button, [#2153](https://togithub.com/TypeStrong/TypeDoc/issues/2153). - Function `@returns` blocks will now be rendered with the return type, [#2180](https://togithub.com/TypeStrong/TypeDoc/issues/2180). - Added `--groupOrder` option to specify the sort order of groups, [#2251](https://togithub.com/TypeStrong/TypeDoc/issues/2251). ##### Bug Fixes - Type parameter constraints now respect the `--hideParameterTypesInTitle` option, [#2226](https://togithub.com/TypeStrong/TypeDoc/issues/2226). - Even more contrast fixes, [#2248](https://togithub.com/TypeStrong/TypeDoc/issues/2248). - Fix semantic highlighting for predicate type's parameter references, [#2249](https://togithub.com/TypeStrong/TypeDoc/issues/2249). - Fixed broken links to heading titles. - Fixed inconsistent styling between type parameter lists and parameter lists. - TypeDoc will now warn if more than one `@returns` block is is present in a function, and ignore the duplicate blocks as specified by TSDoc. ##### Thanks! - [@FlippieCoetser](https://togithub.com/FlippieCoetser) #### v0.24.4 (2023-04-16) ##### Bug Fixes - Fixed broken semantic coloring, [#2247](https://togithub.com/TypeStrong/TypeDoc/issues/2247). - Increased contrast for parameter titles in dark mode to meet WCAG AA contrast requirements, [#2244](https://togithub.com/TypeStrong/TypeDoc/issues/2244). - Underline color of index links now matches the text color, [#2245](https://togithub.com/TypeStrong/TypeDoc/issues/2245). - Increased contract for active menu item text in dark mode. #### v0.24.3 (2023-04-16) ##### Bug Fixes - Fixed path expansion on Windows preventing generation, [#2243](https://togithub.com/TypeStrong/TypeDoc/issues/2243) and [#2241](https://togithub.com/TypeStrong/TypeDoc/issues/2241). #### v0.24.2 (2023-04-15) ##### Features - Added semantic link coloring for reflection names & links, [#2227](https://togithub.com/TypeStrong/TypeDoc/issues/2227). Note: This resulted in function signatures becoming too busy for easy scanning with even slightly complicated signatures as such, TypeDoc now only renders parameter names in the signature title and includes the type in the parameter details as usual. This can be controlled with the new `--hideParameterTypesInTitle` option. - Conditional types will now render their branches on the next line for easier comprehension. ##### Bug Fixes - Fixed `&` showing as `&` and HTML text showing up in page contents navigation, [#2224](https://togithub.com/TypeStrong/TypeDoc/issues/2224). - Increased padding between sections when one navigation column is displayed, [#2225](https://togithub.com/TypeStrong/TypeDoc/issues/2225). - Correct padding for navigation elements with a displayed icon, [#2229](https://togithub.com/TypeStrong/TypeDoc/issues/2229). - Fixed `source-order` sort strategy failing to compare reflections within a file. - Added `enum-member-source-order` specialization of the `source-order` sort strategy which only compares enum members, [#2237](https://togithub.com/TypeStrong/TypeDoc/issues/2237). - Updated highlight colors for semantic links to meet WCAG AA contrast requirements, [#2228](https://togithub.com/TypeStrong/TypeDoc/issues/2228). - Type parameters are now highlighted consistently, [#2230](https://togithub.com/TypeStrong/TypeDoc/issues/2230). - Fixed semantic coloring in type and function signatures, [#2227](https://togithub.com/TypeStrong/TypeDoc/issues/2227). - Fixed issue where removing a reflection indirectly containing an object/function type would only partially remove the reflection, [#2231](https://togithub.com/TypeStrong/TypeDoc/issues/2231). - Fixed "Implementation of X.y" links if a mixture of methods and property-methods are used, [#2233](https://togithub.com/TypeStrong/TypeDoc/issues/2233). - "Implementation of" text to symbol-properties not contained in the documentation will now use the resolved name instead of a `__@` symbol name, [#2234](https://togithub.com/TypeStrong/TypeDoc/issues/2234). - Fix expansion of globs if a single entry point is provided, [#2235](https://togithub.com/TypeStrong/TypeDoc/issues/2235). - Validation will no longer be skipped for sub packages when running with `--entryPointStrategy packages`. - Fixed broken theme toggle if the page contained a member named "theme". ##### Thanks! - [@RunDevelopment](https://togithub.com/RunDevelopment) #### v0.24.1 (2023-04-09) ##### Bug Fixes - Improve detection for legacy JSDoc `@example` tags, [#2222](https://togithub.com/TypeStrong/TypeDoc/issues/2222). - The page footer will now appear at the bottom of the page even if the page is short, [#2223](https://togithub.com/TypeStrong/TypeDoc/issues/2223).Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.