[all] Add explicit "types" to tsconfig #4025

augustjk · 2023-07-18T00:03:05Z

The problem with a monorepo using npm workspaces is that all shared node_modules are hoisted to the monorepo root, including any @types/ packages. Some of these types packages can have global declarations that conflict with another package's, or get included in compiled output unnecessarily.

In the PR linked above, I found that @types/react adds TrustedHTML interface to the global which was conflicting with @types/trusted-types and also ends up adding itself as a reference to the .d.ts file where TrustedHTML is used, for example, lit-html.d.ts.

Setting https://www.typescriptlang.org/tsconfig#types makes it explicit which global types are used and included. This does not affect types of any packages that are imported, only those added implicitly by their global usage.

changeset-bot · 2023-07-18T00:03:08Z

🦋 Changeset detected

Latest commit: 2d57aa6

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When 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

github-actions · 2023-07-18T00:03:32Z

📊 Tachometer Benchmark Results

Summary

nop-update

lit-html-kitchen-sink: unsure 🔍 -2% - +21% (-0.30ms - +4.29ms)
^{this-change vs tip-of-tree}

render

lit-element-list: 67.81ms - 71.00ms
lit-html-kitchen-sink: unsure 🔍 -8% - +6% (-2.40ms - +1.67ms)
^{this-change vs tip-of-tree}
lit-html-repeat: unsure 🔍 -3% - +2% (-0.31ms - +0.25ms)
^{this-change vs tip-of-tree}
lit-html-template-heavy: unsure 🔍 -2% - +4% (-0.84ms - +2.10ms)
^{this-change vs tip-of-tree}
reactive-element-list: unsure 🔍 -2% - +1% (-0.89ms - +0.49ms)
^{this-change vs tip-of-tree}

update

lit-element-list: 694.54ms - 711.07ms
lit-html-kitchen-sink: unsure 🔍 -4% - +6% (-3.37ms - +4.35ms)
^{this-change vs tip-of-tree}
lit-html-repeat: unsure 🔍 -6% - +3% (-14.72ms - +6.78ms)
^{this-change vs tip-of-tree}
lit-html-template-heavy: unsure 🔍 -1% - +3% (-0.82ms - +3.37ms)
^{this-change vs tip-of-tree}
reactive-element-list: unsure 🔍 -1% - +1% (-6.83ms - +9.20ms)
^{this-change vs tip-of-tree}

update-reflect

lit-element-list: 665.51ms - 677.07ms
reactive-element-list: unsure 🔍 -1% - +1% (-5.28ms - +9.51ms)
^{this-change vs tip-of-tree}

Results

lit-element-list

Browser: chrome-headless 114.0.5735.198
Sample size: 50
Built by: Benchmarks #5047
Commit: 648738a

render

Version	Avg time	vs
	67.81ms - 71.00ms	-

update

Version	Avg time	vs
	694.54ms - 711.07ms	-

update-reflect

Version	Avg time	vs
	665.51ms - 677.07ms	-

lit-html-kitchen-sink

Browser: chrome-headless 114.0.5735.198
Sample size: 30
Built by: Benchmarks #5047
Commit: 648738a

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	27.84ms - 30.90ms	-	unsure 🔍 -8% - +6% -2.40ms - +1.67ms	unsure 🔍 -13% - +2% -4.17ms - +0.66ms
tip-of-tree tip-of-tree	28.39ms - 31.08ms	unsure 🔍 -6% - +8% -1.67ms - +2.40ms	-	unsure 🔍 -12% - +3% -3.69ms - +0.91ms
previous-release previous-release	29.26ms - 32.99ms	unsure 🔍 -2% - +14% -0.66ms - +4.17ms	unsure 🔍 -3% - +13% -0.91ms - +3.69ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	73.99ms - 78.81ms	-	unsure 🔍 -4% - +6% -3.37ms - +4.35ms	unsure 🔍 -6% - +3% -4.84ms - +2.32ms
tip-of-tree tip-of-tree	72.89ms - 78.93ms	unsure 🔍 -6% - +4% -4.35ms - +3.37ms	-	unsure 🔍 -7% - +3% -5.76ms - +2.26ms
previous-release previous-release	75.01ms - 80.31ms	unsure 🔍 -3% - +6% -2.32ms - +4.84ms	unsure 🔍 -3% - +8% -2.26ms - +5.76ms	-

