search

Chevrotain / chevrotain

Parser Building Toolkit for JavaScript
https://chevrotain.io
Apache License 2.0
2.44k stars 199 forks source link

chore(deps): update dependency typedoc to v0.26.3 #1981

Open renovate[bot] opened 10 months ago

renovate[bot] commented 10 months ago

Mend Renovate

This PR contains the following updates:

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

Release Notes

TypeStrong/TypeDoc (typedoc) ### [`v0.26.3`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0263-2024-06-28) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.26.2...v0.26.3) ##### Features - "On This Page" navigation now includes the page groups in collapsible sections, [#​2616](https://togithub.com/TypeStrong/TypeDoc/issues/2616). ##### Bug Fixes - `mailto:` links are no longer incorrectly recognized as relative paths, [#​2613](https://togithub.com/TypeStrong/TypeDoc/issues/2613). - Added `@since` to the default list of recognized tags, [#​2614](https://togithub.com/TypeStrong/TypeDoc/issues/2614). - Relative paths to directories will no longer cause the directory to be copied into the media directory, [#​2617](https://togithub.com/TypeStrong/TypeDoc/issues/2617). ### [`v0.26.2`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0262-2024-06-24) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.26.1...v0.26.2) ##### Features - Added a `--suppressCommentWarningsInDeclarationFiles` option to disable warnings from parsing comments in declaration files, [#​2611](https://togithub.com/TypeStrong/TypeDoc/issues/2611). - Improved comment discovery to more closely match TypeScript's discovery when getting comments for members of interfaces/classes, [#​2084](https://togithub.com/TypeStrong/TypeDoc/issues/2084), [#​2545](https://togithub.com/TypeStrong/TypeDoc/issues/2545). ##### Bug Fixes - The `text` non-highlighted language no longer causes warnings when rendering, [#​2610](https://togithub.com/TypeStrong/TypeDoc/issues/2610). - If a comment on a method is inherited from a parent class, and the child class does not use an `@param` tag from the parent, TypeDoc will no longer warn about the `@param` tag. ### [`v0.26.1`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0261-2024-06-22) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.26.0...v0.26.1) ##### Features - Improved Korean translation coverage, [#​2602](https://togithub.com/TypeStrong/TypeDoc/issues/2602). ##### Bug Fixes - Added `@author` to the default list of recognized tags, [#​2603](https://togithub.com/TypeStrong/TypeDoc/issues/2603). - Anchor links are no longer incorrectly checked for relative paths, [#​2604](https://togithub.com/TypeStrong/TypeDoc/issues/2604). - Fixed an issue where line numbers reported in error messages could be incorrect, [#​2605](https://togithub.com/TypeStrong/TypeDoc/issues/2605). - Fixed relative link detection for markdown links containing code in their label, [#​2606](https://togithub.com/TypeStrong/TypeDoc/issues/2606). - Fixed an issue with packages mode where TypeDoc would use (much) more memory than required, [#​2607](https://togithub.com/TypeStrong/TypeDoc/issues/2607). - TypeDoc will no longer crash when asked to render highlighted code for an unsupported language, [#​2609](https://togithub.com/TypeStrong/TypeDoc/issues/2609). - Fixed an issue where relatively-linked files would not be copied to the output directory in packages mode. - Fixed an issue where modifier tags were not applied to top level modules in packages mode. - Fixed an issue where excluded tags were not removed from top level modules in packages mode. - `.jsonc` configuration files are now properly read as JSONC, rather than being passed to `require`. ##### Thanks! - [@​KNU-K](https://togithub.com/KNU-K) ### [`v0.26.0`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0260-2024-06-22) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.25.13...v0.26.0) ##### Breaking Changes - Drop support for Node 16. - Moved from `marked` to `markdown-it` for parsing as marked has moved to an async model which supporting would significantly complicate TypeDoc's rendering code. This means that any projects setting `markedOptions` needs to be updated to use `markdownItOptions`. Unlike `marked@4`, `markdown-it` pushes lots of functionality to plugins. To use plugins, a JavaScript config file must be used with the `markdownItLoader` option. - Updated Shiki from 0.14 to 1.x. This should mostly be a transparent update which adds another 23 supported languages and 13 supported themes. As Shiki adds additional languages, the time it takes to load the highlighter increases linearly. To avoid rendering taking longer than necessary, TypeDoc now only loads a few common languages. Additional languages can be loaded by setting the `--highlightLanguages` option. - Changed default of `--excludePrivate` to `true`. - Renamed `--sitemapBaseUrl` to `--hostedBaseUrl` to reflect that it can be used for more than just the sitemap. - Removed deprecated `navigation.fullTree` option. - Removed `--media` option, TypeDoc will now detect image links within your comments and markdown documents and automatically copy them to the site. - Removed `--includes` option, use the `@document` tag instead. - Removed `--stripYamlFrontmatter` option, TypeDoc will always do this now. - Renamed the `--htmlLang` option to `--lang`. - Removed the `--gaId` option for Google Analytics integration and corresponding `analytics` theme member, [#​2600](https://togithub.com/TypeStrong/TypeDoc/issues/2600). - All function-likes may now have comments directly attached to them. This is a change from previous versions of TypeDoc where functions comments were always moved down to the signature level. This mostly worked, but caused problems with type aliases, so was partially changed in 0.25.13. This change was extended to apply not only to type aliases, but also other function-likes declared with variables and callable properties. As a part of this change, comments on the implementation signature of overloaded functions will now be added to the function reflection, and will not be inherited by signatures of that function, [#​2521](https://togithub.com/TypeStrong/TypeDoc/issues/2521). - API: TypeDoc now uses a typed event emitter to provide improved type safety, this found a bug where `Converter.EVENT_CREATE_DECLARATION` was emitted for `ProjectReflection` in some circumstances. - API: `MapOptionDeclaration.mapError` has been removed. - API: Deprecated `BindOption` decorator has been removed. - API: `DeclarationReflection.indexSignature` has been renamed to `DeclarationReflection.indexSignatures`. Note: This also affects JSON serialization. TypeDoc will support JSON output from 0.25 through at least 0.26. - API: `JSONOutput.SignatureReflection.typeParameter` has been renamed to `typeParameters` to match the JS API. - API: `DefaultThemeRenderContext.iconsCache` has been removed as it is no longer needed. - API: `DefaultThemeRenderContext.hook` must now be passed `context` if required by the hook. ##### Features - Added support for TypeScript 5.5. - Added new `--projectDocuments` option to specify additional Markdown documents to be included in the generated site [#​247](https://togithub.com/TypeStrong/TypeDoc/issues/247), [#​1870](https://togithub.com/TypeStrong/TypeDoc/issues/1870), [#​2288](https://togithub.com/TypeStrong/TypeDoc/issues/2288), [#​2565](https://togithub.com/TypeStrong/TypeDoc/issues/2565). - TypeDoc now has the architecture in place to support localization. No languages besides English are currently shipped in the package, but it is now possible to add support for additional languages, [#​2475](https://togithub.com/TypeStrong/TypeDoc/issues/2475). - Added support for a `packageOptions` object which specifies options that should be applied to each entry point when running with `--entryPointStrategy packages`, [#​2523](https://togithub.com/TypeStrong/TypeDoc/issues/2523). - `--hostedBaseUrl` will now be used to generate a `` element in the project root page, [#​2550](https://togithub.com/TypeStrong/TypeDoc/issues/2550). - Added support for documenting individual elements of a union type, [#​2585](https://togithub.com/TypeStrong/TypeDoc/issues/2585). Note: This feature is only available on type aliases directly containing unions. - TypeDoc will now log the number of errors/warnings errors encountered, if any, after a run, [#​2581](https://togithub.com/TypeStrong/TypeDoc/issues/2581). - New option, `--customFooterHtml` to add custom HTML to the generated page footer, [#​2559](https://togithub.com/TypeStrong/TypeDoc/issues/2559). - TypeDoc will now copy modifier tags to children if specified in the `--cascadedModifierTags` option, [#​2056](https://togithub.com/TypeStrong/TypeDoc/issues/2056). - TypeDoc will now warn if mutually exclusive modifier tags are specified for a comment (e.g. both `@alpha` and `@beta`), [#​2056](https://togithub.com/TypeStrong/TypeDoc/issues/2056). - Groups and categories can now be collapsed in the page body, [#​2330](https://togithub.com/TypeStrong/TypeDoc/issues/2330). - Added support for JSDoc `@hideconstructor` tag. This tag should only be used to work around [TypeScript#58653](https://togithub.com/TypeScript/TypeDoc/issues/58653), prefer the more general `@hidden`/`@ignore` tag to hide members normally, [#​2577](https://togithub.com/TypeStrong/TypeDoc/issues/2577). - Added `--useHostedBaseUrlForAbsoluteLinks` option to use the `--hostedBaseUrl` option to produce absolute links to pages on a site, [#​940](https://togithub.com/TypeStrong/TypeDoc/issues/940). - Tag headers now generate permalinks in the default theme, [#​2308](https://togithub.com/TypeStrong/TypeDoc/issues/2308). - TypeDoc now attempts to use the "most likely name" for a symbol if the symbol is not present in the documentation, [#​2574](https://togithub.com/TypeStrong/TypeDoc/issues/2574). - Fixed an issue where the "On This Page" section would include markdown if the page contained headings which contained markdown. - TypeDoc will now warn if a block tag is used which is not defined by the `--blockTags` option. - Added three new sort strategies `documents-first`, `documents-last`, and `alphabetical-ignoring-documents` to order markdown documents. - Added new `--alwaysCreateEntryPointModule` option. When set, TypeDoc will always create a `Module` for entry points, even if only one is provided. If `--projectDocuments` is used to add documents, this option defaults to `true`, otherwise, defaults to `false`. - Added new `--highlightLanguages` option to control what Shiki language packages are loaded. - TypeDoc will now render union elements on new lines if there are more than 3 items in the union. - TypeDoc will now only render the "Type Declaration" section if it will provide additional information not already presented in the page. This results in significantly smaller documentation pages in many cases where that section would just repeat what has already been presented in the rendered type. - Added `comment.beforeTags` and `comment.afterTags` hooks for plugin use. Combined with `CommentTag.skipRendering` this can be used to provide custom tag handling at render time. ##### Bug Fixes - TypeDoc now supports objects with multiple index signatures, [#​2470](https://togithub.com/TypeStrong/TypeDoc/issues/2470). - Header anchor links in rendered markdown are now more consistent with headers generated by TypeDoc, [#​2546](https://togithub.com/TypeStrong/TypeDoc/issues/2546). - Types rendered in the `Returns` header are now properly colored, [#​2546](https://togithub.com/TypeStrong/TypeDoc/issues/2546). - Links added with the `navigationLinks` option are now moved into the pull out navigation on mobile displays, [#​2548](https://togithub.com/TypeStrong/TypeDoc/issues/2548). - `@license` and `@import` comments will be ignored at the top of files, [#​2552](https://togithub.com/TypeStrong/TypeDoc/issues/2552). - Fixed issue in documentation validation where constructor signatures where improperly considered not documented, [#​2553](https://togithub.com/TypeStrong/TypeDoc/issues/2553). - Keyboard focus is now visible on dropdowns and checkboxes in the default theme, [#​2556](https://togithub.com/TypeStrong/TypeDoc/issues/2556). - The color theme label in the default theme now has an accessible name, [#​2557](https://togithub.com/TypeStrong/TypeDoc/issues/2557). - Fixed issue where search results could not be navigated while Windows Narrator was on, [#​2563](https://togithub.com/TypeStrong/TypeDoc/issues/2563). - `charset` is now correctly cased in `` tag generated by the default theme, [#​2568](https://togithub.com/TypeStrong/TypeDoc/issues/2568). - Fixed very slow conversion on Windows where Msys git was used by typedoc to discover repository links, [#​2586](https://togithub.com/TypeStrong/TypeDoc/issues/2586). - Validation will now be run in watch mode, [#​2584](https://togithub.com/TypeStrong/TypeDoc/issues/2584). - Fixed an issue where custom themes which added dependencies in the `` element could result in broken icons, [#​2589](https://togithub.com/TypeStrong/TypeDoc/issues/2589). - `@default` and `@defaultValue` blocks are now recognized as regular blocks if they include inline tags, [#​2601](https://togithub.com/TypeStrong/TypeDoc/issues/2601). - Navigation folders sharing a name will no longer be saved with a shared key to `localStorage`. - The `--hideParameterTypesInTitle` option no longer applies when rendering function types. - Broken `@link` tags in readme files will now cause a warning when link validation is enabled. - Fixed `externalSymbolLinkMappings` option's support for [meanings](https://typedoc.org/guides/declaration-references/#meaning) in declaration references. - Buttons to copy code now have the `type=button` attribute set to avoid being treated as submit buttons. - `--hostedBaseUrl` will now implicitly add a trailing slash to the generated URL. ##### Thanks! - [@​Aryakoste](https://togithub.com/Aryakoste) - [@​bladerunner2020](https://togithub.com/bladerunner2020) - [@​Dinnerbone](https://togithub.com/Dinnerbone) - [@​HarelM](https://togithub.com/HarelM) - [@​kraenhansen](https://togithub.com/kraenhansen) - [@​Nil2000](https://togithub.com/Nil2000) - [@​steve02081504](https://togithub.com/steve02081504) - [@​tristanzander](https://togithub.com/tristanzander) ### [`v0.25.13`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02513-2024-04-07) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.25.12...v0.25.13) ##### Features - Added `gitRevision:short` placeholder option to `--sourceLinkTemplate` option, [#​2529](https://togithub.com/TypeStrong/TypeDoc/issues/2529). Links generated by TypeDoc will now default to using the non-short git revision. - Moved "Generated by TypeDoc" footer into a `
` tag, added `footer.begin` and `footer.end` render hooks for use by custom plugins, [#​2532](https://togithub.com/TypeStrong/TypeDoc/issues/2532). ##### Bug Fixes - Fixed conversion of `NoInfer` missing type parameter reference, [#​2539](https://togithub.com/TypeStrong/TypeDoc/issues/2539). - Linking to a member on a page no longer incorrectly claims that "This member is normally hidden due to your filter settings" for every member. ##### Thanks! - [@​xuhdev](https://togithub.com/xuhdev) ### [`v0.25.12`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02512-2024-03-10) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.25.11...v0.25.12) ##### Bug Fixes - Updated page font to work around issues with Mac rendering, [#​2518](https://togithub.com/TypeStrong/TypeDoc/issues/2518) ##### Thanks! - [@​docmattman](https://togithub.com/docmattman) ### [`v0.25.11`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02511-2024-03-06) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.25.10...v0.25.11) ##### Bug Fixes - Fixed an issue introduced with 0.25.10 which causes the page index to initially render empty, [#​2514](https://togithub.com/TypeStrong/TypeDoc/issues/2514). - "On This Page" section is now smarter when handling page headings which do not follow the normal `h1>h2>h3` process, [#​2515](https://togithub.com/TypeStrong/TypeDoc/issues/2515). ### [`v0.25.10`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02510-2024-03-03) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.25.9...v0.25.10) ##### Bug Fixes - Constructed references to enum types will be properly linked with `@interface`, [#​2508](https://togithub.com/TypeStrong/TypeDoc/issues/2508). - Comments on property-methods will no longer be duplicated in generated documentation, [#​2509](https://togithub.com/TypeStrong/TypeDoc/issues/2509). - Reduced rendered docs size by writing icons to a referenced SVG asset, [#​2505](https://togithub.com/TypeStrong/TypeDoc/issues/2505). For TypeDoc's docs, this reduced the rendered documentation size by ~30%. - The HTML docs now attempt to reduce repaints caused by dynamically loading the navigation, [#​2491](https://togithub.com/TypeStrong/TypeDoc/issues/2491). - When navigating to a link that contains an anchor, the page will now be properly highlighted in the page navigation. ### [`v0.25.9`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0259-2024-02-26) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.25.8...v0.25.9) ##### Features - Literal numeric unions will now be sorted during conversion, [#​2502](https://togithub.com/TypeStrong/TypeDoc/issues/2502). ##### Bug Fixes - Module readmes will now be included in JSON output, [#​2500](https://togithub.com/TypeStrong/TypeDoc/issues/2500). - Fixed crash when `--excludeNotDocumented` was used and the project contained a reference to a removed signature, [#​2496](https://togithub.com/TypeStrong/TypeDoc/issues/2496). - Fixed crash when converting an infinitely recursive type via a new `--maxTypeConversionDepth` option, [#​2507](https://togithub.com/TypeStrong/TypeDoc/issues/2507). - Type links in "Parameters" and "Type Parameters" sections of the page will now be correctly colored. ##### Thanks! - [@​JMBeresford](https://togithub.com/JMBeresford) ### [`v0.25.8`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0258-2024-02-09) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.25.7...v0.25.8) ### [`v0.25.7`](https://togithub.com/TypeStrong/typedoc/releases/tag/v0.25.7) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.25.6...v0.25.7) ##### Bug Fixes - Fixed an issue where a namespace would not be created for merged function-namespaces only containing types, [#​2476](https://togithub.com/TypeStrong/TypeDoc/issues/2476). - Fixed an infinite loop when converting a union type which directly contained another union type which refers to itself, [#​2469](https://togithub.com/TypeStrong/TypeDoc/issues/2469). ### [`v0.25.6`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0256-2024-01-01) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.25.5...v0.25.6) ##### Bug Fixes - Fixed infinite loop caused by a fix for some complicated union/intersection types, [#​2468](https://togithub.com/TypeStrong/TypeDoc/issues/2468). - Improved infinite loop detection in type converter to reduce false positives. ### [`v0.25.5`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0255-2024-01-01) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.25.4...v0.25.5) ### [`v0.25.4`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0254-2023-11-26) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.25.3...v0.25.4) ##### Features - Added support for TypeScript 5.3, [#​2446](https://togithub.com/TypeStrong/TypeDoc/issues/2446). - TypeDoc will now render interfaces as code at the top of the page describing interfaces, [#​2449](https://togithub.com/TypeStrong/TypeDoc/issues/2449). This can be controlled through the new `DefaultThemeRenderContext.reflectionPreview` helper. - Improved type rendering to highlight keywords differently than symbols. ##### Bug Fixes - Fixed automatic declaration file resolution on Windows, [#​2416](https://togithub.com/TypeStrong/TypeDoc/issues/2416). - Fixed default option values on options declared by plugins in packages mode, [#​2433](https://togithub.com/TypeStrong/TypeDoc/issues/2433). - `gitRevision` will now be replaced in `sourceLinkTemplate`, [#​2434](https://togithub.com/TypeStrong/TypeDoc/issues/2434). - Improved handling of function-modules created with `Object.assign`, [#​2436](https://togithub.com/TypeStrong/TypeDoc/issues/2436). - TypeDoc will no longer warn about duplicate comments with warnings which point to a single comment, [#​2437](https://togithub.com/TypeStrong/TypeDoc/issues/2437) - Fixed an infinite loop when `skipLibCheck` is used to ignore some compiler errors, [#​2438](https://togithub.com/TypeStrong/TypeDoc/issues/2438). - `@example` tag titles will now be rendered in the example heading, [#​2440](https://togithub.com/TypeStrong/TypeDoc/issues/2440). - Correctly handle transient symbols in `@namespace`-created namespaces, [#​2444](https://togithub.com/TypeStrong/TypeDoc/issues/2444). - TypeDoc no longer displays the "Hierarchy" section if there is no inheritance hierarchy to display. - Direct links to individual signatures no longer results in the signature being partially scrolled off the screen. ##### Thanks! - [@​li-jia-nan](https://togithub.com/li-jia-nan) - [@​Nokel81](https://togithub.com/Nokel81) - [@​ocavue](https://togithub.com/ocavue) - [@​swarnpallav](https://togithub.com/swarnpallav) ### [`v0.25.3`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0253-2023-10-29) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.25.2...v0.25.3) ##### Features - Added `--sourceLinkExternal` option to render source code links as external, [#​2415](https://togithub.com/TypeStrong/TypeDoc/issues/2415). - TypeDoc no longer requires the `declarationMap` option to be set to true to handle cross-package links in packages mode, [#​2416](https://togithub.com/TypeStrong/TypeDoc/issues/2416). - Added `external-last` option for the `--sort` option, [#​2418](https://togithub.com/TypeStrong/TypeDoc/issues/2418). ##### Bug Fixes - TypeDoc now attempts to correct local anchor links in readme files which are broken by its deconfliction logic, [#​2413](https://togithub.com/TypeStrong/TypeDoc/issues/2413). - TypeDoc now finds comments on index signatures again, [#​2414](https://togithub.com/TypeStrong/TypeDoc/issues/2414). - TypeDoc now does a better job of detecting properties when destructured function arguments are used. - Quotes will now be properly escaped in HTML attribute values. ##### Thanks! - [@​mogelbrod](https://togithub.com/mogelbrod) - [@​rsanchez](https://togithub.com/rsanchez) ### [`v0.25.2`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0252-2023-10-08) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.25.1...v0.25.2) ##### Features - Added `navigationLeaves` option to remove branches from the navigation tree, [#​2382](https://togithub.com/TypeStrong/TypeDoc/issues/2382). - Added `sortEntryPoints` option (defaults to true) to allow disabling entry point sorting, [#​2393](https://togithub.com/TypeStrong/TypeDoc/issues/2393). - Improved support for multi-word searches, [#​2400](https://togithub.com/TypeStrong/TypeDoc/issues/2400). ##### Bug Fixes - Fixed conversion of `@template` constraints on JSDoc defined type parameters, [#​2389](https://togithub.com/TypeStrong/TypeDoc/issues/2389). - Invalid link validation is now correctly suppressed before all projects have been converted in packages mode, [#​2403](https://togithub.com/TypeStrong/TypeDoc/issues/2403). - Fixed tsconfig handling for projects using a solution-style tsconfig, [#​2406](https://togithub.com/TypeStrong/TypeDoc/issues/2406). - Fixed broken settings icons caused by icon caching introduced in 0.25.1, [#​2408](https://togithub.com/TypeStrong/TypeDoc/issues/2408). - Corrected module comment handling on declaration files containing a single `declare module "foo"`, [#​2401](https://togithub.com/TypeStrong/TypeDoc/issues/2401). ##### Thanks! - [@​schiem](https://togithub.com/schiem) ### [`v0.25.1`](https://togithub.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0251-2023-09-04) [Compare Source](https://togithub.com/TypeStrong/TypeDoc/compare/v0.25.0...v0.25.1) ##### Features - Added `stripYamlFrontmatter` config option to remove YAML frontmatter from README.md, [#​2381](https://togithub.com/TypeStrong/TypeDoc/issues/2381). - Added `--excludeCategories` config option to remove reflections present in any excluded category, [#​1407](https://togithub.com/TypeStrong/TypeDoc/issues/1407). - If no tsconfig.json file is present, TypeDoc will now attempt to compile without setting any compiler options, [#​2304](https://togithub.com/TypeStrong/TypeDoc/issues/2304). - Navigation is now written to a JS file and built dynamically, which significantly decreases document generation time with large projects and also provides large space benefits. Themes may now override `DefaultTheme.buildNavigation` to customize the displayed navigation tree, [#​2287](https://togithub.com/TypeStrong/TypeDoc/issues/2287). Note: This change renders `navigation.fullTree` obsolete. If you set it, TypeDoc will warn that it is being ignored. It will be removed in v0.26. - The search index is now compressed before writing, which reduces most search index sizes by ~5-10x. - TypeDoc will now attempt to cache icons when `DefaultThemeRenderContext.icons` is overwritten by a custom theme. Note: To perform this optimization, TypeDoc relies on `DefaultThemeRenderContext.iconCache` being rendered within each page. TypeDoc does it in the `defaultLayout` template. - Cache URL derivation during generation, [#​2386](https://togithub.com/TypeStrong/TypeDoc/issues/2386). ##### Bug Fixes - `@property` now works as expected if used to override a method's documentation. - Deprecated functions/methods are now correctly rendered with a struck-out name. - `--watch` mode works again, [#​2378](https://togithub.com/TypeStrong/TypeDoc/issues/2378). - Improved support for optional names within JSDoc types, [#​2384](https://togithub.com/TypeStrong/TypeDoc/issues/2384). - Fixed duplicate rendering of reflection flags on signature parameters, [#​2385](https://togithub.com/TypeStrong/TypeDoc/issues/2385). - TypeDoc now handles the `intrinsic` keyword if TS intrinsic types are included in documentation. - `--exclude` is now respected when expanding globs in entry points, [#​2376](https://togithub.com/TypeStrong/TypeDoc/issues/2376). ##### Thanks! - [@​ajesshope](https://togithub.com/ajesshope) - [@​HemalPatil](https://togithub.com/HemalPatil) - [@​hrueger](https://togithub.com/hrueger) - [@​typhonrt](https://togithub.com/typhonrt) ### [`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 becomes conflicted, 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.