Skip to content

build(deps-dev): bump typedoc from 0.25.13 to 0.28.19#8125

Open
dependabot[bot] wants to merge 3 commits intomasterfrom
dependabot/npm_and_yarn/typedoc-0.28.19
Open

build(deps-dev): bump typedoc from 0.25.13 to 0.28.19#8125
dependabot[bot] wants to merge 3 commits intomasterfrom
dependabot/npm_and_yarn/typedoc-0.28.19

Conversation

@dependabot
Copy link
Copy Markdown
Contributor

@dependabot dependabot bot commented on behalf of github Apr 13, 2026 •
edited
Loading

Bumps typedoc from 0.25.13 to 0.28.19.

Release notes

Sourced from typedoc's releases.

v0.28.19

Features

  • Added French translations for the TypeDoc interface and help descriptions.
  • Added support for triple-slash comment style, which requires exactly three slashes in the comment, #3089.

Bug Fixes

  • Corrected handling of icon caching for custom themes which use SVGs with a larger view box than TypeDoc's default theme.
  • Fixed short summary comment handling on module pages when the project source files use Windows line endings, #3093.

Thanks!

v0.28.18

Features

  • Support TypeScript 6.0, #3084.

v0.28.17

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

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.

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.28.19 (2026-04-12)

Features

  • Added French translations for the TypeDoc interface and help descriptions.
  • Added support for triple-slash comment style, which requires exactly three slashes in the comment, #3089.

Bug Fixes

  • Corrected handling of icon caching for custom themes which use SVGs with a larger view box than TypeDoc's default theme.
  • Fixed short summary comment handling on module pages when the project source files use Windows line endings, #3093.

Thanks!

v0.28.18 (2026-03-23)

Features

  • Support TypeScript 6.0, #3084.

v0.28.17 (2026-02-13)

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 (2026-01-12)

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.

... (truncated)

Commits
  • 0135da0 Update changelog for release
  • 68fa965 Bump version to 0.28.19
  • cb13565 Update changelog, documentation
  • acba2ae Fix Comment.getShortSummary with windows line endings
  • a108643 feat(router): move anchor creation to seperate function (#3092)
  • d743a1c Merge pull request #3091 from hyosua/feat/locales-fr
  • 70a9b41 Update CHANGELOG and format French locales
  • 4db90bc Add French translations for locales
  • c8fb88f Attempt updating actions versions
  • a58e6a9 Update deps
  • Additional commits viewable in compare view
Maintainer changes

This version was pushed to npm by [GitHub Actions](https://www.npmjs.com/~GitHub Actions), a new releaser for typedoc since your current version.

@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update javascript code labels Apr 13, 2026
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Apr 13, 2026 •
edited
Loading

⚠️ No Changeset found

Latest commit: d094858

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/typedoc-0.28.19 branch from 059ef07 to cadfa06 Compare April 13, 2026 22:52
@dependabot
build(deps-dev): bump typedoc from 0.25.13 to 0.28.19
6a1bac0 
Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.25.13 to 0.28.19.
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.25.13...v0.28.19)

---
updated-dependencies:
- dependency-name: typedoc
  dependency-version: 0.28.19
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/typedoc-0.28.19 branch from cadfa06 to 6a1bac0 Compare April 14, 2026 01:10
@ardatan
Copy link
Copy Markdown
Owner

ardatan commented Apr 14, 2026

@copilot fix failing ci

Copilot AI and others added 2 commits April 14, 2026 01:45
@ardatan
fix: upgrade typedoc-plugin-markdown to 4.x and update build-api-docs…
dede907 
… script for typedoc 0.28.x compatibility

- Upgrade typedoc-plugin-markdown from 3.17.1 to 4.11.0 (compatible with typedoc 0.28.x)
- Rename build-api-docs.ts → build-api-docs.mts to run as ESM (avoids TypeDoc dual-loading bug with tsx in CJS mode)
- Replace require() JSON calls with readFileSync + JSON.parse for ESM compatibility
- Switch from generateDocs() (HTML) to generateOutputs() (markdown) per typedoc-plugin-markdown 4.x API
- Add skipErrorChecking: true and out/hideBreadcrumbs/hidePageHeader TypeDoc options
- Update post-processing to discover generated directories dynamically instead of hardcoded list
- Update root _meta.ts generation to list actual package names from top-level dirs
- Update package.json build:api-docs script to reference .mts extension

Agent-Logs-Url: https://github.com/ardatan/graphql-tools/sessions/90652cb4-9285-4fef-bdad-44e037011570

Co-authored-by: ardatan <20847995+ardatan@users.noreply.github.com>
@ardatan
fix: improve title extraction in build-api-docs.mts for typedoc 0.28.x
d094858 
- Fix regex multiline flag: remove 'm' flag since files now start with '# heading' directly
- Handle Type Alias (capital A) prefix from typedoc-plugin-markdown 4.x
- Handle strikethrough markers (~~deprecated~~) in headings
- Fix generic type parameter stripping to handle escaped markdown \\<T\\>
- Remove backslash escapes from titles (\\_ → _)
- Use correct YAML single-quote escaping ('' instead of \\')
- Fix double semicolon typo

Agent-Logs-Url: https://github.com/ardatan/graphql-tools/sessions/90652cb4-9285-4fef-bdad-44e037011570

Co-authored-by: ardatan <20847995+ardatan@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 14, 2026

@copilot fix failing ci

Fixed in commits dede907 and d094858.

The root cause was that typedoc-plugin-markdown@3.x used a TypeDoc option (includes) that was removed in typedoc 0.28.x. To fix:

  1. Upgraded typedoc-plugin-markdown from 3.17.1 to 4.11.0 (compatible with typedoc 0.28.x)
  2. Renamed build-api-docs.ts → build-api-docs.mts so tsx runs it as ESM — when running as CJS, tsx and typedoc-plugin-markdown (ESM) each load TypeDoc as separate instances, causing the markdown renderer to fail with "The page model should be a reflection when rendering the 'reflection' page kind"
  3. Replaced require() JSON loading with readFileSync + JSON.parse for ESM compatibility
  4. Switched from generateDocs() (HTML renderer) to generateOutputs() (registers the markdown output in 4.x)
  5. Updated post-processing to work with the new per-package directory structure (utils/src/, merge/src/, etc.) instead of the old flat modules/, classes/, interfaces/, enums/ layout

Copilot AI requested a review from ardatan April 14, 2026 01:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ardatan ardatan Awaiting requested review from ardatan

Assignees

No one assigned

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ardatan