Upgrade to TypeScript v5.2 #6476
Conversation
adidahiya
force-pushed
the
ad/upgrade-typescript
branch
from
26cbb09
to
6a4fd65
Compare
There was a problem hiding this comment.
There are some documentation changes as a result of this major TypeDoc upgrade. Some are long-awaited fixes 🎉 while others are issues that need addressing
🎉 interface extends clauses with type aliases and mapped types are mostly fixed
Before:
After:
⚠️ @default values have extra markup which needs to be parsed out
Before:
After:
⚠️ some jsdoc comments have poor markdown rendering
Before:
After:
update for latest Documentalist APIsBuild artifact links for this commit: documentation | landing | table | demoThis is an automated comment from the deploy-preview CircleCI job. |
no need to use commonjs in testsBuild artifact links for this commit: documentation | landing | table | demoThis is an automated comment from the deploy-preview CircleCI job. |
| `../{${LIBRARY_AND_DOCS_PACKAGES.join(",")}}/src/**/*.md`, | ||
| `../{${LIBRARY_PACKAGES.join(",")}}/src/**/*.scss`, | ||
| `../{${LIBRARY_PACKAGES.join(",")}}/src/index.ts`, | ||
| `../{${LIBRARY_PACKAGES}}/package.json`, |
There was a problem hiding this comment.
filtering to only the relevant packages saves a lot of time (about 70 seconds, or 40% on my machine)
restore commonjs for test-commonsBuild artifact links for this commit: documentation | landing | table | demoThis is an automated comment from the deploy-preview CircleCI job. |
|
The Documentalist changes have slowed down Before: 
Now: 
|
[docs-theme] workaround multiline jsdoc bugBuild artifact links for this commit: documentation | landing | table | demoThis is an automated comment from the deploy-preview CircleCI job. |
| * | ||
| * @param {any} value | ||
| */ | ||
| function interpolateClassNamespace(value) { |
There was a problem hiding this comment.
this transformation got moved to the "marked" renderer hooks lifecycle, which I think is a better place for it.
There was a problem hiding this comment.
actually, this turned out to cause a regression in rendering the CSS API examples because we need to transform the kss data in addition to the markdown data. will fix
fix transform function return valueBuild artifact links for this commit: documentation | landing | table | demoThis is an automated comment from the deploy-preview CircleCI job. |
Fixes #4342
✅ Prerequisites:
Changes proposed in this pull request:
tsconfig.web.jsonandtsconfig.node.jsonimportsNotUsedAsValuesconfig option, enableverbatimModuleSyntaxinstead@documentalist/compilerand@documentalist/clientv5.0.0 to use the latest TypeDoc libraryReviewers should focus on:
Notes
See TypeScript release notes: