Upgrade to TypeScript v5.2 #6476

adidahiya · 2023-10-19T16:11:18Z

Fixes #4342

✅ Prerequisites:

Changes proposed in this pull request:

Upgrade from TypeScript v4.8 to v5.2
Refactor tsconfig files to extend from two possible base configs, tsconfig.web.json and tsconfig.node.json
Remove deprecated importsNotUsedAsValues config option, enable verbatimModuleSyntax instead
Upgrade to @documentalist/compiler and @documentalist/client v5.0.0 to use the latest TypeDoc library
Implement workarounds for various Documentalist regressions:

Reviewers should focus on:

TypeScript config changes
Documentation changes resulting from a major TypeDoc upgrade
Not sure if this will require Documentalist to also bump to marked v9.0, as that was missed in v5.0: [compiler] feat: upgrade to Marked v9.0 documentalist#247

Notes

See TypeScript release notes:

adidahiya

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:

packages/docs-data/compile-docs-data.mjs

adidahiya · 2023-10-24T19:03:19Z

update for latest Documentalist APIs

Build artifact links for this commit: documentation | landing | table | demo

This is an automated comment from the deploy-preview CircleCI job.

adidahiya · 2023-10-25T03:02:17Z

no need to use commonjs in tests

Build artifact links for this commit: documentation | landing | table | demo

This is an automated comment from the deploy-preview CircleCI job.

adidahiya · 2023-10-25T03:42:40Z

packages/docs-data/compile-docs-data.mjs

+        `../{${LIBRARY_AND_DOCS_PACKAGES.join(",")}}/src/**/*.md`,
+        `../{${LIBRARY_PACKAGES.join(",")}}/src/**/*.scss`,
+        `../{${LIBRARY_PACKAGES.join(",")}}/src/index.ts`,
+        `../{${LIBRARY_PACKAGES}}/package.json`,


filtering to only the relevant packages saves a lot of time (about 70 seconds, or 40% on my machine)

adidahiya · 2023-10-25T03:57:16Z

restore commonjs for test-commons

Build artifact links for this commit: documentation | landing | table | demo

This is an automated comment from the deploy-preview CircleCI job.

adidahiya · 2023-10-25T19:41:37Z

The Documentalist changes have slowed down compile-docs-data quite a bit, I think I will need to adjust the CI workflow to better parallelize work now.

Before:

Now:

adidahiya · 2023-10-25T19:52:49Z

[docs-theme] workaround multiline jsdoc bug

Build artifact links for this commit: documentation | landing | table | demo

This is an automated comment from the deploy-preview CircleCI job.

packages/docs-data/markdownRenderer.mjs

… deps

adidahiya

looks like my attempt to parallelize the CI job didn't work. docs-data needs all the libraries to be compiled so that it can create TS programs from all the output definition files. will need another approach.

adidahiya · 2023-10-26T16:32:47Z

packages/docs-data/compile-docs-data.mjs

- *
- * @param {any} value
- */
-function interpolateClassNamespace(value) {


this transformation got moved to the "marked" renderer hooks lifecycle, which I think is a better place for it.

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

adidahiya · 2023-10-26T17:26:24Z

fix transform function return value

Build artifact links for this commit: documentation | landing | table | demo

This is an automated comment from the deploy-preview CircleCI job.

adidahiya added Domain: tooling Status: blocked labels Oct 19, 2023

adidahiya mentioned this pull request Oct 20, 2023

[eslint-config] break: enforce consistent type imports/exports #6478

Merged

Upgrade to TypeScript v5.2

6a4fd65

adidahiya force-pushed the ad/upgrade-typescript branch from 26cbb09 to 6a4fd65 Compare October 20, 2023 01:01

adidahiya mentioned this pull request Oct 20, 2023

break: upgrade to typescript 5.2, typedoc 0.25 palantir/documentalist#156

Merged

1 task

adidahiya added 2 commits October 24, 2023 14:25

Merge remote-tracking branch 'origin/develop' into ad/upgrade-typescript

fdaace7

Upgrade Documentalist to v5.0.0

ffb0144

adidahiya removed the Status: blocked label Oct 24, 2023

update for latest Documentalist APIs

4c2b9df

adidahiya commented Oct 24, 2023

View reviewed changes

packages/docs-data/compile-docs-data.mjs Outdated Show resolved Hide resolved

no need to use commonjs in tests

34b0dcc

adidahiya added 2 commits October 24, 2023 23:10

only run documentalist on pacakges we care about

58d6e06

restore commonjs for test-commons

a6d197a

adidahiya commented Oct 25, 2023

View reviewed changes

adidahiya marked this pull request as ready for review October 25, 2023 14:15

adidahiya self-assigned this Oct 25, 2023

adidahiya added 4 commits October 25, 2023 13:23

[docs-theme] adjust HeadingTag impl, fix #4342

67d9133

[docs-theme] code style fixes, lint warnings

f099740

[docs-theme] workaround default value markup bug

ce5109f

[docs-theme] workaround empty type params list bug

f2f9da0

adidahiya mentioned this pull request Oct 25, 2023

[compiler] feat: upgrade to Marked v9.0 palantir/documentalist#247

Merged

adidahiya added 2 commits October 25, 2023 15:10

upgrade marked, remove @types/marked

73b164d

[docs-theme] workaround multiline jsdoc bug

a7dd91f

adidahiya commented Oct 25, 2023

View reviewed changes

packages/docs-data/markdownRenderer.mjs Outdated Show resolved Hide resolved

adidahiya added 2 commits October 26, 2023 12:14

don't match triple backtick code block fences

beb52b4

move class namespace interpolation to hooks; remove core & docs-theme…

27434c0

… deps

adidahiya commented Oct 26, 2023

View reviewed changes

adidahiya added 2 commits October 26, 2023 12:39

restore deps on core & docs-theme

ffd2ebd

fix transform function return value

d2a0bdd

adidahiya merged commit 3f0ba78 into develop Oct 26, 2023
12 checks passed

adidahiya deleted the ad/upgrade-typescript branch October 26, 2023 17:31

adidahiya mentioned this pull request Nov 6, 2023

docs: CSS API examples are broken #6517

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade to TypeScript v5.2 #6476

Upgrade to TypeScript v5.2 #6476

adidahiya commented Oct 19, 2023 •

edited

Loading

adidahiya left a comment •

edited

Loading

adidahiya commented Oct 24, 2023

adidahiya commented Oct 25, 2023

adidahiya Oct 25, 2023

adidahiya commented Oct 25, 2023

adidahiya commented Oct 25, 2023

adidahiya commented Oct 25, 2023

adidahiya left a comment

adidahiya Oct 26, 2023

adidahiya Nov 8, 2023

adidahiya commented Oct 26, 2023

Upgrade to TypeScript v5.2 #6476

Upgrade to TypeScript v5.2 #6476

Conversation

adidahiya commented Oct 19, 2023 • edited Loading

Changes proposed in this pull request:

Reviewers should focus on:

Notes

adidahiya left a comment • edited Loading

Choose a reason for hiding this comment

🎉 interface extends clauses with type aliases and mapped types are mostly fixed

⚠️ @default values have extra markup which needs to be parsed out

⚠️ some jsdoc comments have poor markdown rendering

adidahiya commented Oct 24, 2023

update for latest Documentalist APIs

adidahiya commented Oct 25, 2023

no need to use commonjs in tests

adidahiya Oct 25, 2023

Choose a reason for hiding this comment

adidahiya commented Oct 25, 2023

restore commonjs for test-commons

adidahiya commented Oct 25, 2023

adidahiya commented Oct 25, 2023

[docs-theme] workaround multiline jsdoc bug

adidahiya left a comment

Choose a reason for hiding this comment

adidahiya Oct 26, 2023

Choose a reason for hiding this comment

adidahiya Nov 8, 2023

Choose a reason for hiding this comment

adidahiya commented Oct 26, 2023

fix transform function return value

adidahiya commented Oct 19, 2023 •

edited

Loading

adidahiya left a comment •

edited

Loading

🎉 interface `extends` clauses with type aliases and mapped types are mostly fixed

⚠️ `@default` values have extra markup which needs to be parsed out