break: upgrade to typescript 5.2, typedoc 0.25 #156

adidahiya · 2022-10-05T14:21:46Z

This change will enable us to upgrade Blueprint to TypeScript v5.2 in palantir/blueprint#6476

✅ Prerequisites:

Upgrade to Node v18, fix deploy-preview CI job #236

Changes proposed:

Upgrade to TypeScript v5.2
Upgrade to typedoc v0.25
Migrate to latest typedoc APIs (see changelog)
Upgrade Jest & ts-jest to v29
Update snapshots for changes related to Jest syntax breaks (the redundant Object, Array prefixes on literals are no longer there)
Update snapshots for typedoc changes
~~Add typedoc-plugin-missing-exports plugin to bring back some functionality that existed before typedoc v0.20~~ edit: I will consider doing this in a separate PR
Update the TypeScript plugin to handle documentation of files from different TypeScript projects, something that came "for free" before TypeDoc rehauled its file/program resolution system in v0.20.
- This is accomplished by attempting to resolve each input file with its closest tsconfig.json project config using tsconfig-resolver

References

adidahiya · 2023-10-19T17:16:02Z

tslint.json

+    "no-invalid-this": false,
+    "no-shadowed-variable": false,


these lint rules are not compatible with TypeScript v5.x since they use deprecated APIs 🤷🏽 I'll migrate to eslint in a separate PR

scripts/submit-comment-with-artifact-links.mjs

scripts/submit-preview-comment.sh

.circleci/config.yml

adidahiya · 2023-10-19T17:31:03Z

packages/compiler/src/__tests__/__snapshots__/typescript.test.ts.snap

    "sourceUrl": "https://github.com/palantir/documentalist/blob/develop/packages/compiler/src/__tests__/__fixtures__/classes.ts#L53",
  },
