Skip to content

Conversation

@dependabot
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Oct 13, 2025

Bumps typedoc from 0.28.9 to 0.28.14.

Release notes

Sourced from typedoc's releases.

v0.28.14

Features

  • Introduced the preservedTypeAnnotationTags option to specify tags whose type annotations should be copied to the output documentation, #3020. API: Introduced typeAnnotation on CommentTag
  • Added excludePrivateClassFields option to hide #private members while allowing private members, #3017.
  • Added support for TypeScript's @this tag for JS files which describe this parameters, #3026.

Bug Fixes

  • Fixed conversion of auto-accessor types on properties with the accessor keyword, #3019.
  • Improved handling of HTML tags within headers for anchor generation, #3023.
  • Improved support for detecting destructured parameters and renaming them to the name used in the doc comment, #3026.

v0.28.13

Features

  • The basePath option now also affects relative link resolution, TypeDoc will also check for paths relative to the provided base path. If you instead want TypeDoc to only change the rendered base path for sources, use the displayBasePath option, #3009.

Bug Fixes

  • Fixed bug introduced in 0.28.8 where TypeDoc could not render docs with some mixin classes, #3007.
  • @inheritDoc will now correctly overwrite @remarks and @returns blocks on the target comment, #3012.
  • The externalSymbolLinkMappings option now works properly on links pointing to inherited/overwritten signatures, #3014.

v0.28.12

Bug Fixes

  • Variables marked with @enum now work for symbols imported from another module, #3003.
  • Improved magic introduced with #2999 to work with imported symbols, #3003.
  • Fixed relative link resolution to file names containing percent encoded URLs, #3006.
  • Linking to the project's README file with a relative link will now behave as expected, #3006.
  • Reduced unnecessary HTML element rendering in default theme. API: Reflection.hasComment and Comment.hasVisibleComponent now accepts an optional notRenderedTags parameter.

v0.28.11

Features

  • Object properties declared with shorthand property assignment will now use the variable's comment if they do not have their own comment, #2999.

Bug Fixes

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.28.14 (2025-10-11)

Features

  • Introduced the preservedTypeAnnotationTags option to specify tags whose type annotations should be copied to the output documentation, #3020. API: Introduced typeAnnotation on CommentTag
  • Added excludePrivateClassFields option to hide #private members while allowing private members, #3017.
  • Added support for TypeScript's @this tag for JS files which describe this parameters, #3026.

Bug Fixes

  • Fixed conversion of auto-accessor types on properties with the accessor keyword, #3019.
  • Improved handling of HTML tags within headers for anchor generation, #3023.
  • Improved support for detecting destructured parameters and renaming them to the name used in the doc comment, #3026.

v0.28.13 (2025-09-14)

Features

  • The basePath option now also affects relative link resolution, TypeDoc will also check for paths relative to the provided base path. If you instead want TypeDoc to only change the rendered base path for sources, use the displayBasePath option, #3009.

Bug Fixes

  • Fixed bug introduced in 0.28.8 where TypeDoc could not render docs with some mixin classes, #3007.
  • @inheritDoc will now correctly overwrite @remarks and @returns blocks on the target comment, #3012.
  • The externalSymbolLinkMappings option now works properly on links pointing to inherited/overwritten signatures, #3014.

v0.28.12 (2025-09-01)

Bug Fixes

  • Variables marked with @enum now work for symbols imported from another module, #3003.
  • Improved magic introduced with #2999 to work with imported symbols, #3003.
  • Fixed relative link resolution to file names containing percent encoded URLs, #3006.
  • Linking to the project's README file with a relative link will now behave as expected, #3006.
  • Reduced unnecessary HTML element rendering in default theme. API: Reflection.hasComment and Comment.hasVisibleComponent now accepts an optional notRenderedTags parameter.

v0.28.11 (2025-08-25)

Features

  • Object properties declared with shorthand property assignment will now use the variable's comment if they do not have their own comment, #2999.

Bug Fixes

... (truncated)

Commits
  • 15f0f2a Update changelog for release
  • a79f8d5 Bump version to 0.28.14
  • 4ca04c1 Handle @this tag, improved destructured parameters
  • 1009206 Implement excludePrivateClassFields
  • a85a65b Sort null and undefined last in union types
  • 8ff7d27 Fix lint
  • fdd8369 Improve slugger for headers containing HTML
  • efd06b1 Fix conversion of auto accessor types
  • 54af135 Introduce preservedTypeAnnotationTags option
  • bd7888a Update bug_report.md
  • Additional commits viewable in compare view

