Skip to content

chore(deps): update dependency typedoc to v0.28.17#277

Open
renovate[bot] wants to merge 1 commit intomainfrom
renovate/typedoc-0.x-lockfile
Open

chore(deps): update dependency typedoc to v0.28.17#277
renovate[bot] wants to merge 1 commit intomainfrom
renovate/typedoc-0.x-lockfile

Conversation

@renovate
Copy link
Contributor

@renovate renovate bot commented Nov 29, 2025

This PR contains the following updates:

Package Change Age Confidence
typedoc (source) 0.28.140.28.17 age confidence

Release Notes

TypeStrong/TypeDoc (typedoc)

v0.28.17

Compare Source

Bug Fixes
  • Improved handling of comments for type aliases which have been declaration merged with functions, #​3064.
  • Fixed anchor link generation to members named $, #​3065.
  • Corrected typing of the plugin option to permit functions, #​3066.
  • Warnings about unused @param tags will now be properly suppressed when they come from declaration files and
    the suppressCommentWarningsInDeclarationFiles option is enabled, #​3070.
  • Fixed conversion of types referencing type parameters on functions, #​3071.
Thanks!

v0.28.16

Compare Source

Bug Fixes
  • Fixed an issue causing TypeDoc to fail to generate documentation when implementing interfaces, #​3052.
  • Fixed an issue preventing automatic entry point discovery on Windows, #​3057.
  • Improved vertical positioning of text icons, #​3056.
  • TypeDoc no longer includes source location information for type literal reflections. This could sometimes
    cause TypeDoc to infer the wrong path when resolving base paths for display.
  • Adjusted markdown rendering to allow markdownItLoader to override more rendering #​3055.
Features
  • Added support for regions for @include in .tsx, .cjs, and .mjs file references #​3048.
  • Comments for TS-in-JS @typedef tags may now specify modifier tags with the inline tag syntax {@​mod}.
    This makes it possible to add modifier tags to these members, which previously was not possible as
    TypeScript's parsing stops for these members at the next non-braced tag, #​2916 and #​3050.
  • A typedoc-config.schema.json is now included in the root of the package with a JSON schema for TypeDoc's
    configuration file. The schema for the latest version is also published at https://typedoc.org/schema.json
    and will automatically be picked up when writing typedoc.json files if you are using VSCode, #​3054.
Thanks!

v0.28.15

Compare Source

Features
  • The gitRevision option now accepts the special value {branch}, which indicates source links should use
    the current git branch for links, #​3041.
  • Introduced validation.invalidPath for suppressing warnings caused by referencing relative paths which
    do not exist when building the documentation, #​3033.
  • API: Introduced Logger.validationWarning for validation which occurs during conversion rather than
    during TypeDoc's normal validation step, #​3033.

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.


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

This PR was generated by Mend Renovate. View the repository job log.

@claude
Copy link
Contributor

claude bot commented Nov 29, 2025

PR Review: TypeDoc v0.28.15 Dependency Update

Summary

This is an automated dependency update from Renovate Bot upgrading typedoc from 0.28.14 to 0.28.15. The change is lockfile-only with no breaking changes.


✅ Code Quality & Best Practices

Strengths:

  • Clean lockfile update with proper dependency resolution
  • All transitive dependencies properly updated (@gerrit0/mini-shiki and @shikijs/* packages)
  • Version constraints maintained correctly (caret ranges preserved)
  • No changes to package.json (appropriate for patch version update)

Observations:

  • The update pulls in nested dependencies for @shikijs packages (v3.15.0 → v3.17.0)
  • Dependency tree is properly resolved with no conflicts

✅ Potential Bugs or Issues

No issues identified:

  • This is a patch version update (0.28.14 → 0.28.15) following semantic versioning
  • TypeDoc changelog shows only new features, no bug fixes that indicate prior issues
  • All CI checks passing (Lint, Test, Build, Security Audit)
  • No breaking changes or deprecations

✅ Performance Considerations

Positive impact:

  • Shiki upgrade (3.15.0 → 3.17.0) may include performance improvements
  • Package size change appears minimal (only +42 net lines in lockfile)
  • No runtime performance concerns for a documentation generation tool

✅ Security Concerns

No security issues:

  • Security Audit check: PASSED
  • No known vulnerabilities in TypeDoc 0.28.15
  • All transitive dependencies from trusted sources (@shikijs, @Gerrit0)
  • Renovate provides confidence score (shown in PR description)

✅ Test Coverage

Comprehensive validation:

  • ✓ Lint Code: SUCCESS
  • ✓ Test: SUCCESS
  • ✓ Build: SUCCESS
  • ✓ Security Audit: SUCCESS
  • ⏳ Integration Tests: In progress (ubuntu, windows, macos)

Note: Integration tests appear to be running. Recommend waiting for all checks to complete before merge.


📋 New Features in TypeDoc v0.28.15

From the changelog:

  1. gitRevision option enhancement: Now accepts {branch} for dynamic source links
  2. validation.invalidPath option: Suppress warnings for non-existent relative paths
  3. API addition: Logger.validationWarning for conversion-time validation

These are purely additive features with no breaking changes.


🎯 Recommendation

✅ APPROVE - Safe to merge once integration tests complete.

Rationale:

  • Patch version update with no breaking changes
  • All critical CI checks passing
  • No security vulnerabilities
  • Additive features only (opt-in)
  • Proper dependency resolution
  • Follows project's automated dependency update workflow

Suggested action:

# Wait for integration tests to complete, then:
gh pr merge 277 --auto --squash

📝 Adherence to CLAUDE.md Guidelines

  • ✅ No code changes, so code style N/A
  • ✅ Security model: No shell execution, pure dependency update
  • ✅ Test quality: Existing tests validate compatibility
  • ✅ Documentation: No updates needed for patch dependency bump
  • ✅ Community guidelines: Automated PR follows Conventional Commits (chore prefix)

Review completed by Claude Code
Generated: 2025-11-29

@Gerrit0
Copy link

Gerrit0 commented Nov 29, 2025

WTF. Who decided it was a good idea to tag maintainers in AI generated notes... what an utter waste of people's time.

@renovate renovate bot force-pushed the renovate/typedoc-0.x-lockfile branch from 3a9da11 to 63fe712 Compare December 3, 2025 19:58
@renovate renovate bot force-pushed the renovate/typedoc-0.x-lockfile branch from 63fe712 to 01b2398 Compare December 31, 2025 17:09
@renovate renovate bot force-pushed the renovate/typedoc-0.x-lockfile branch from 01b2398 to 5a6c62c Compare January 8, 2026 20:14
@renovate renovate bot changed the title chore(deps): update dependency typedoc to v0.28.15 chore(deps): update dependency typedoc to v0.28.16 Jan 12, 2026
@renovate renovate bot force-pushed the renovate/typedoc-0.x-lockfile branch from 5a6c62c to 1b9793e Compare January 12, 2026 01:31
@renovate renovate bot force-pushed the renovate/typedoc-0.x-lockfile branch from 1b9793e to c438779 Compare February 2, 2026 19:37
@renovate renovate bot force-pushed the renovate/typedoc-0.x-lockfile branch from c438779 to f33b718 Compare February 12, 2026 18:36
@renovate renovate bot force-pushed the renovate/typedoc-0.x-lockfile branch from f33b718 to a47d7ea Compare February 13, 2026 18:37
@renovate renovate bot changed the title chore(deps): update dependency typedoc to v0.28.16 chore(deps): update dependency typedoc to v0.28.17 Feb 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant