feat(plugin-typedoc): Upgrade to TypeDoc v0.28 with new API#2790
feat(plugin-typedoc): Upgrade to TypeDoc v0.28 with new API#2790SoonIter merged 2 commits intoweb-infra-dev:mainfrom
Conversation
✅ Deploy Preview for rspress-v2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This PR upgrades the TypeDoc plugin to use TypeDoc v0.28.14 and typedoc-plugin-markdown v4.9.0, migrating from the previous v0.24.8 and v3.17.1 versions respectively. The upgrade necessitates API changes to align with TypeDoc's new architecture, while maintaining similar output rendering.
- Updated TypeDoc and typedoc-plugin-markdown to their latest major versions
- Migrated to new TypeDoc v0.28 API including
Application.bootstrapWithPlugins()andapp.outputs.writeOutput() - Adjusted configuration options to match new defaults and maintain output consistency
Reviewed Changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| pnpm-lock.yaml | Updated dependency versions and added new transitive dependencies required by TypeDoc v0.28 |
| packages/plugin-typedoc/package.json | Bumped typedoc to 0.28.14 and typedoc-plugin-markdown to 4.9.0 |
| packages/plugin-typedoc/src/index.ts | Migrated to new TypeDoc v0.28 API with bootstrapWithPlugins and outputs.writeOutput methods, added new configuration options |
| packages/plugin-typedoc/src/patch.ts | Removed README.md to index.md rename (now handled by entryFileName config) |
| packages/plugin-typedoc/src/utils.ts | Removed unused transformModuleName function |
| e2e/fixtures/plugin-typedoc/index.test.ts | Updated test expectations to match new TypeDoc output format (function names now include parentheses, module naming changed from underscores to hyphens) |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
I don’t have a Windows machine, so I can’t figure out why it’s failing on Windows in the end-to-end tests 😢 |
I currently do not have a Windows machine too. I will do some troubleshooting when I have a Windows machine today or tomorrow. |
b030158 to
1664461
Compare
|
@SoonIter It turned out that the issue was introduced by the following commit, where TypeDoc stopped supporting Windows-style path separators: Based on the discussion in this comment, I updated how we pass the entryPoint to TypeDoc: |
85447a5 to
1a77243
Compare
|
Thanks a ton for your contribution! This Maybe we can manually pre-process the paths so that the previous usage on docs remains valid. I'll make some changes once this PR is merged. |
Summary
I updated the versions of TypeDoc and typedoc-plugin-markdown.
There were several changes to the default settings, but I’ve made adjustments so that the output is rendered as similarly as possible to the previous version.
Related Issue
close #2479
Checklist