Dependabot compatibility score

You can trigger a rebase of this PR by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Important

Bump typedoc from 0.28.9 to 0.28.14 with new features and bug fixes.

  • Dependency Update:
    • Bump typedoc from 0.28.9 to 0.28.14 in package.json.
  • Features:
    • Added preservedTypeAnnotationTags option and typeAnnotation on CommentTag.
    • Added excludePrivateClassFields option.
    • Support for TypeScript's @this tag in JS files.
  • Bug Fixes:
    • Fixed auto-accessor types conversion with accessor keyword.
    • Improved HTML tag handling in headers for anchor generation.
    • Enhanced destructured parameter detection and renaming.

This description was created by Ellipsis for 2612228. You can customize this summary. It will automatically update as commits are pushed.

Disclaimer: Experimental PR review

Greptile Overview

Updated On: 2025-10-13 05:19:33 UTC

Summary

This PR updates typedoc from version 0.28.9 to 0.28.14, bringing five patch releases worth of improvements. The upgrade includes:

Key improvements in 0.28.14:

  • New preservedTypeAnnotationTags option for preserving type annotations in documentation
  • New excludePrivateClassFields option to selectively hide #private members
  • Support for TypeScript's @this tag in JS files
  • Fixed auto-accessor types conversion for properties with accessor keyword
  • Improved HTML tag handling in headers for anchor generation
  • Better destructured parameter detection and renaming

Additional fixes from 0.28.10-0.28.13:

  • Fixed mixin class rendering issues
  • Improved @inheritDoc behavior
  • Better external symbol link mappings
  • Enhanced relative link resolution
  • Object property shorthand comments now inherit from variables
  • basePath option improvements with new displayBasePath option

This is a routine dev dependency update that primarily affects documentation generation. The changes include transitive dependency updates to @shikijs/* packages (3.9.2 → 3.13.1) for syntax highlighting and yaml (2.8.0 → 2.8.1). Since typedoc is only used for the docs script in package.json:11 and not in production builds, this update carries minimal risk.

Confidence Score: 5/5

  • This PR is safe to merge with minimal risk
  • This is a straightforward dev dependency bump for a documentation tool. TypeDoc is only used in the docs npm script and has no impact on production code or runtime behavior. The version jump (0.28.9 → 0.28.14) includes only bug fixes, new optional features, and improvements. The changelog shows no breaking changes or deprecations. All changes are backward-compatible enhancements that improve documentation generation quality.
  • No files require special attention

Important Files Changed

File Analysis

Filename Score Overview
package.json 5/5 Updated typedoc version from ^0.28.9 to ^0.28.14, a minor patch update with bug fixes and new features
pnpm-lock.yaml 5/5 Updated lockfile with new typedoc dependencies including @gerrit0/mini-shiki, @shikijs/* packages, and transitive dependency yaml

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Dep as Dependabot
    participant CI as CI Pipeline
    participant NPM as NPM Registry
    
    Dep->>NPM: Check for typedoc updates
    NPM-->>Dep: New version 0.28.14 available
    Dep->>Dev: Create PR #663
    Note over Dep: Update package.json<br/>Update pnpm-lock.yaml
    Dev->>CI: Trigger CI checks
    CI->>CI: Run build, test, lint
    CI->>CI: Generate docs with new typedoc
    CI-->>Dev: All checks pass
    Dev->>Dev: Review and approve
    Dev->>Dev: Merge PR
    Note over Dev: Documentation generation<br/>now uses typedoc 0.28.14
Loading

Note
Automatic rebases have been disabled on this pull request as it has been open for over 30 days.

@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update javascript code labels Oct 13, 2025
@vercel
Copy link

vercel bot commented Oct 13, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Updated (UTC)
langfuse-js Ready Ready Preview Nov 11, 2025 5:14pm

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, no comments

Edit Code Review Agent Settings | Greptile

Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.28.9 to 0.28.14.
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.28.9...v0.28.14)

---
updated-dependencies:
- dependency-name: typedoc
  dependency-version: 0.28.14
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file javascript Pull requests that update javascript code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants