Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: JoshuaKGoldberg/ts-api-utils
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 12df29810c4a0b9146f58fdee4a2cbdf28a1bee0
Choose a base ref
...
head repository: JoshuaKGoldberg/ts-api-utils
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: v1.4.2
Choose a head ref
  • 16 commits
  • 10 files changed
  • 5 contributors

Commits on Nov 24, 2024

  1. chore(deps): update dependency typedoc to ^0.26.0 (#556)

    This PR contains the following updates:
    
    | Package | Change | Age | Adoption | Passing | Confidence |
    |---|---|---|---|---|---|
    | [typedoc](https://typedoc.org)
    ([source](https://redirect.github.com/TypeStrong/TypeDoc)) | [`^0.24.8`
    -> `^0.26.0`](https://renovatebot.com/diffs/npm/typedoc/0.24.8/0.26.11)
    |
    [![age](https://developer.mend.io/api/mc/badges/age/npm/typedoc/0.26.11?slim=true)](https://docs.renovatebot.com/merge-confidence/)
    |
    [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/typedoc/0.26.11?slim=true)](https://docs.renovatebot.com/merge-confidence/)
    |
    [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/typedoc/0.24.8/0.26.11?slim=true)](https://docs.renovatebot.com/merge-confidence/)
    |
    [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/typedoc/0.24.8/0.26.11?slim=true)](https://docs.renovatebot.com/merge-confidence/)
    |
    
    ---
    
    ### Release Notes
    
    <details>
    <summary>TypeStrong/TypeDoc (typedoc)</summary>
    
    ###
    [`v0.26.11`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02611-2024-11-01)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.10...v0.26.11)
    
    ##### Features
    
    - If `hostedBaseUrl` is set to the root page on a website, TypeDoc will
    now include `WebSite` structured data,
    [#&#8203;2760](https://redirect.github.com/TypeStrong/TypeDoc/issues/2760).
    
    ##### Bug Fixes
    
    - Fix support for ESM config files with Node 23,
    [#&#8203;2752](https://redirect.github.com/TypeStrong/TypeDoc/issues/2752).
    - Fix type errors when using `"module": "ESNext"` and importing TypeDoc,
    [#&#8203;2747](https://redirect.github.com/TypeStrong/TypeDoc/issues/2747).
    - Inherited comments on overloaded methods now consider the overload
    position when inheriting a comment,
    [#&#8203;2755](https://redirect.github.com/TypeStrong/TypeDoc/issues/2755).
    
    ###
    [`v0.26.10`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02610-2024-10-16)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.9...v0.26.10)
    
    ##### Bug Fixes
    
    - Fixed missing space on page headers,
    [#&#8203;2748](https://redirect.github.com/TypeStrong/TypeDoc/issues/2748).
    
    ###
    [`v0.26.9`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0269-2024-10-11)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.8...v0.26.9)
    
    ##### Features
    
    - Added `headings` option to control optional headings,
    [#&#8203;2729](https://redirect.github.com/TypeStrong/TypeDoc/issues/2729).
    - Updated Chinese translations,
    [#&#8203;2739](https://redirect.github.com/TypeStrong/TypeDoc/issues/2739).
    - Added a folder icon to page navigation elements which are not links,
    [#&#8203;2741](https://redirect.github.com/TypeStrong/TypeDoc/issues/2741).
    
    ##### Bug Fixes
    
    - `externalSymbolLinkMappings` now uses the TypeScript reported link
    target if available,
    [#&#8203;2725](https://redirect.github.com/TypeStrong/TypeDoc/issues/2725).
    - TypeDoc will no longer omit the modules page if a project contains
    only modules/documents,
    [#&#8203;2730](https://redirect.github.com/TypeStrong/TypeDoc/issues/2730).
    - Fixed missing breadcrumbs on project page,
    [#&#8203;2728](https://redirect.github.com/TypeStrong/TypeDoc/issues/2728).
    - TypeDoc will no longer render an empty readme page if no readme was
    found.
    
    ##### Thanks!
    
    -   [@&#8203;lriggle-strib](https://redirect.github.com/lriggle-strib)
    -   [@&#8203;mrfigg](https://redirect.github.com/mrfigg)
    -   [@&#8203;XeroAlpha](https://redirect.github.com/XeroAlpha)
    
    ###
    [`v0.26.8`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0268-2024-10-04)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.7...v0.26.8)
    
    ##### Features
    
    - Updated Chinese translations,
    [#&#8203;2706](https://redirect.github.com/TypeStrong/TypeDoc/issues/2706).
    - Exported constants no longer render the type and default value if they
    are the same,
    [#&#8203;2717](https://redirect.github.com/TypeStrong/TypeDoc/issues/2717).
    - The HTML output now wraps tag blocks with `<div>` tags and includes
    the tag name in a class name,
    [#&#8203;2723](https://redirect.github.com/TypeStrong/TypeDoc/issues/2723).
    
    ##### Bug Fixes
    
    - Correctly handle external link resolver link text when referencing an
    external symbol,
    [#&#8203;2700](https://redirect.github.com/TypeStrong/TypeDoc/issues/2700).
    - Big integer literals are now supported as default values,
    [#&#8203;2721](https://redirect.github.com/TypeStrong/TypeDoc/issues/2721).
    - Corrected handling of `@link` tags present in comments at the start of
    source files.
    - The index will now display when a module only contains documents,
    [#&#8203;2722](https://redirect.github.com/TypeStrong/TypeDoc/issues/2722).
    - `ReflectionSymbolId.pos` no longer references the position *before*
    any doc comments for a symbol.
    This could cause typedoc-plugin-dt-links to produce links which didn't
    go to the expected location in a file.
    
    ##### Thanks!
    
    -   [@&#8203;Corso02](https://redirect.github.com/Corso02)
    -   [@&#8203;lriggle-strib](https://redirect.github.com/lriggle-strib)
    -   [@&#8203;XeroAlpha](https://redirect.github.com/XeroAlpha)
    
    ###
    [`v0.26.7`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0267-2024-09-09)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.6...v0.26.7)
    
    ##### Features
    
    - Support TypeScript 5.6,
    [#&#8203;2699](https://redirect.github.com/TypeStrong/TypeDoc/issues/2699).
    - Added `customJs` option to include a script tag in generated HTML
    output,
    [#&#8203;2650](https://redirect.github.com/TypeStrong/TypeDoc/issues/2650).
    - Added `markdownLinkExternal` option to treat `http[s]://` links in
    markdown documents and comments as external to be opened in a new tab,
    [#&#8203;2679](https://redirect.github.com/TypeStrong/TypeDoc/issues/2679).
    - Added `navigation.excludeReferences` option to prevent re-exports from
    appearing in the left hand navigation,
    [#&#8203;2685](https://redirect.github.com/TypeStrong/TypeDoc/issues/2685).
    - Added support for the `@abstract` tag,
    [#&#8203;2692](https://redirect.github.com/TypeStrong/TypeDoc/issues/2692).
    
    ##### Bug Fixes
    
    - Fixed an issue where links in packages mode would be resolved
    incorrectly,
    [#&#8203;2680](https://redirect.github.com/TypeStrong/TypeDoc/issues/2680).
    - `@link` tags to symbols which are not included in the documentation
    will produce invalid link warnings again,
    [#&#8203;2681](https://redirect.github.com/TypeStrong/TypeDoc/issues/2681).
    - Fixed handling of `@param` tags on comments attached to function
    callback parameters,
    [#&#8203;2683](https://redirect.github.com/TypeStrong/TypeDoc/issues/2683).
    - The `alphabetical` and `alphabetical-ignoring-documents` sort options
    now use `localeCompare` to sort,
    [#&#8203;2684](https://redirect.github.com/TypeStrong/TypeDoc/issues/2684).
    - Fixed incorrect placement of parameter default values in some
    signatures with a `this` parameter,
    [#&#8203;2698](https://redirect.github.com/TypeStrong/TypeDoc/issues/2698).
    
    ##### Thanks!
    
    -   [@&#8203;Aryakoste](https://redirect.github.com/Aryakoste)
    -   [@&#8203;waynemwashuma](https://redirect.github.com/waynemwashuma)
    
    ###
    [`v0.26.6`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0266-2024-08-18)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.5...v0.26.6)
    
    ##### Features
    
    - Use of the `@extends` block tag no longer produces warnings,
    [#&#8203;2659](https://redirect.github.com/TypeStrong/TypeDoc/issues/2659).
    This tag should only be used in JavaScript projects to specify the type
    parameters used when extending a parent class. It will not be rendered.
    - Added new `navigation.compactFolders` option to prevent TypeDoc from
    compacting folders, similar to the VSCode option.
    [#&#8203;2667](https://redirect.github.com/TypeStrong/TypeDoc/issues/2667).
    
    ##### Bug Fixes
    
    - The `suppressCommentWarningsInDeclarationFiles` option now correctly
    ignores warnings in `.d.cts` and `.d.mts` files,
    [#&#8203;2647](https://redirect.github.com/TypeStrong/TypeDoc/issues/2647).
    - Restored re-exports in the page navigation menu,
    [#&#8203;2671](https://redirect.github.com/TypeStrong/TypeDoc/issues/2671).
    - JSON serialized projects will no longer contain reflection IDs for
    other projects created in the same run.
    [Gerrit0/typedoc-plugin-zod#6](https://redirect.github.com/Gerrit0/typedoc-plugin-zod/issues/6).
    - In packages mode the reflection ID counter will no longer be reset
    when converting projects. This previously could result in links to files
    not working as expected.
    
    ###
    [`v0.26.5`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0265-2024-07-21)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.4...v0.26.5)
    
    ##### Features
    
    - TypeDoc now exposes array option defaults under `OptionDefaults`,
    [#&#8203;2640](https://redirect.github.com/TypeStrong/TypeDoc/issues/2640).
    
    ##### Bug Fixes
    
    - Constructor parameters which share a name with a property on a parent
    class will no longer inherit the comment on the parent class,
    [#&#8203;2636](https://redirect.github.com/TypeStrong/TypeDoc/issues/2636).
    - Packages mode will now attempt to use the comment declared in the
    comment class for inherited members,
    [#&#8203;2622](https://redirect.github.com/TypeStrong/TypeDoc/issues/2622).
    - TypeDoc no longer crashes when `@document` includes an empty file,
    [#&#8203;2638](https://redirect.github.com/TypeStrong/TypeDoc/issues/2638).
    - API: Event listeners added later with the same priority will be called
    later,
    [#&#8203;2643](https://redirect.github.com/TypeStrong/TypeDoc/issues/2643).
    
    ##### Thanks!
    
    - [@&#8203;bladerunner2020](https://redirect.github.com/bladerunner2020)
    
    ###
    [`v0.26.4`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0264-2024-07-10)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.3...v0.26.4)
    
    ##### Bug Fixes
    
    - The page navigation sidebar no longer incorrectly includes re-exports
    if the same member is exported with multiple names
    [#&#8203;2625](https://redirect.github.com/TypeStrong/TypeDoc/issues/2625).
    - Page navigation now ensures the current page is visible when the page
    is first loaded,
    [#&#8203;2626](https://redirect.github.com/TypeStrong/TypeDoc/issues/2626).
    - If a relative linked image is referenced multiple times, TypeDoc will
    no longer sometimes produce invalid links to the image
    [#&#8203;2627](https://redirect.github.com/TypeStrong/TypeDoc/issues/2627).
    - `@link` tags will now be validated in referenced markdown documents,
    [#&#8203;2629](https://redirect.github.com/TypeStrong/TypeDoc/issues/2629).
    - `@link` tags are now resolved in project documents,
    [#&#8203;2629](https://redirect.github.com/TypeStrong/TypeDoc/issues/2629).
    - HTML/JSON output generated by TypeDoc now contains a trailing newline,
    [#&#8203;2632](https://redirect.github.com/TypeStrong/TypeDoc/issues/2632).
    - TypeDoc now correctly handles markdown documents with CRLF line
    endings,
    [#&#8203;2628](https://redirect.github.com/TypeStrong/TypeDoc/issues/2628).
    - `@hidden` is now properly applied when placed in a function
    implementation comment,
    [#&#8203;2634](https://redirect.github.com/TypeStrong/TypeDoc/issues/2634).
    -   Comments on re-exports are now rendered.
    
    ##### Thanks!
    
    -   [@&#8203;bukowa](https://redirect.github.com/bukowa)
    -   [@&#8203;garrett-hopper](https://redirect.github.com/garrett-hopper)
    
    ###
    [`v0.26.3`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0263-2024-06-28)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.2...v0.26.3)
    
    ##### Features
    
    - "On This Page" navigation now includes the page groups in collapsible
    sections,
    [#&#8203;2616](https://redirect.github.com/TypeStrong/TypeDoc/issues/2616).
    
    ##### Bug Fixes
    
    - `mailto:` links are no longer incorrectly recognized as relative
    paths,
    [#&#8203;2613](https://redirect.github.com/TypeStrong/TypeDoc/issues/2613).
    - Added `@since` to the default list of recognized tags,
    [#&#8203;2614](https://redirect.github.com/TypeStrong/TypeDoc/issues/2614).
    - Relative paths to directories will no longer cause the directory to be
    copied into the media directory,
    [#&#8203;2617](https://redirect.github.com/TypeStrong/TypeDoc/issues/2617).
    
    ###
    [`v0.26.2`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0262-2024-06-24)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.1...v0.26.2)
    
    ##### Features
    
    - Added a `--suppressCommentWarningsInDeclarationFiles` option to
    disable warnings from
    parsing comments in declaration files,
    [#&#8203;2611](https://redirect.github.com/TypeStrong/TypeDoc/issues/2611).
    - Improved comment discovery to more closely match TypeScript's
    discovery when getting comments
    for members of interfaces/classes,
    [#&#8203;2084](https://redirect.github.com/TypeStrong/TypeDoc/issues/2084),
    [#&#8203;2545](https://redirect.github.com/TypeStrong/TypeDoc/issues/2545).
    
    ##### Bug Fixes
    
    - The `text` non-highlighted language no longer causes warnings when
    rendering,
    [#&#8203;2610](https://redirect.github.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://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0261-2024-06-22)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.26.0...v0.26.1)
    
    ##### Features
    
    - Improved Korean translation coverage,
    [#&#8203;2602](https://redirect.github.com/TypeStrong/TypeDoc/issues/2602).
    
    ##### Bug Fixes
    
    - Added `@author` to the default list of recognized tags,
    [#&#8203;2603](https://redirect.github.com/TypeStrong/TypeDoc/issues/2603).
    - Anchor links are no longer incorrectly checked for relative paths,
    [#&#8203;2604](https://redirect.github.com/TypeStrong/TypeDoc/issues/2604).
    - Fixed an issue where line numbers reported in error messages could be
    incorrect,
    [#&#8203;2605](https://redirect.github.com/TypeStrong/TypeDoc/issues/2605).
    - Fixed relative link detection for markdown links containing code in
    their label,
    [#&#8203;2606](https://redirect.github.com/TypeStrong/TypeDoc/issues/2606).
    - Fixed an issue with packages mode where TypeDoc would use (much) more
    memory than required,
    [#&#8203;2607](https://redirect.github.com/TypeStrong/TypeDoc/issues/2607).
    - TypeDoc will no longer crash when asked to render highlighted code for
    an unsupported language,
    [#&#8203;2609](https://redirect.github.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!
    
    -   [@&#8203;KNU-K](https://redirect.github.com/KNU-K)
    
    ###
    [`v0.26.0`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0260-2024-06-22)
    
    [Compare
    Source](https://redirect.github.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,
    [#&#8203;2600](https://redirect.github.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,
    [#&#8203;2521](https://redirect.github.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
    [#&#8203;247](https://redirect.github.com/TypeStrong/TypeDoc/issues/247),
    [#&#8203;1870](https://redirect.github.com/TypeStrong/TypeDoc/issues/1870),
    [#&#8203;2288](https://redirect.github.com/TypeStrong/TypeDoc/issues/2288),
    [#&#8203;2565](https://redirect.github.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,
    [#&#8203;2475](https://redirect.github.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`,
    [#&#8203;2523](https://redirect.github.com/TypeStrong/TypeDoc/issues/2523).
    - `--hostedBaseUrl` will now be used to generate a `<link
    rel="canonical">` element in the project root page,
    [#&#8203;2550](https://redirect.github.com/TypeStrong/TypeDoc/issues/2550).
    - Added support for documenting individual elements of a union type,
    [#&#8203;2585](https://redirect.github.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,
    [#&#8203;2581](https://redirect.github.com/TypeStrong/TypeDoc/issues/2581).
    - New option, `--customFooterHtml` to add custom HTML to the generated
    page footer,
    [#&#8203;2559](https://redirect.github.com/TypeStrong/TypeDoc/issues/2559).
    - TypeDoc will now copy modifier tags to children if specified in the
    `--cascadedModifierTags` option,
    [#&#8203;2056](https://redirect.github.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`),
    [#&#8203;2056](https://redirect.github.com/TypeStrong/TypeDoc/issues/2056).
    - Groups and categories can now be collapsed in the page body,
    [#&#8203;2330](https://redirect.github.com/TypeStrong/TypeDoc/issues/2330).
    -   Added support for JSDoc `@hideconstructor` tag.
    This tag should only be used to work around
    [TypeScript#58653](https://redirect.github.com/TypeScript/TypeDoc/issues/58653),
    prefer the more general `@hidden`/`@ignore` tag to hide members
    normally,
    [#&#8203;2577](https://redirect.github.com/TypeStrong/TypeDoc/issues/2577).
    - Added `--useHostedBaseUrlForAbsoluteLinks` option to use the
    `--hostedBaseUrl` option to produce absolute links to pages on a site,
    [#&#8203;940](https://redirect.github.com/TypeStrong/TypeDoc/issues/940).
    - Tag headers now generate permalinks in the default theme,
    [#&#8203;2308](https://redirect.github.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,
    [#&#8203;2574](https://redirect.github.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,
    [#&#8203;2470](https://redirect.github.com/TypeStrong/TypeDoc/issues/2470).
    - Header anchor links in rendered markdown are now more consistent with
    headers generated by TypeDoc,
    [#&#8203;2546](https://redirect.github.com/TypeStrong/TypeDoc/issues/2546).
    - Types rendered in the `Returns` header are now properly colored,
    [#&#8203;2546](https://redirect.github.com/TypeStrong/TypeDoc/issues/2546).
    - Links added with the `navigationLinks` option are now moved into the
    pull out navigation on mobile displays,
    [#&#8203;2548](https://redirect.github.com/TypeStrong/TypeDoc/issues/2548).
    - `@license` and `@import` comments will be ignored at the top of files,
    [#&#8203;2552](https://redirect.github.com/TypeStrong/TypeDoc/issues/2552).
    - Fixed issue in documentation validation where constructor signatures
    where improperly considered not documented,
    [#&#8203;2553](https://redirect.github.com/TypeStrong/TypeDoc/issues/2553).
    - Keyboard focus is now visible on dropdowns and checkboxes in the
    default theme,
    [#&#8203;2556](https://redirect.github.com/TypeStrong/TypeDoc/issues/2556).
    - The color theme label in the default theme now has an accessible name,
    [#&#8203;2557](https://redirect.github.com/TypeStrong/TypeDoc/issues/2557).
    - Fixed issue where search results could not be navigated while Windows
    Narrator was on,
    [#&#8203;2563](https://redirect.github.com/TypeStrong/TypeDoc/issues/2563).
    - `charset` is now correctly cased in `<meta>` tag generated by the
    default theme,
    [#&#8203;2568](https://redirect.github.com/TypeStrong/TypeDoc/issues/2568).
    - Fixed very slow conversion on Windows where Msys git was used by
    typedoc to discover repository links,
    [#&#8203;2586](https://redirect.github.com/TypeStrong/TypeDoc/issues/2586).
    - Validation will now be run in watch mode,
    [#&#8203;2584](https://redirect.github.com/TypeStrong/TypeDoc/issues/2584).
    - Fixed an issue where custom themes which added dependencies in the
    `<head>` element could result in broken icons,
    [#&#8203;2589](https://redirect.github.com/TypeStrong/TypeDoc/issues/2589).
    - `@default` and `@defaultValue` blocks are now recognized as regular
    blocks if they include inline tags,
    [#&#8203;2601](https://redirect.github.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!
    
    -   [@&#8203;Aryakoste](https://redirect.github.com/Aryakoste)
    - [@&#8203;bladerunner2020](https://redirect.github.com/bladerunner2020)
    -   [@&#8203;Dinnerbone](https://redirect.github.com/Dinnerbone)
    -   [@&#8203;HarelM](https://redirect.github.com/HarelM)
    -   [@&#8203;kraenhansen](https://redirect.github.com/kraenhansen)
    -   [@&#8203;Nil2000](https://redirect.github.com/Nil2000)
    -   [@&#8203;steve02081504](https://redirect.github.com/steve02081504)
    -   [@&#8203;tristanzander](https://redirect.github.com/tristanzander)
    
    ###
    [`v0.25.13`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02513-2024-04-07)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.25.12...v0.25.13)
    
    ##### Features
    
    - Added `gitRevision:short` placeholder option to `--sourceLinkTemplate`
    option,
    [#&#8203;2529](https://redirect.github.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 `<footer>` tag, added
    `footer.begin` and `footer.end`
    render hooks for use by custom plugins,
    [#&#8203;2532](https://redirect.github.com/TypeStrong/TypeDoc/issues/2532).
    
    ##### Bug Fixes
    
    - Fixed conversion of `NoInfer` missing type parameter reference,
    [#&#8203;2539](https://redirect.github.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!
    
    -   [@&#8203;xuhdev](https://redirect.github.com/xuhdev)
    
    ###
    [`v0.25.12`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02512-2024-03-10)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.25.11...v0.25.12)
    
    ##### Bug Fixes
    
    - Updated page font to work around issues with Mac rendering,
    [#&#8203;2518](https://redirect.github.com/TypeStrong/TypeDoc/issues/2518)
    
    ##### Thanks!
    
    -   [@&#8203;docmattman](https://redirect.github.com/docmattman)
    
    ###
    [`v0.25.11`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02511-2024-03-06)
    
    [Compare
    Source](https://redirect.github.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,
    [#&#8203;2514](https://redirect.github.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,
    [#&#8203;2515](https://redirect.github.com/TypeStrong/TypeDoc/issues/2515).
    
    ###
    [`v0.25.10`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v02510-2024-03-03)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.25.9...v0.25.10)
    
    ##### Bug Fixes
    
    - Constructed references to enum types will be properly linked with
    `@interface`,
    [#&#8203;2508](https://redirect.github.com/TypeStrong/TypeDoc/issues/2508).
    - Comments on property-methods will no longer be duplicated in generated
    documentation,
    [#&#8203;2509](https://redirect.github.com/TypeStrong/TypeDoc/issues/2509).
    - Reduced rendered docs size by writing icons to a referenced SVG asset,
    [#&#8203;2505](https://redirect.github.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,
    [#&#8203;2491](https://redirect.github.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://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0259-2024-02-26)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.25.8...v0.25.9)
    
    ##### Features
    
    - Literal numeric unions will now be sorted during conversion,
    [#&#8203;2502](https://redirect.github.com/TypeStrong/TypeDoc/issues/2502).
    
    ##### Bug Fixes
    
    - Module readmes will now be included in JSON output,
    [#&#8203;2500](https://redirect.github.com/TypeStrong/TypeDoc/issues/2500).
    - Fixed crash when `--excludeNotDocumented` was used and the project
    contained a reference to a removed signature,
    [#&#8203;2496](https://redirect.github.com/TypeStrong/TypeDoc/issues/2496).
    - Fixed crash when converting an infinitely recursive type via a new
    `--maxTypeConversionDepth` option,
    [#&#8203;2507](https://redirect.github.com/TypeStrong/TypeDoc/issues/2507).
    - Type links in "Parameters" and "Type Parameters" sections of the page
    will now be correctly colored.
    
    ##### Thanks!
    
    -   [@&#8203;JMBeresford](https://redirect.github.com/JMBeresford)
    
    ###
    [`v0.25.8`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0258-2024-02-09)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.25.7...v0.25.8)
    
    ###
    [`v0.25.7`](https://redirect.github.com/TypeStrong/typedoc/releases/tag/v0.25.7)
    
    [Compare
    Source](https://redirect.github.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,
    [#&#8203;2476](https://redirect.github.com/TypeStrong/TypeDoc/issues/2476).
    - Fixed an infinite loop when converting a union type which directly
    contained another union type which refers to itself,
    [#&#8203;2469](https://redirect.github.com/TypeStrong/TypeDoc/issues/2469).
    
    ###
    [`v0.25.6`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0256-2024-01-01)
    
    [Compare
    Source](https://redirect.github.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,
    [#&#8203;2468](https://redirect.github.com/TypeStrong/TypeDoc/issues/2468).
    - Improved infinite loop detection in type converter to reduce false
    positives.
    
    ###
    [`v0.25.5`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0255-2024-01-01)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.25.4...v0.25.5)
    
    ###
    [`v0.25.4`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0254-2023-11-26)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.25.3...v0.25.4)
    
    ##### Features
    
    - Added support for TypeScript 5.3,
    [#&#8203;2446](https://redirect.github.com/TypeStrong/TypeDoc/issues/2446).
    - TypeDoc will now render interfaces as code at the top of the page
    describing interfaces,
    [#&#8203;2449](https://redirect.github.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,
    [#&#8203;2416](https://redirect.github.com/TypeStrong/TypeDoc/issues/2416).
    - Fixed default option values on options declared by plugins in packages
    mode,
    [#&#8203;2433](https://redirect.github.com/TypeStrong/TypeDoc/issues/2433).
    - `gitRevision` will now be replaced in `sourceLinkTemplate`,
    [#&#8203;2434](https://redirect.github.com/TypeStrong/TypeDoc/issues/2434).
    - Improved handling of function-modules created with `Object.assign`,
    [#&#8203;2436](https://redirect.github.com/TypeStrong/TypeDoc/issues/2436).
    - TypeDoc will no longer warn about duplicate comments with warnings
    which point to a single comment,
    [#&#8203;2437](https://redirect.github.com/TypeStrong/TypeDoc/issues/2437)
    - Fixed an infinite loop when `skipLibCheck` is used to ignore some
    compiler errors,
    [#&#8203;2438](https://redirect.github.com/TypeStrong/TypeDoc/issues/2438).
    - `@example` tag titles will now be rendered in the example heading,
    [#&#8203;2440](https://redirect.github.com/TypeStrong/TypeDoc/issues/2440).
    - Correctly handle transient symbols in `@namespace`-created namespaces,
    [#&#8203;2444](https://redirect.github.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!
    
    -   [@&#8203;li-jia-nan](https://redirect.github.com/li-jia-nan)
    -   [@&#8203;Nokel81](https://redirect.github.com/Nokel81)
    -   [@&#8203;ocavue](https://redirect.github.com/ocavue)
    -   [@&#8203;swarnpallav](https://redirect.github.com/swarnpallav)
    
    ###
    [`v0.25.3`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0253-2023-10-29)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.25.2...v0.25.3)
    
    ##### Features
    
    - Added `--sourceLinkExternal` option to render source code links as
    external,
    [#&#8203;2415](https://redirect.github.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,
    [#&#8203;2416](https://redirect.github.com/TypeStrong/TypeDoc/issues/2416).
    - Added `external-last` option for the `--sort` option,
    [#&#8203;2418](https://redirect.github.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,
    [#&#8203;2413](https://redirect.github.com/TypeStrong/TypeDoc/issues/2413).
    - TypeDoc now finds comments on index signatures again,
    [#&#8203;2414](https://redirect.github.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!
    
    -   [@&#8203;mogelbrod](https://redirect.github.com/mogelbrod)
    -   [@&#8203;rsanchez](https://redirect.github.com/rsanchez)
    
    ###
    [`v0.25.2`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0252-2023-10-08)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.25.1...v0.25.2)
    
    ##### Features
    
    - Added `navigationLeaves` option to remove branches from the navigation
    tree,
    [#&#8203;2382](https://redirect.github.com/TypeStrong/TypeDoc/issues/2382).
    - Added `sortEntryPoints` option (defaults to true) to allow disabling
    entry point sorting,
    [#&#8203;2393](https://redirect.github.com/TypeStrong/TypeDoc/issues/2393).
    - Improved support for multi-word searches,
    [#&#8203;2400](https://redirect.github.com/TypeStrong/TypeDoc/issues/2400).
    
    ##### Bug Fixes
    
    - Fixed conversion of `@template` constraints on JSDoc defined type
    parameters,
    [#&#8203;2389](https://redirect.github.com/TypeStrong/TypeDoc/issues/2389).
    - Invalid link validation is now correctly suppressed before all
    projects have been converted in packages mode,
    [#&#8203;2403](https://redirect.github.com/TypeStrong/TypeDoc/issues/2403).
    - Fixed tsconfig handling for projects using a solution-style tsconfig,
    [#&#8203;2406](https://redirect.github.com/TypeStrong/TypeDoc/issues/2406).
    - Fixed broken settings icons caused by icon caching introduced in
    0.25.1,
    [#&#8203;2408](https://redirect.github.com/TypeStrong/TypeDoc/issues/2408).
    - Corrected module comment handling on declaration files containing a
    single `declare module "foo"`,
    [#&#8203;2401](https://redirect.github.com/TypeStrong/TypeDoc/issues/2401).
    
    ##### Thanks!
    
    -   [@&#8203;schiem](https://redirect.github.com/schiem)
    
    ###
    [`v0.25.1`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0251-2023-09-04)
    
    [Compare
    Source](https://redirect.github.com/TypeStrong/TypeDoc/compare/v0.25.0...v0.25.1)
    
    ##### Features
    
    - Added `stripYamlFrontmatter` config option to remove YAML frontmatter
    from README.md,
    [#&#8203;2381](https://redirect.github.com/TypeStrong/TypeDoc/issues/2381).
    - Added `--excludeCategories` config option to remove reflections
    present in any excluded category,
    [#&#8203;1407](https://redirect.github.com/TypeStrong/TypeDoc/issues/1407).
    - If no tsconfig.json file is present, TypeDoc will now attempt to
    compile without setting any compiler options,
    [#&#8203;2304](https://redirect.github.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,
    [#&#8203;2287](https://redirect.github.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,
    [#&#8203;2386](https://redirect.github.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,
    [#&#8203;2378](https://redirect.github.com/TypeStrong/TypeDoc/issues/2378).
    - Improved support for optional names within JSDoc types,
    [#&#8203;2384](https://redirect.github.com/TypeStrong/TypeDoc/issues/2384).
    - Fixed duplicate rendering of reflection flags on signature parameters,
    [#&#8203;2385](https://redirect.github.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,
    [#&#8203;2376](https://redirect.github.com/TypeStrong/TypeDoc/issues/2376).
    
    ##### Thanks!
    
    -   [@&#8203;ajesshope](https://redirect.github.com/ajesshope)
    -   [@&#8203;HemalPatil](https://redirect.github.com/HemalPatil)
    -   [@&#8203;hrueger](https://redirect.github.com/hrueger)
    -   [@&#8203;typhonrt](https://redirect.github.com/typhonrt)
    
    ###
    [`v0.25.0`](https://redirect.github.com/TypeStrong/TypeDoc/blob/HEAD/CHANGELOG.md#v0250-2023-08-25)
    
    [Compare
    Source](https://redirect.github.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`,
    [#&#8203;2268](https://redirect.github.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,
    [#&#8203;2373](https://redirect.github.com/TypeStrong/TypeDoc/issues/2373).
    - TypeDoc config files now support options default-exported from an ESM
    config file,
    [#&#8203;2268](https://redirect.github.com/TypeStrong/TypeDoc/issues/2268).
    - TypeDoc config files may now export a promise containing
    configuration,
    [#&#8203;2268](https://redirect.github.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,
    [#&#8203;2355](https://redirect.github.com/TypeStrong/TypeDoc/issues/2355).
    - Added a no-results placeholder when no search results are available,
    [#&#8203;2347](https://redirect.github.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,
    [#&#8203;2326](https://redirect.github.com/TypeStrong/TypeDoc/issues/2326).
    - Added support for tags `@showGroups`, `@hideGroups`,
    `@showCategories`, `@hideCategories` to configure the navigation pane on
    a
    per-reflection basis,
    [#&#8203;2329](https://redirect.github.com/TypeStrong/TypeDoc/issues/2329).
    - With `--jsDocCompatibility.defaultTags` set, `@defaultValue` is now
    implicitly a code block if the text contains no code,
    [#&#8203;2370](https://redirect.github.com/TypeStrong/TypeDoc/issues/2370).
    
    ##### Bug Fixes
    
    - Fixed link discovery if nested (`Foo#bar`) links were used and
    `--useTsLinkResolution` is enabled in some cases,
    [#&#8203;2360](https://redirect.github.com/TypeStrong/TypeDoc/issues/2360).
    - Links with invalid declaration references will no longer silently link
    to the wrong page in some cases,
    [#&#8203;2360](https://redirect.github.com/TypeStrong/TypeDoc/issues/2360).
    - Fixed duplicate definitions in type hierarchy when using packages
    mode,
    [#&#8203;2327](https://redirect.github.com/TypeStrong/TypeDoc/issues/2327).
    - `@inheritDoc` was not properly resolved across packages in packages
    mode,
    [#&#8203;2331](https://redirect.github.com/TypeStrong/TypeDoc/issues/2331).
    - Added warning for attempted `@interface` use on union types,
    [#&#8203;2352](https://redirect.github.com/TypeStrong/TypeDoc/issues/2352).
    - Fixed misleading type annotation on `Theme.getUrls`,
    [#&#8203;2318](https://redirect.github.com/TypeStrong/TypeDoc/issues/2318).
    - Fixed duplicate namespace in documentation if `@namespace` is used on
    a variable with an associated namespace,
    [#&#8203;2364](https://redirect.github.com/TypeStrong/TypeDoc/issues/2364).
    - Fixed `@namespace` property discovery if merged with a type and the
    type was declared first
    [#&#8203;2364](https://redirect.github.com/TypeStrong/TypeDoc/issues/2364).
    - Tables in markdown are now styled,
    [#&#8203;2366](https://redirect.github.com/TypeStrong/TypeDoc/issues/2366).
    - Sidebar links no longer open in a new tab,
    [#&#8203;2353](https://redirect.github.com/TypeStrong/TypeDoc/issues/2353).
    - Headers now include some padding before rendering text,
    [#&#8203;2316](https://redirect.github.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!
    
    -   [@&#8203;camc314](https://redirect.github.com/camc314)
    -   [@&#8203;cprussin](https://redirect.github.com/cprussin)
    -   [@&#8203;roggervalf](https://redirect.github.com/roggervalf)
    -   [@&#8203;Th3S4mur41](https://redirect.github.com/Th3S4mur41)
    
    #### v0.24.8 (2023-06-04)
    
    ##### Features
    
    - Added support for TypeScript 5.1,
    [#&#8203;2296](https://redirect.github.com/TypeStrong/TypeDoc/issues/2296).
    - Added `navigation.fullTree` to control rendering the full navigation
    tree on each page,
    [#&#8203;2287](https://redirect.github.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,
    [#&#8203;2287](https://redirect.github.com/TypeStrong/TypeDoc/issues/2287).
    - Optimized icon caching to reduce file size in generated HTML
    documentation,
    [#&#8203;2287](https://redirect.github.com/TypeStrong/TypeDoc/issues/2287).
    - Render property description of "roughly top level" object types,
    [#&#8203;2276](https://redirect.github.com/TypeStrong/TypeDoc/issues/2276).
    - Added `MarkdownEvent.INCLUDE` for plugins,
    [#&#8203;2284](https://redirect.github.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,
    [#&#8203;2285](https://redirect.github.com/TypeStrong/TypeDoc/issues/2285).
    - Comments are no longer removed from classes/interfaces containing call
    signatures,
    [#&#8203;2290](https://redirect.github.com/TypeStrong/TypeDoc/issues/2290).
    
    ##### Thanks!
    
    -   [@&#8203;krisztianb](https://redirect.github.com/krisztianb)
    -   [@&#8203;WikiRik](https://redirect.github.com/WikiRik)
    
    #### v0.24.7 (2023-05-08)
    
    ##### Features
    
    - TypeDoc will now allow conversion without any entry points to support
    "readme only" packages,
    [#&#8203;2264](https://redirect.github.com/TypeStrong/TypeDoc/issues/2264).
    
    ##### Bug Fixes
    
    - Category children are now sorted according to the `sort` option,
    [#&#8203;2272](https://redirect.github.com/TypeStrong/TypeDoc/issues/2272).
    - Inline tags no longer require a space after the tag name to be parsed
    as a tag,
    [#&#8203;2273](https://redirect.github.com/TypeStrong/TypeDoc/issues/2273).
    - Fixed module/namespace links in navigation when viewed in Safari,
    [#&#8203;2275](https://redirect.github.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,
    [#&#8203;2242](https://redirect.github.com/TypeStrong/TypeDoc/issues/2242).
    - API: Added support for `g`, `circle`, `ellipse`, `polygon`, and
    `polyline` svg elements,
    [#&#8203;2259](https://redirect.github.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,
    [#&#8203;2260](https://redirect.github.com/TypeStrong/TypeDoc/issues/2260).
    - The current namespace will also be expanded in the navigation on page
    load,
    [#&#8203;2260](https://redirect.github.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!
    
    -   [@&#8203;FlippieCoetser](https://redirect.github.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,
    [#&#8203;1532](https://redirect.github.com/TypeStrong/TypeDoc/issues/1532).
    - Added support for discovering a "module" comment on global files,
    [#&#8203;2165](https://redirect.github.com/TypeStrong/TypeDoc/issues/2165).
    - Added copy code to clipboard button,
    [#&#8203;2153](https://redirect.github.com/TypeStrong/TypeDoc/issues/2153).
    - Function `@returns` blocks will now be rendered with the return type,
    [#&#8203;2180](https://redirect.github.com/TypeStrong/TypeDoc/issues/2180).
    - Added `--groupOrder` option to specify the sort order of groups,
    [#&#8203;2251](https://redirect.github.com/TypeStrong/TypeDoc/issues/2251).
    
    ##### Bug Fixes
    
    - Type parameter constraints now respect the
    `--hideParameterTypesInTitle` option,
    [#&#8203;2226](https://redirect.github.com/TypeStrong/TypeDoc/issues/2226).
    - Even more contrast fixes,
    [#&#8203;2248](https://redirect.github.com/TypeStrong/TypeDoc/issues/2248).
    - Fix semantic highlighting for predicate type's parameter references,
    [#&#8203;2249](https://redirect.github.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!
    
    -   [@&#8203;FlippieCoetser](https://redirect.github.com/FlippieCoetser)
    
    #### v0.24.4 (2023-04-16)
    
    ##### Bug Fixes
    
    - Fixed broken semantic coloring,
    [#&#8203;2247](https://redirect.github.com/TypeStrong/TypeDoc/issues/2247).
    - Increased contrast for parameter titles in dark mode to meet WCAG AA
    contrast requirements,
    [#&#8203;2244](https://redirect.github.com/TypeStrong/TypeDoc/issues/2244).
    - Underline color of index links now matches the text color,
    [#&#8203;2245](https://redirect.github.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,
    [#&#8203;2243](https://redirect.github.com/TypeStrong/TypeDoc/issues/2243)
    and
    [#&#8203;2241](https://redirect.github.com/TypeStrong/TypeDoc/issues/2241).
    
    #### v0.24.2 (2023-04-15)
    
    ##### Features
    
    - Added semantic link coloring for reflection names & links,
    [#&#8203;2227](https://redirect.github.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 `&amp;` and HTML text showing up in page contents
    navigation,
    [#&#8203;2224](https://redirect.github.com/TypeStrong/TypeDoc/issues/2224).
    - Increased padding between sections when one navigation column is
    displayed,
    [#&#8203;2225](https://redirect.github.com/TypeStrong/TypeDoc/issues/2225).
    - Correct padding for navigation elements with a displayed icon,
    [#&#8203;2229](https://redirect.github.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,
    [#&#8203;2237](https://redirect.github.com/TypeStrong/TypeDoc/issues/2237).
    - Updated highlight colors for semantic links to meet WCAG AA contrast
    requirements,
    [#&#8203;2228](https://redirect.github.com/TypeStrong/TypeDoc/issues/2228).
    - Type parameters are now highlighted consistently,
    [#&#8203;2230](https://redirect.github.com/TypeStrong/TypeDoc/issues/2230).
    - Fixed semantic coloring in type and function signatures,
    [#&#8203;2227](https://redirect.github.com/TypeStrong/TypeDoc/issues/2227).
    - Fixed issue where removing a reflection indirectly containing an
    object/function type would only partially remove the reflection,
    [#&#8203;2231](https://redirect.github.com/TypeStrong/TypeDoc/issues/2231).
    - Fixed "Implementation of X.y" links if a mixture of methods and
    property-methods are used,
    [#&#8203;2233](https://redirect.github.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 `__@&#8203;`
    symbol name,
    [#&#8203;2234](https://redirect.github.com/TypeStrong/TypeDoc/issues/2234).
    - Fix expansion of globs if a single entry point is provided,
    [#&#8203;2235](https://redirect.github.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!
    
    -   [@&#8203;RunDevelopment](https://redirect.github.com/RunDevelopment)
    
    #### v0.24.1 (2023-04-09)
    
    ##### Bug Fixes
    
    - Improve detection for legacy JSDoc `@example` tags,
    [#&#8203;2222](https://redirect.github.com/TypeStrong/TypeDoc/issues/2222).
    - The page footer will now appear at the bottom of the page even if the
    page is short,
    [#&#8203;2223](https://redirect.github.com/TypeStrong/TypeDoc/issues/2223).
    
    </details>
    
    ---
    
    ### Configuration
    
    📅 **Schedule**: Branch creation - At any time (no schedule defined),
    Automerge - At any time (no schedule defined).
    
    🚦 **Automerge**: Enabled.
    
    ♻ **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.
    
    ---
    
    - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
    this box
    
    ---
    
    This PR was generated by [Mend Renovate](https://mend.io/renovate/).
    View the [repository job
    log](https://developer.mend.io/github/JoshuaKGoldberg/ts-api-utils).
    
    <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4xOS4wIiwidXBkYXRlZEluVmVyIjoiMzkuMTkuMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiZGVwZW5kZW5jaWVzIl19-->
    
    Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
    renovate[bot] authored Nov 24, 2024

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    99013dc View commit details

Commits on Nov 25, 2024

  1. build: specify max allowed versions of dependencies (#579)

    RebeccaStevens authored Nov 25, 2024

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    9d41473 View commit details
  2. chore(deps): update dependency eslint-plugin-n to v17.14.0 (#577)

    This PR contains the following updates:
    
    | Package | Change | Age | Adoption | Passing | Confidence |
    |---|---|---|---|---|---|
    |
    [eslint-plugin-n](https://redirect.github.com/eslint-community/eslint-plugin-n)
    | [`17.13.2` ->
    `17.14.0`](https://renovatebot.com/diffs/npm/eslint-plugin-n/17.13.2/17.14.0)
    |
    [![age](https://developer.mend.io/api/mc/badges/age/npm/eslint-plugin-n/17.14.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
    |
    [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/eslint-plugin-n/17.14.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
    |
    [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/eslint-plugin-n/17.13.2/17.14.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
    |
    [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/eslint-plugin-n/17.13.2/17.14.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
    |
    
    ---
    
    ### Release Notes
    
    <details>
    <summary>eslint-community/eslint-plugin-n (eslint-plugin-n)</summary>
    
    ###
    [`v17.14.0`](https://redirect.github.com/eslint-community/eslint-plugin-n/blob/HEAD/CHANGELOG.md#17140-2024-11-21)
    
    [Compare
    Source](https://redirect.github.com/eslint-community/eslint-plugin-n/compare/v17.13.2...v17.14.0)
    
    ##### 🌟 Features
    
    - **no-sync:** Add ignores option
    ([#&#8203;386](https://redirect.github.com/eslint-community/eslint-plugin-n/issues/386))
    ([c8fbf00](https://redirect.github.com/eslint-community/eslint-plugin-n/commit/c8fbf000e337d3b099e89465adda3be8e0541554))
    - **no-unsupported:** support Node 23.2.0 & 23.3.0
    ([#&#8203;390](https://redirect.github.com/eslint-community/eslint-plugin-n/issues/390))
    ([a52c968](https://redirect.github.com/eslint-community/eslint-plugin-n/commit/a52c96813496c346cd9cacc23df8ade2567012af))
    
    </details>
    
    ---
    
    ### Configuration
    
    📅 **Schedule**: Branch creation - At any time (no schedule defined),
    Automerge - At any time (no schedule defined).
    
    🚦 **Automerge**: Enabled.
    
    ♻ **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.
    
    ---
    
    - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
    this box
    
    ---
    
    This PR was generated by [Mend Renovate](https://mend.io/renovate/).
    View the [repository job
    log](https://developer.mend.io/github/JoshuaKGoldberg/ts-api-utils).
    
    <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4xOS4wIiwidXBkYXRlZEluVmVyIjoiMzkuMTkuMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiZGVwZW5kZW5jaWVzIl19-->
    
    Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
    renovate[bot] authored Nov 25, 2024

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    036458b View commit details
  3. ci: sync workflows to the gh-pages branch (#581)

    RebeccaStevens authored Nov 25, 2024

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    0898b8e View commit details
  4. ci: fix up (#582)

    RebeccaStevens authored Nov 25, 2024
    Copy the full SHA
    02c9801 View commit details
  5. Revert "ci: fix up (#582)" (#583)

    RebeccaStevens authored Nov 25, 2024
    Copy the full SHA
    1d4297b View commit details
  6. ci: fix up releasing the docs (#584)

    RebeccaStevens authored Nov 25, 2024
    Copy the full SHA
    f8fc5d2 View commit details
  7. Copy the full SHA
    2d41680 View commit details
  8. chore(deps): update dependency knip to v5.37.2 (#586)

    This PR contains the following updates:
    
    | Package | Change | Age | Adoption | Passing | Confidence |
    |---|---|---|---|---|---|
    | [knip](https://knip.dev)
    ([source](https://redirect.github.com/webpro-nl/knip/tree/HEAD/packages/knip))
    | [`5.37.1` ->
    `5.37.2`](https://renovatebot.com/diffs/npm/knip/5.37.1/5.37.2) |
    [![age](https://developer.mend.io/api/mc/badges/age/npm/knip/5.37.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
    |
    [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/knip/5.37.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
    |
    [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/knip/5.37.1/5.37.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
    |
    [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/knip/5.37.1/5.37.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
    |
    
    ---
    
    ### Release Notes
    
    <details>
    <summary>webpro-nl/knip (knip)</summary>
    
    ###
    [`v5.37.2`](https://redirect.github.com/webpro-nl/knip/releases/tag/5.37.2)
    
    [Compare
    Source](https://redirect.github.com/webpro-nl/knip/compare/5.37.1...5.37.2)
    
    - Update some deps
    ([`862701e`](https://redirect.github.com/webpro-nl/knip/commit/862701ea))
    - Fix up ec styling a bit
    ([`9bdb2c0`](https://redirect.github.com/webpro-nl/knip/commit/9bdb2c06))
    - Add array expression to `isConsiderReferencedNS` (resolves
    [#&#8203;844](https://redirect.github.com/webpro-nl/knip/issues/844))
    ([`1baa1d4`](https://redirect.github.com/webpro-nl/knip/commit/1baa1d4c))
    - Fix up unused files for jest-unit (resolves
    [#&#8203;841](https://redirect.github.com/webpro-nl/knip/issues/841))
    ([`4657618`](https://redirect.github.com/webpro-nl/knip/commit/4657618d))
    
    </details>
    
    ---
    
    ### Configuration
    
    📅 **Schedule**: Branch creation - At any time (no schedule defined),
    Automerge - At any time (no schedule defined).
    
    🚦 **Automerge**: Enabled.
    
    ♻ **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.
    
    ---
    
    - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
    this box
    
    ---
    
    This PR was generated by [Mend Renovate](https://mend.io/renovate/).
    View the [repository job
    log](https://developer.mend.io/github/JoshuaKGoldberg/ts-api-utils).
    
    <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4xOS4wIiwidXBkYXRlZEluVmVyIjoiMzkuMTkuMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiZGVwZW5kZW5jaWVzIl19-->
    
    Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
    renovate[bot] authored Nov 25, 2024
    Copy the full SHA
    2c3814d View commit details
  9. chore(deps): update dependency typedoc-plugin-mdn-links to v4 (#590)

    This PR contains the following updates:
    
    | Package | Change | Age | Adoption | Passing | Confidence |
    |---|---|---|---|---|---|
    |
    [typedoc-plugin-mdn-links](https://redirect.github.com/Gerrit0/typedoc-plugin-mdn-links)
    | [`^3.1.8` ->
    `^4.0.0`](https://renovatebot.com/diffs/npm/typedoc-plugin-mdn-links/3.3.8/4.0.0)
    |
    [![age](https://developer.mend.io/api/mc/badges/age/npm/typedoc-plugin-mdn-links/4.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
    |
    [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/typedoc-plugin-mdn-links/4.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
    |
    [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/typedoc-plugin-mdn-links/3.3.8/4.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
    |
    [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/typedoc-plugin-mdn-links/3.3.8/4.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
    |
    
    ---
    
    ### Release Notes
    
    <details>
    <summary>Gerrit0/typedoc-plugin-mdn-links
    (typedoc-plugin-mdn-links)</summary>
    
    ###
    [`v4.0.0`](https://redirect.github.com/Gerrit0/typedoc-plugin-mdn-links/blob/HEAD/CHANGELOG.md#v400-2024-11-22)
    
    [Compare
    Source](https://redirect.github.com/Gerrit0/typedoc-plugin-mdn-links/compare/v3.3.8...v4.0.0)
    
    -   Breaking: Drop support for TypeDoc before 0.26.0
    -   Add support for TypeDoc 0.27.x
    - Fix issue when linking to static methods on global objects,
    [#&#8203;22](https://redirect.github.com/Gerrit0/typedoc-plugin-mdn-links/issues/22)
    
    </details>
    
    ---
    
    ### Configuration
    
    📅 **Schedule**: Branch creation - At any time (no schedule defined),
    Automerge - At any time (no schedule defined).
    
    🚦 **Automerge**: Enabled.
    
    ♻ **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.
    
    ---
    
    - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
    this box
    
    ---
    
    This PR was generated by [Mend Renovate](https://mend.io/renovate/).
    View the [repository job
    log](https://developer.mend.io/github/JoshuaKGoldberg/ts-api-utils).
    
    <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4xOS4wIiwidXBkYXRlZEluVmVyIjoiMzkuMTkuMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiZGVwZW5kZW5jaWVzIl19-->
    
    Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
    renovate[bot] authored Nov 25, 2024
    Copy the full SHA
    2b84fdf View commit details

Commits on Nov 26, 2024

  1. build: remove semver dependency (#587)

    Co-authored-by: Rebecca Stevens <rebecca.stevens@outlook.co.nz>
    fisker and RebeccaStevens authored Nov 26, 2024
    Copy the full SHA
    8cec962 View commit details
  2. build: shrink size of bundle (#576)

    Co-authored-by: Rebecca Stevens <rebecca.stevens@outlook.co.nz>
    JoshuaKGoldberg and RebeccaStevens authored Nov 26, 2024
    Copy the full SHA
    3c06f35 View commit details
  3. chore(deps): update dependency markdownlint-cli to ^0.43.0 (#592)

    This PR contains the following updates:
    
    | Package | Change | Age | Adoption | Passing | Confidence |
    |---|---|---|---|---|---|
    |
    [markdownlint-cli](https://redirect.github.com/igorshubovych/markdownlint-cli)
    | [`^0.42.0` ->
    `^0.43.0`](https://renovatebot.com/diffs/npm/markdownlint-cli/0.42.0/0.43.0)
    |
    [![age](https://developer.mend.io/api/mc/badges/age/npm/markdownlint-cli/0.43.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
    |
    [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/markdownlint-cli/0.43.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
    |
    [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/markdownlint-cli/0.42.0/0.43.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
    |
    [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/markdownlint-cli/0.42.0/0.43.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
    |
    
    ---
    
    ### Release Notes
    
    <details>
    <summary>igorshubovych/markdownlint-cli (markdownlint-cli)</summary>
    
    ###
    [`v0.43.0`](https://redirect.github.com/igorshubovych/markdownlint-cli/compare/v0.42.0...v0.43.0)
    
    [Compare
    Source](https://redirect.github.com/igorshubovych/markdownlint-cli/compare/v0.42.0...v0.43.0)
    
    </details>
    
    ---
    
    ### Configuration
    
    📅 **Schedule**: Branch creation - At any time (no schedule defined),
    Automerge - At any time (no schedule defined).
    
    🚦 **Automerge**: Enabled.
    
    ♻ **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.
    
    ---
    
    - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
    this box
    
    ---
    
    This PR was generated by [Mend Renovate](https://mend.io/renovate/).
    View the [repository job
    log](https://developer.mend.io/github/JoshuaKGoldberg/ts-api-utils).
    
    <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4xOS4wIiwidXBkYXRlZEluVmVyIjoiMzkuMTkuMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiZGVwZW5kZW5jaWVzIl19-->
    
    Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
    renovate[bot] authored Nov 26, 2024
    Copy the full SHA
    be38cbb View commit details
  4. perf: reduce package size (#593)

    RebeccaStevens authored Nov 26, 2024
    Copy the full SHA
    123a8f4 View commit details
  5. build: set package.json version to latest release (#594)

    RebeccaStevens authored Nov 26, 2024
    Copy the full SHA
    c452cf6 View commit details
  6. chore: release v1.4.2

    RebeccaStevens committed Nov 26, 2024
    Copy the full SHA
    cbfd5dc View commit details
Showing with 107 additions and 63 deletions.
  1. +10 −0 .github/renovate.json
  2. +3 −3 .github/workflows/docs-release.yml
  3. +42 −0 .github/workflows/gh-pages-sync-workflows.yml
  4. +10 −0 CHANGELOG.md
  5. +2 −2 docs/coverage.svg
  6. +4 −6 package.json
  7. +24 −44 pnpm-lock.yaml
  8. +2 −2 src/types/utilities.test.ts
  9. +4 −4 src/types/utilities.ts
  10. +6 −2 tsup.config.ts
10 changes: 10 additions & 0 deletions .github/renovate.json
Original file line number Diff line number Diff line change
@@ -4,5 +4,15 @@
"internalChecksFilter": "strict",
"labels": ["dependencies"],
"minimumReleaseAge": "3 days",
"packageRules": [
{
"allowedVersions": "<0.25",
"matchPackageNames": ["typedoc"]
},
{
"allowedVersions": "<5.5",
"matchPackageNames": ["typescript"]
}
],
"postUpdateOptions": ["pnpmDedupe"]
}
6 changes: 3 additions & 3 deletions .github/workflows/docs-release.yml
Original file line number Diff line number Diff line change
@@ -11,8 +11,6 @@ jobs:
with:
ref: gh-pages

- uses: ./.github/actions/prepare

- name: Create a pages artifact
uses: actions/upload-pages-artifact@v2
with:
@@ -25,11 +23,13 @@ jobs:
- name: Store Coverage Badge
run: cp ./docs/generated/stable/coverage.svg /tmp/coverage.svg

- name: get gh-pages
- name: Checkout Main
uses: actions/checkout@v3
with:
ref: main

- uses: ./.github/actions/prepare

- name: Update Coverage Badge
run: cp /tmp/coverage.svg ./docs/coverage.svg

42 changes: 42 additions & 0 deletions .github/workflows/gh-pages-sync-workflows.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
jobs:
sync_gh-pages_workflows:
runs-on: ubuntu-latest
steps:
- name: Checkout main
uses: actions/checkout@v3
- uses: ./.github/actions/prepare

- name: Save actions and workflows
run: tar -cvf /tmp/workflows.tar ./.github/actions ./.github/workflows

- name: Checkout gh-pages
uses: actions/checkout@v3
with:
ref: gh-pages

- name: Restore actions and workflows
run: |
mkdir -p ./.github/
rm -rf ./.github/actions ./.github/workflows
tar -xf /tmp/workflows.tar ./.github -C ./.github
- continue-on-error: true
name: Commit
run: |
git add -f .github
git commit -m "ci: update workflows"
git push
name: Sync workflows to gh-pages branch
on:
push:
branches:
- main
paths:
- .github/actions/**
- .github/workflows/**
workflow_dispatch: ~

permissions:
contents: write
id-token: write
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
## [1.4.2](https://github.com/JoshuaKGoldberg/ts-api-utils/compare/v1.4.0...v1.4.2) (2024-11-26)

### Bug Fixes

- remove `.value` field from type declarations for boolean literal types ([#535](https://github.com/JoshuaKGoldberg/ts-api-utils/issues/535)) ([12df298](https://github.com/JoshuaKGoldberg/ts-api-utils/commit/12df29810c4a0b9146f58fdee4a2cbdf28a1bee0)), closes [#528](https://github.com/JoshuaKGoldberg/ts-api-utils/issues/528)

### Performance Improvements

- reduce package size ([#593](https://github.com/JoshuaKGoldberg/ts-api-utils/issues/593)) ([123a8f4](https://github.com/JoshuaKGoldberg/ts-api-utils/commit/123a8f46cbb552bcd3b16ea30ff8925755fc516e))

# [1.4.0](https://github.com/JoshuaKGoldberg/ts-api-utils/compare/v1.2.1...v1.4.0) (2024-10-30)

### Bug Fixes
4 changes: 2 additions & 2 deletions docs/coverage.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 4 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ts-api-utils",
"version": "1.4.0",
"version": "1.4.2",
"description": "Utility functions for working with TypeScript's API. Successor to the wonderful tsutils. 🛠️️",
"repository": {
"type": "git",
@@ -53,7 +53,6 @@
"@phenomnomnominal/tsquery": "^6.1.3",
"@release-it/conventional-changelog": "^9.0.0",
"@types/eslint": "^8.56.5",
"@types/semver": "^7.5.8",
"@typescript-eslint/eslint-plugin": "^7.3.1",
"@typescript-eslint/parser": "^8.0.0",
"@typescript/vfs": "^1.5.0",
@@ -77,20 +76,19 @@
"knip": "^5.12.3",
"lint-staged": "^15.2.2",
"markdownlint": "^0.36.0",
"markdownlint-cli": "^0.42.0",
"markdownlint-cli": "^0.43.0",
"prettier": "^3.1.1",
"prettier-plugin-curly": "^0.3.0",
"prettier-plugin-packagejson": "^2.4.7",
"release-it": "^17.0.1",
"semver": "^7.6.2",
"sentences-per-line": "^0.2.1",
"should-semantic-release": "^0.3.0",
"tsup": "^8.0.2",
"typedoc": "^0.24.8",
"typedoc": "~0.24.8",
"typedoc-plugin-coverage": "^3.0.0",
"typedoc-plugin-custom-validation": "^2.0.2",
"typedoc-plugin-konamimojisplosion": "^0.0.2",
"typedoc-plugin-mdn-links": "^3.1.8",
"typedoc-plugin-mdn-links": "^4.0.0",
"typedoc-plugin-versions": "^0.2.4",
"typescript": "~5.4.5",
"vitest": "^1.3.1",
68 changes: 24 additions & 44 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/types/utilities.test.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import semver from "semver";
import ts from "typescript";
import { describe, expect, it } from "vitest";

import { createSourceFileAndTypeChecker } from "../test/utils";
import { isTsVersionAtLeast } from "../utils";
import {
isFalsyType,
isPropertyReadonlyInType,
@@ -133,7 +133,7 @@ describe("symbolHasReadonlyDeclaration", () => {
expect(symbolHasReadonlyDeclaration(symbol, typeChecker)).toBe(expected);
});

if (semver.gte(ts.version, "5.0.0")) {
if (isTsVersionAtLeast(5, 0)) {
it("returns true when the symbol belongs to a property of a nested object literal directly passed into a function that declares the parameter with a const type parameter", () => {
const { sourceFile, typeChecker } = createSourceFileAndTypeChecker(`
declare const fn: <const A>(param: A) => unknown;
Loading