nop-update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	20.74ms - 24.56ms	-	unsure 🔍 -2% - +21% -0.30ms - +4.29ms	unsure 🔍 -15% - +6% -3.51ms - +1.54ms
tip-of-tree tip-of-tree	19.37ms - 21.93ms	unsure 🔍 -18% - +1% -4.29ms - +0.30ms	-	faster ✔ 4% - 21% 0.89ms - 5.07ms
previous-release previous-release	21.98ms - 25.29ms	unsure 🔍 -7% - +16% -1.54ms - +3.51ms	slower ❌ 4% - 25% 0.89ms - 5.07ms	-

lit-html-repeat

Browser: chrome-headless 114.0.5735.198
Sample size: 30
Built by: Benchmarks #5047
Commit: 648738a

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	9.77ms - 10.19ms	-	unsure 🔍 -3% - +2% -0.31ms - +0.25ms	unsure 🔍 -1% - +5% -0.13ms - +0.48ms
tip-of-tree tip-of-tree	9.83ms - 10.20ms	unsure 🔍 -3% - +3% -0.25ms - +0.31ms	-	unsure 🔍 -1% - +5% -0.08ms - +0.49ms
previous-release previous-release	9.59ms - 10.03ms	unsure 🔍 -5% - +1% -0.48ms - +0.13ms	unsure 🔍 -5% - +1% -0.49ms - +0.08ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	249.88ms - 263.60ms	-	unsure 🔍 -6% - +3% -14.72ms - +6.78ms	unsure 🔍 -5% - +2% -14.29ms - +4.12ms
tip-of-tree tip-of-tree	252.43ms - 268.98ms	unsure 🔍 -3% - +6% -6.78ms - +14.72ms	-	unsure 🔍 -4% - +4% -11.42ms - +9.18ms
previous-release previous-release	255.69ms - 267.96ms	unsure 🔍 -2% - +6% -4.12ms - +14.29ms	unsure 🔍 -4% - +4% -9.18ms - +11.42ms	-

lit-html-template-heavy

Browser: chrome-headless 114.0.5735.198
Sample size: 50
Built by: Benchmarks #5047
Commit: 648738a

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	48.64ms - 51.09ms	-	unsure 🔍 -2% - +4% -0.84ms - +2.10ms	unsure 🔍 -1% - +5% -0.30ms - +2.63ms
tip-of-tree tip-of-tree	48.43ms - 50.05ms	unsure 🔍 -4% - +2% -2.10ms - +0.84ms	-	unsure 🔍 -1% - +3% -0.60ms - +1.68ms
previous-release previous-release	47.89ms - 49.50ms	unsure 🔍 -5% - +1% -2.63ms - +0.30ms	unsure 🔍 -3% - +1% -1.68ms - +0.60ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	105.72ms - 108.48ms	-	unsure 🔍 -1% - +3% -0.82ms - +3.37ms	unsure 🔍 -1% - +2% -1.34ms - +2.37ms
tip-of-tree tip-of-tree	104.25ms - 107.40ms	unsure 🔍 -3% - +1% -3.37ms - +0.82ms	-	unsure 🔍 -3% - +1% -2.76ms - +1.25ms
previous-release previous-release	105.34ms - 107.82ms	unsure 🔍 -2% - +1% -2.37ms - +1.34ms	unsure 🔍 -1% - +3% -1.25ms - +2.76ms	-

reactive-element-list

Browser: chrome-headless 114.0.5735.198
Sample size: 50
Built by: Benchmarks #5047
Commit: 648738a

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	43.50ms - 44.32ms	-	unsure 🔍 -2% - +1% -0.89ms - +0.49ms	unsure 🔍 -2% - +1% -1.07ms - +0.26ms
tip-of-tree tip-of-tree	43.56ms - 44.66ms	unsure 🔍 -1% - +2% -0.49ms - +0.89ms	-	unsure 🔍 -2% - +1% -0.97ms - +0.56ms
previous-release previous-release	43.79ms - 44.84ms	unsure 🔍 -1% - +2% -0.26ms - +1.07ms	unsure 🔍 -1% - +2% -0.56ms - +0.97ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	686.58ms - 697.67ms	-	unsure 🔍 -1% - +1% -6.83ms - +9.20ms	unsure 🔍 -1% - +1% -9.41ms - +6.59ms
tip-of-tree tip-of-tree	685.16ms - 696.72ms	unsure 🔍 -1% - +1% -9.20ms - +6.83ms	-	unsure 🔍 -2% - +1% -10.76ms - +5.57ms
previous-release previous-release	687.77ms - 699.30ms	unsure 🔍 -1% - +1% -6.59ms - +9.41ms	unsure 🔍 -1% - +2% -5.57ms - +10.76ms	-

