chore(repo): Update Typedoc to 0.28 #5453
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
🦋 Changeset detectedLatest commit: d4058fe The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
The changes here are accounting for upstream changes in the markdown plugin and the breaking changes in Typedoc itself
| }, 'RedirectToSignUp'); | ||
|
|
||
| /** | ||
| * @function |
There was a problem hiding this comment.
Typedoc is now more strict about const foo = () => {} vs function bar() {}.
Without the @function keyword it marks the former as a variable, not a function. Since I didn't want to change the function signature everywhere (since that should be enforced with ESLint) I just added the annotations
Description
This PR updates our Typedoc version to 0.28, see its changelog: https://typedoc.org/documents/Changelog.html#v0280-2025-03-15
There were a couple of breaking changes in this version that mostly the markdown plugin had to handle, but since we override parts of its theme I had to update our code, too. So that's why there are changes in
custom-theme.mjs.The reason why I did the upgrade was that Typedoc 0.28 added a
--routeroption which now allows for a better way to modify the output.Fixes ECO-507
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change