-  "Food": Object {


non-exported symbols are no longer documented. I think that's OK.

Note that this was actually sort of a regression in #144, so removing Food here is a good thing.

also, we can get this back if we add https://www.npmjs.com/package/typedoc-plugin-missing-exports. so we will have options after this upgrade.

packages/compiler/src/__tests__/__snapshots__/typescript.test.ts.snap

adidahiya · 2023-10-19T17:33:16Z

packages/compiler/src/__tests__/__snapshots__/typescript.test.ts.snap

-        "documentation": Object {
-          "contents": Array [
-            "<p>Exported function.</p>
+    "name": "MyFunc",


these functions are still documented correctly, but their order got moved around in the snapshot

packages/compiler/src/__tests__/__snapshots__/typescript.test.ts.snap

adidahiya · 2023-10-19T17:34:07Z

packages/compiler/src/__tests__/__snapshots__/typescript.test.ts.snap

-        "metadata": Object {},
-      },
+    "indexSignature": {
+      "documentation": undefined,


this index signature jsdoc got dropped - not sure why 🤔

I believe this is a bug in typedoc, filed this issue: TypeStrong/typedoc#2414

But I don't think we need to block on this; this is an uncommonly used feature.

packages/compiler/src/__tests__/__snapshots__/typescript.test.ts.snap

packages/compiler/src/plugins/typescript/visitor.ts

adidahiya · 2023-10-20T15:12:26Z

Build preview link for commit "Merge remote-tracking branch 'origin/develop' into ad/upgrade-typescript": documentation

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

adidahiya · 2023-10-20T18:16:06Z

Build preview link for commit "fix lint": documentation

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

adidahiya · 2023-10-20T18:20:07Z

Build preview link for commit "remove missing exports plugin": documentation

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

adidahiya · 2023-10-20T18:21:09Z

packages/compiler/cli.js

@@ -46,6 +47,10 @@ const argv = yargs
        desc: "use KssPlugin for .(css|less|scss) files",
        type: "boolean",
    })
+    .option("out", {


adding this option allows us to log things to the console and still use the CLI to output a JSON file (previously, we were just using stdout in the docs package of this repo)

adidahiya · 2023-10-20T18:22:29Z

Build preview link for commit "fix lint again": documentation

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

packages/compiler/src/typedoc-plugin-missing-exports.d.ts

adidahiya · 2023-10-20T18:38:15Z

Build preview link for commit "Handle @deprecated tag better": documentation

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

adidahiya · 2023-10-20T19:22:18Z

Build preview link for commit "Fix interface property signatures": documentation

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

adidahiya · 2023-10-20T19:25:08Z

Build preview link for commit "fix lint": documentation

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

adidahiya · 2023-10-20T19:30:36Z

Build preview link for commit "update more snapshots": documentation

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

adidahiya · 2023-10-20T19:35:20Z

Build preview link for commit "remove extraneous type definitions": documentation

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

packages/compiler/package.json

packages/compiler/src/plugins/typescript/visitor.ts

adidahiya · 2023-10-23T20:42:47Z

Build preview link for commit "address minor review comments": documentation

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

adidahiya · 2023-10-23T20:46:39Z

Build preview link for commit "don't capitalize TypeScript in public API": documentation

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

WIP break: upgrade TypeScript and typedoc

289f0fd

adidahiya mentioned this pull request Apr 28, 2023

Old dependencies in last 1.6 release #220

Closed

adidahiya mentioned this pull request Oct 19, 2023

Upgrade to TypeScript v5.2 palantir/blueprint#6476

Merged

2 tasks

adidahiya added 6 commits October 19, 2023 12:20

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

34a46a6

bump to typedoc v0.25

633b029

Upgrade to TypeScript v5.2, typedoc v0.25

f9e79b4

snapshot changes for jest upgrade

9c5520b

update snapshots for typedoc upgrade

0082c03

update --project path

54ea82d

adidahiya changed the title ~~WIP break: upgrade TypeScript and typedoc~~ break: upgrade to typescript 5.2, typedoc 0.25 Oct 19, 2023

adidahiya added 2 commits October 19, 2023 13:03

fix lint

c19246e

Upgrade to Node v18

a8c6b0a

adidahiya changed the title ~~break: upgrade to typescript 5.2, typedoc 0.25~~ break: upgrade to typescript 5.2, typedoc 0.25, Node 18 Oct 19, 2023

adidahiya added 2 commits October 19, 2023 13:10

update snapshot for node upgrade

4f87f0f

Update deploy-preview script

8d83c5a

adidahiya commented Oct 19, 2023

View reviewed changes

make script executable

971c77e

This comment was marked as outdated.

Sign in to view

adidahiya marked this pull request as ready for review October 19, 2023 17:28

adidahiya commented Oct 19, 2023

View reviewed changes

adidahiya mentioned this pull request Oct 20, 2023

Upgrade to Node v18, fix deploy-preview CI job #236

Merged

adidahiya changed the title ~~break: upgrade to typescript 5.2, typedoc 0.25, Node 18~~ break: upgrade to typescript 5.2, typedoc 0.25 Oct 20, 2023

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

e625aa6

This was referenced Oct 20, 2023

chore: Bump ts-jest from 27.1.4 to 29.1.1 #226

Closed

chore: Bump jest and @types/jest #203

Closed

adidahiya added 4 commits October 20, 2023 11:17

remove commented code

0f3c99b

revert whitespace changes

50edfb0

adjust some typedoc options

4ced1c5

fix enum member defaults

50d5a7f

adidahiya added 2 commits October 20, 2023 14:17

remove missing exports plugin

e0cecc3

fix lint again

93ac80f

adidahiya commented Oct 20, 2023

View reviewed changes

packages/compiler/src/typedoc-plugin-missing-exports.d.ts Outdated Show resolved Hide resolved

Handle @deprecated tag better

4ec2747

Fix interface property signatures

ac76fb1

fix lint

119fc09

adidahiya mentioned this pull request Oct 20, 2023

Missing comments on interface index signatures TypeStrong/typedoc#2414

Closed

update more snapshots

1ac43d7

remove extraneous type definitions

53f106a

styu approved these changes Oct 23, 2023

View reviewed changes

packages/compiler/package.json Outdated Show resolved Hide resolved

packages/compiler/src/plugins/typescript/visitor.ts Outdated Show resolved Hide resolved

adidahiya added 3 commits October 23, 2023 16:35

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

9d106bc

dedupe lockfile

1bd1caf

address minor review comments

4078481

don't capitalize TypeScript in public API

30bfb7d

adidahiya merged commit 7b07c20 into develop Oct 23, 2023
7 checks passed

adidahiya deleted the ad/upgrade-typescript branch October 23, 2023 20:50

This was referenced Oct 25, 2023

Interface property default values include extra markup #245

Open

Some types include unnecessary empty type params list #246

Open

Regression in JSDoc markdown parsing #248

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

break: upgrade to typescript 5.2, typedoc 0.25 #156

break: upgrade to typescript 5.2, typedoc 0.25 #156

adidahiya commented Oct 5, 2022 •

edited

adidahiya Oct 19, 2023

This comment was marked as outdated.

adidahiya Oct 19, 2023

adidahiya Oct 20, 2023

adidahiya Oct 20, 2023

adidahiya Oct 19, 2023

adidahiya Oct 19, 2023

adidahiya Oct 20, 2023 •

edited

adidahiya commented Oct 20, 2023

adidahiya commented Oct 20, 2023

adidahiya commented Oct 20, 2023

adidahiya Oct 20, 2023

adidahiya commented Oct 20, 2023

adidahiya commented Oct 20, 2023

adidahiya commented Oct 20, 2023

adidahiya commented Oct 20, 2023

adidahiya commented Oct 20, 2023

adidahiya commented Oct 20, 2023

adidahiya commented Oct 23, 2023

adidahiya commented Oct 23, 2023

break: upgrade to typescript 5.2, typedoc 0.25 #156

break: upgrade to typescript 5.2, typedoc 0.25 #156

Conversation

adidahiya commented Oct 5, 2022 • edited

adidahiya Oct 19, 2023

Choose a reason for hiding this comment

This comment was marked as outdated.

adidahiya Oct 19, 2023

Choose a reason for hiding this comment

adidahiya Oct 20, 2023

Choose a reason for hiding this comment

adidahiya Oct 20, 2023

Choose a reason for hiding this comment

adidahiya Oct 19, 2023

Choose a reason for hiding this comment

adidahiya Oct 19, 2023

Choose a reason for hiding this comment

adidahiya Oct 20, 2023 • edited

Choose a reason for hiding this comment

adidahiya commented Oct 20, 2023

adidahiya commented Oct 20, 2023

adidahiya commented Oct 20, 2023

adidahiya Oct 20, 2023

Choose a reason for hiding this comment

adidahiya commented Oct 20, 2023

adidahiya commented Oct 20, 2023

adidahiya commented Oct 20, 2023

adidahiya commented Oct 20, 2023

adidahiya commented Oct 20, 2023

adidahiya commented Oct 20, 2023

adidahiya commented Oct 23, 2023

adidahiya commented Oct 23, 2023

adidahiya commented Oct 5, 2022 •

edited

adidahiya Oct 20, 2023 •

edited