update-reflect

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	684.37ms - 694.58ms	-	unsure 🔍 -1% - +1% -5.28ms - +9.51ms	unsure 🔍 -0% - +2% -2.34ms - +12.86ms
tip-of-tree tip-of-tree	682.01ms - 692.72ms	unsure 🔍 -1% - +1% -9.51ms - +5.28ms	-	unsure 🔍 -1% - +2% -4.63ms - +10.91ms
previous-release previous-release	678.59ms - 689.85ms	unsure 🔍 -2% - +0% -12.86ms - +2.34ms	unsure 🔍 -2% - +1% -10.91ms - +4.63ms	-

_{tachometer-reporter-action v2 for Benchmarks}

AndrewJakubowicz

Awesome! Just a question on the usage of skipLibCheck. Thank you!

packages/labs/gen-wrapper-react/test-output/tsconfig.json

AndrewJakubowicz · 2023-07-18T00:26:02Z

packages/lit-starter-ts/tsconfig.json

      }
-    ]
+    ],
+    "types": ["mocha"]


Are explicit types required on starter packages?

It might not be needed when it's cloned to its own template repo but it's needed for the build and test to run within the monorepo.

packages/localize-tools/testdata/build-runtime-xlb/input/tsconfig.json

packages/localize-tools/testdata/build-runtime-xliff-ph/goldens/tsconfig.json

packages/localize-tools/testdata/build-runtime-xliff-ph/input/tsconfig.json

packages/localize-tools/testdata/build-runtime-xliff/input/tsconfig.json

packages/localize-tools/testdata/extract-xlb-fresh/goldens/tsconfig.json

AndrewJakubowicz

nvm – noticed that all skipLibCheck was in testdata directories.
I like this change!

augustjk · 2023-07-18T01:09:06Z

The original commit was cherry-picked from when I was testing in the React update branch, adding configs until build and test scripts were passing. But I figured if we're going this route we should add this to every tsconfig.json we have and be explicit all the way.

augustjk added 2 commits July 17, 2023 16:23

Add explicit "types" to tsconfig

56730ec

Add empty changeset

bb680de

augustjk requested review from AndrewJakubowicz, justinfagnani and rictic July 18, 2023 00:03

augustjk requested review from benjamind and kevinpschaaf as code owners July 18, 2023 00:03

AndrewJakubowicz reviewed Jul 18, 2023

View reviewed changes

AndrewJakubowicz approved these changes Jul 18, 2023

View reviewed changes

Add "types" to remaining tsconfigs

2d57aa6

justinfagnani approved these changes Jul 18, 2023

View reviewed changes

augustjk merged commit 14f2a2f into main Jul 18, 2023

augustjk deleted the explicit-global-types branch July 18, 2023 16:59

[all] Add explicit "types" to tsconfig #4025

[all] Add explicit "types" to tsconfig #4025

Uh oh!

Conversation

augustjk commented Jul 18, 2023

Uh oh!

changeset-bot bot commented Jul 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions bot commented Jul 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📊 Tachometer Benchmark Results

Summary

nop-update

render

update

update-reflect

Results

render

update

update-reflect

render

update

nop-update

render

update

render

update

render

update

update-reflect

Uh oh!

AndrewJakubowicz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

AndrewJakubowicz Jul 18, 2023

Choose a reason for hiding this comment

Uh oh!

augustjk Jul 18, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AndrewJakubowicz left a comment

Choose a reason for hiding this comment

Uh oh!

augustjk commented Jul 18, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

changeset-bot bot commented Jul 18, 2023 •

edited

Loading

github-actions bot commented Jul 18, 2023 •

edited

Loading