Validate JSON imports into ESM in `--module nodenext` by andrewbranch · Pull Request #60019 · microsoft/TypeScript

Andrew Branch (andrewbranch) · 2024-09-20T17:36:25Z

This does two main things:

Enforces use of import attributes on JSON-file imports in --module nodenext, since Node.js crashes without them
Errors on named imports of JSON-file imports in --module nodenext, since those don't work in Node.js. We already sort of considered this information when building up the type of a namespace import of a JSON file, but named imports bypassed that check.

Andrew Branch (andrewbranch) · 2024-09-20T17:37:24Z

 // In Node.js, JSON modules don't get named exports
 if (ModuleKind.Node16 <= moduleKind && moduleKind <= ModuleKind.NodeNext) {
 const usageMode = getEmitSyntaxForModuleSpecifierExpression(usage);
- return usageMode === ModuleKind.ESNext && endsWith((usage as StringLiteralLike).text, Extension.Json);


The text of the module specifier is not sufficient to know whether we're importing a JSON file; this produced both false positives and false negatives (see imports of "actually-json" and "not.json" in the test)

Andrew Branch (andrewbranch) · 2024-09-20T17:38:14Z

+ const index = baseName.lastIndexOf(".d.");
 if (index >= 0) {
- return fileName.substring(index);
+ return baseName.substring(index);


This was extremely bad; I guess we were only really using this to determine whether something was a declaration file name, not to actually use the extension.

Jake Bailey (jakebailey) · 2024-09-20T17:46:48Z

TypeScript Bot (@typescript-bot) test it

TypeScript Bot (typescript-bot) · 2024-09-20T17:46:51Z

Starting jobs; this comment will be updated as builds start and complete.

Command	Status	Results
`test top400`	✅ Started	👀 Results
`user test this`	✅ Started	👀 Results
`run dt`	✅ Started	✅ Results
`perf test this faster`	✅ Started	👀 Results

TypeScript Bot (typescript-bot) · 2024-09-20T18:08:18Z

Hey Jake Bailey (@jakebailey), the results of running the DT tests are ready.

Everything looks the same!

You can check the log here.

TypeScript Bot (typescript-bot) · 2024-09-20T18:14:19Z

Jake Bailey (@jakebailey) Here are the results of running the user tests with tsc comparing main and refs/pull/60019/merge:

Something interesting changed - please have a look.

Details

effect

tsconfig.json

[NEW] error TS1543: Importing a JSON file into an ECMAScript module requires a 'type: "json"' import attribute when 'module' is set to 'NodeNext'.
- packages/platform-node/test/HttpApi.test.ts#L21 in packages/platform-node/tsconfig.test.json

tsconfig.base.json

[NEW] error TS1543: Importing a JSON file into an ECMAScript module requires a 'type: "json"' import attribute when 'module' is set to 'NodeNext'.
- packages/platform-node/test/HttpApi.test.ts#L21 in tsconfig.base.json

TypeScript Bot (typescript-bot) · 2024-09-20T18:26:16Z

Jake Bailey (@jakebailey)
The results of the perf run you requested are in!

Here they are:

tsc

Comparison Report - baseline..pr

_Metric	_baseline	_pr	_Delta	_Best	_Worst	_p-value
_{Compiler-Unions - node (v18.15.0, x64)}
_Errors	₃₀	₃₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_62,153	_62,153	_~	_~	_~	_{p=1.000 n=6}
_Types	_50,242	_50,242	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{193,106k (± 0.80%)}	_{193,076k (± 0.73%)}	_~	_192,393k	_195,940k	_{p=0.471 n=6}
_{Parse Time}	_{1.31s (± 0.94%)}	_{1.30s (± 0.63%)}	_~	_1.29s	_1.31s	_{p=0.730 n=6}
_{Bind Time}	_0.71s	_0.71s	_~	_~	_~	_{p=1.000 n=6}
_{Check Time}	_{9.55s (± 0.42%)}	_{9.59s (± 0.59%)}	_~	_9.52s	_9.67s	_{p=0.169 n=6}
_{Emit Time}	_{2.72s (± 0.38%)}	_{2.70s (± 1.60%)}	_~	_2.61s	_2.73s	_{p=0.101 n=6}
_{Total Time}	_{14.29s (± 0.28%)}	_{14.30s (± 0.45%)}	_~	_14.24s	_14.39s	_{p=1.000 n=6}
_{angular-1 - node (v18.15.0, x64)}
_Errors	₇	₇	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_945,753	_945,753	_~	_~	_~	_{p=1.000 n=6}
_Types	_410,067	_410,067	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{1,222,766k (± 0.00%)}	_{1,222,762k (± 0.00%)}	_~	_1,222,714k	_1,222,839k	_{p=0.689 n=6}
_{Parse Time}	_{6.64s (± 0.78%)}	_{6.64s (± 0.43%)}	_~	_6.60s	_6.68s	_{p=0.936 n=6}
_{Bind Time}	_{1.86s (± 0.34%)}	_{1.86s (± 0.63%)}	_~	_1.84s	_1.87s	_{p=0.485 n=6}
_{Check Time}	_{31.19s (± 0.55%)}	_{31.17s (± 0.50%)}	_~	_31.03s	_31.39s	_{p=0.575 n=6}
_{Emit Time}	_{15.08s (± 0.26%)}	_{15.06s (± 0.46%)}	_~	_14.97s	_15.12s	_{p=0.810 n=6}
_{Total Time}	_{54.78s (± 0.23%)}	_{54.73s (± 0.29%)}	_~	_54.54s	_54.98s	_{p=0.575 n=6}
_{mui-docs - node (v18.15.0, x64)}
_Errors	₀	₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_2,529,472	_2,529,472	_~	_~	_~	_{p=1.000 n=6}
_Types	_936,018	_936,018	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{2,364,738k (± 0.00%)}	_{2,364,744k (± 0.00%)}	_~	_2,364,702k	_2,364,769k	_{p=0.936 n=6}
_{Parse Time}	_{9.42s (± 0.22%)}	_{9.41s (± 0.15%)}	_~	_9.38s	_9.42s	_{p=0.366 n=6}
_{Bind Time}	_{2.17s (± 0.48%)}	_{2.18s (± 0.54%)}	_~	_2.17s	_2.20s	_{p=0.121 n=6}
_{Check Time}	_{72.96s (± 0.42%)}	_{73.03s (± 0.70%)}	_~	_72.28s	_73.74s	_{p=0.688 n=6}
_{Emit Time}	_{0.28s (± 1.86%)}	_{0.28s (± 1.86%)}	_~	_0.27s	_0.28s	_{p=1.000 n=6}
_{Total Time}	_{84.82s (± 0.37%)}	_{84.89s (± 0.59%)}	_~	_84.15s	_85.57s	_{p=0.689 n=6}
_{self-build-src - node (v18.15.0, x64)}
_Errors	₀	₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_1,246,550	_1,246,583	_{+33 (+ 0.00%)}	_~	_~	_{p=0.001 n=6}
_Types	_264,444	_264,461	_{+17 (+ 0.01%)}	_~	_~	_{p=0.001 n=6}
_{Memory used}	_{2,399,186k (± 0.02%)}	_{2,399,512k (± 0.04%)}	_~	_2,398,425k	_2,400,960k	_{p=0.471 n=6}
_{Parse Time}	_{5.09s (± 0.35%)}	_{5.10s (± 0.89%)}	_~	_5.04s	_5.15s	_{p=0.630 n=6}
_{Bind Time}	_{1.92s (± 0.33%)}	_{1.90s (± 0.72%)}	_{-0.02s (- 0.87%)}	_1.88s	_1.92s	_{p=0.024 n=6}
_{Check Time}	_{34.79s (± 0.42%)}	_{35.07s (± 0.85%)}	_~	_34.75s	_35.43s	_{p=0.093 n=6}
_{Emit Time}	_{3.04s (± 2.68%)}	_{3.00s (± 4.26%)}	_~	_2.84s	_3.23s	_{p=0.295 n=6}
_{Total Time}	_{44.85s (± 0.40%)}	_{45.07s (± 0.63%)}	_~	_44.64s	_45.36s	_{p=0.128 n=6}
_{self-build-src-public-api - node (v18.15.0, x64)}
_Errors	₀	₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_1,246,550	_1,246,583	_{+33 (+ 0.00%)}	_~	_~	_{p=0.001 n=6}
_Types	_264,444	_264,461	_{+17 (+ 0.01%)}	_~	_~	_{p=0.001 n=6}
_{Memory used}	_{2,473,347k (± 0.02%)}	_{2,473,929k (± 0.03%)}	_~	_2,473,116k	_2,474,940k	_{p=0.128 n=6}
_{Parse Time}	_{6.33s (± 0.53%)}	_{6.29s (± 0.75%)}	_~	_6.21s	_6.34s	_{p=0.092 n=6}
_{Bind Time}	_{2.05s (± 1.10%)}	_{2.04s (± 0.59%)}	_~	_2.03s	_2.06s	_{p=0.627 n=6}
_{Check Time}	_{41.41s (± 0.73%)}	_{41.55s (± 0.85%)}	_~	_41.23s	_42.01s	_{p=0.689 n=6}
_{Emit Time}	_{3.63s (± 3.03%)}	_{3.51s (± 1.66%)}	_{🟩-0.12s (- 3.26%)}	_3.43s	_3.60s	_{p=0.045 n=6}
_{Total Time}	_{53.43s (± 0.59%)}	_{53.40s (± 0.64%)}	_~	_53.00s	_53.76s	_{p=0.936 n=6}
_{self-compiler - node (v18.15.0, x64)}
_Errors	₀	₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_259,902	_259,913	_{+11 (+ 0.00%)}	_~	_~	_{p=0.001 n=6}
_Types	_106,141	_106,156	_{+15 (+ 0.01%)}	_~	_~	_{p=0.001 n=6}
_{Memory used}	_{435,611k (± 0.02%)}	_{435,638k (± 0.02%)}	_~	_435,510k	_435,725k	_{p=0.575 n=6}
_{Parse Time}	_{3.42s (± 0.82%)}	_{3.43s (± 0.65%)}	_~	_3.41s	_3.46s	_{p=0.252 n=6}
_{Bind Time}	_{1.30s (± 1.02%)}	_{1.31s (± 0.57%)}	_~	_1.30s	_1.32s	_{p=0.230 n=6}
_{Check Time}	_{18.20s (± 0.21%)}	_{18.20s (± 0.20%)}	_~	_18.15s	_18.24s	_{p=1.000 n=6}
_{Emit Time}	_{1.53s (± 1.37%)}	_{1.52s (± 1.44%)}	_~	_1.49s	_1.55s	_{p=0.464 n=6}
_{Total Time}	_{24.45s (± 0.27%)}	_{24.47s (± 0.14%)}	_~	_24.42s	_24.52s	_{p=0.686 n=6}
_{ts-pre-modules - node (v18.15.0, x64)}
_Errors	₆₈	₆₈	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_225,018	_225,018	_~	_~	_~	_{p=1.000 n=6}
_Types	_94,249	_94,249	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{370,216k (± 0.01%)}	_{370,344k (± 0.03%)}	_{+128k (+ 0.03%)}	_370,224k	_370,536k	_{p=0.030 n=6}
_{Parse Time}	_{2.76s (± 1.11%)}	_{2.75s (± 0.61%)}	_~	_2.73s	_2.77s	_{p=0.569 n=6}
_{Bind Time}	_{1.55s (± 1.20%)}	_{1.59s (± 1.48%)}	_~	_1.57s	_1.62s	_{p=0.056 n=6}
_{Check Time}	_{15.76s (± 0.35%)}	_{15.75s (± 0.24%)}	_~	_15.69s	_15.80s	_{p=1.000 n=6}
_{Emit Time}	_0.00s	_0.00s	_~	_~	_~	_{p=1.000 n=6}
_{Total Time}	_{20.07s (± 0.43%)}	_{20.08s (± 0.31%)}	_~	_20.03s	_20.19s	_{p=1.000 n=6}
_{vscode - node (v18.15.0, x64)}
_Errors	₁	₁	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_3,093,507	_3,093,507	_~	_~	_~	_{p=1.000 n=6}
_Types	_1,066,180	_1,066,180	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{3,191,308k (± 0.00%)}	_{3,191,300k (± 0.00%)}	_~	_3,191,191k	_3,191,443k	_{p=0.810 n=6}
_{Parse Time}	_{13.93s (± 0.38%)}	_{13.90s (± 0.21%)}	_~	_13.86s	_13.94s	_{p=0.376 n=6}
_{Bind Time}	_{4.45s (± 2.66%)}	_{4.45s (± 2.68%)}	_~	_4.36s	_4.61s	_{p=1.000 n=6}
_{Check Time}	_{82.16s (± 0.51%)}	_{82.20s (± 0.47%)}	_~	_81.66s	_82.76s	_{p=0.936 n=6}
_{Emit Time}	_{22.40s (± 0.30%)}	_{22.38s (± 0.62%)}	_~	_22.24s	_22.62s	_{p=0.630 n=6}
_{Total Time}	_{122.94s (± 0.23%)}	_{122.93s (± 0.37%)}	_~	_122.37s	_123.47s	_{p=0.936 n=6}
_{webpack - node (v18.15.0, x64)}
_Errors	₀	₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_277,196	_277,196	_~	_~	_~	_{p=1.000 n=6}
_Types	_112,950	_112,950	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{427,080k (± 0.02%)}	_{426,984k (± 0.02%)}	_~	_426,879k	_427,123k	_{p=0.092 n=6}
_{Parse Time}	_{4.89s (± 0.47%)}	_{4.90s (± 0.35%)}	_~	_4.88s	_4.93s	_{p=0.369 n=6}
_{Bind Time}	_{2.14s (± 0.62%)}	_{2.15s (± 0.49%)}	_~	_2.13s	_2.16s	_{p=0.451 n=6}
_{Check Time}	_{21.89s (± 0.34%)}	_{21.81s (± 0.27%)}	_~	_21.70s	_21.87s	_{p=0.065 n=6}
_{Emit Time}	_0.00s	_0.00s	_~	_~	_~	_{p=1.000 n=6}
_{Total Time}	_{28.92s (± 0.27%)}	_{28.85s (± 0.19%)}	_~	_28.76s	_28.91s	_{p=0.173 n=6}
_{xstate-main - node (v18.15.0, x64)}
_Errors	₀	₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_539,943	_539,943	_~	_~	_~	_{p=1.000 n=6}
_Types	_181,263	_181,263	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{483,313k (± 0.01%)}	_{483,352k (± 0.01%)}	_~	_483,304k	_483,398k	_{p=0.149 n=6}
_{Parse Time}	_{3.23s (± 0.48%)}	_{3.22s (± 0.38%)}	_~	_3.20s	_3.23s	_{p=0.166 n=6}
_{Bind Time}	_{1.16s (± 1.09%)}	_{1.16s (± 0.65%)}	_~	_1.15s	_1.17s	_{p=1.000 n=6}
_{Check Time}	_{18.34s (± 0.26%)}	_{18.35s (± 0.24%)}	_~	_18.29s	_18.41s	_{p=1.000 n=6}
_{Emit Time}	_0.00s	_0.00s	_~	_~	_~	_{p=1.000 n=6}
_{Total Time}	_{22.74s (± 0.24%)}	_{22.72s (± 0.18%)}	_~	_22.67s	_22.79s	_{p=0.810 n=6}

System info unknown

Hosts

node (v18.15.0, x64)

Scenarios

Compiler-Unions - node (v18.15.0, x64)
angular-1 - node (v18.15.0, x64)
mui-docs - node (v18.15.0, x64)
self-build-src - node (v18.15.0, x64)
self-build-src-public-api - node (v18.15.0, x64)
self-compiler - node (v18.15.0, x64)
ts-pre-modules - node (v18.15.0, x64)
vscode - node (v18.15.0, x64)
webpack - node (v18.15.0, x64)
xstate-main - node (v18.15.0, x64)

_Benchmark	_Name	_Iterations
_Current	_pr	₆
_Baseline	_baseline	₆

Developer Information:

Download Benchmarks

TypeScript Bot (typescript-bot) · 2024-09-20T19:27:40Z

Jake Bailey (@jakebailey) Here are the results of running the top 400 repos with tsc comparing main and refs/pull/60019/merge:

Something interesting changed - please have a look.

Details

ikatyang/emoji-cheat-sheet

tsconfig.json

error TS1544: Named imports from a JSON file into an ECMAScript module are not allowed when 'module' is set to 'Node16'.
- scripts/markdown.ts#L1
- scripts/markdown.ts#L1
error TS1543: Importing a JSON file into an ECMAScript module requires a 'type: "json"' import attribute when 'module' is set to 'Node16'.
- scripts/markdown.ts#L1

refined-github/refined-github

tsconfig.json

error TS1543: Importing a JSON file into an ECMAScript module requires a 'type: "json"' import attribute when 'module' is set to 'Node16'.

Andrew Branch (andrewbranch) added 2 commits September 19, 2024 16:59

WIP
d75da77

Validate JSON imports in nodenext ESM
cc52223

TypeScript Bot (typescript-bot) assigned Andrew Branch (andrewbranch)Sep 20, 2024

TypeScript Bot (typescript-bot) added Author: Team For Milestone Bug PRs that fix a bug with a specific milestone labels Sep 20, 2024

Andrew Branch (andrewbranch) commented Sep 20, 2024
View reviewed changes

Andrew Branch (andrewbranch) requested review from Jake Bailey (jakebailey) and Wesley Wigham (weswigham)September 20, 2024 17:38

Update older tests
15b0406

Andrew Branch (andrewbranch) added the Breaking Change Would introduce errors in existing code label Sep 20, 2024

Wesley Wigham (weswigham) approved these changes Sep 23, 2024
View reviewed changes

Andrew Branch (andrewbranch) merged commit 9ad213f into microsoft:mainSep 24, 2024

Andrew Branch (andrewbranch) deleted the bug/59684 branch September 24, 2024 20:02

Raymond Z (raykyri) mentioned this pull request Nov 25, 2024
Module resolution: Regression in JSON import using Node16 resolution #60589
Closed

Casey Waldren (cwaldren-ld) mentioned this pull request Dec 4, 2024
ci: pin typescript dependency to 5.6.3 launchdarkly/sdk-meta#200
Merged

Nathan Shively-Sanders (sandersn) removed this from PR Backlog Apr 22, 2025

Microsoft (microsoft) locked as resolved and limited conversation to collaborators Oct 16, 2025

Navigation Menu

Uh oh!

Validate JSON imports into ESM in `--module nodenext` - #60019

Validate JSON imports into ESM in `--module nodenext`#60019
Andrew Branch (andrewbranch) merged 3 commits into
microsoft:mainfrom
andrewbranch:bug/59684

Andrew Branch (andrewbranch) commented Sep 20, 2024

Uh oh!

Andrew Branch (andrewbranch)Sep 20, 2024

Uh oh!

Andrew Branch (andrewbranch)Sep 20, 2024

Uh oh!

Jake Bailey (jakebailey) commented Sep 20, 2024

Uh oh!

TypeScript Bot (typescript-bot) commented Sep 20, 2024•
edited
Loading

Uh oh!

TypeScript Bot (typescript-bot) commented Sep 20, 2024

Uh oh!

TypeScript Bot (typescript-bot) commented Sep 20, 2024

effect

tsconfig.json

tsconfig.base.json

Uh oh!

TypeScript Bot (typescript-bot) commented Sep 20, 2024

tsc

Uh oh!

TypeScript Bot (typescript-bot) commented Sep 20, 2024

ikatyang/emoji-cheat-sheet

tsconfig.json

refined-github/refined-github

tsconfig.json

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

Andrew Branch (andrewbranch) commented Sep 20, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Jake Bailey (jakebailey) commented Sep 20, 2024

Uh oh!

TypeScript Bot (typescript-bot) commented Sep 20, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TypeScript Bot (typescript-bot) commented Sep 20, 2024

Uh oh!

TypeScript Bot (typescript-bot) commented Sep 20, 2024

Uh oh!

TypeScript Bot (typescript-bot) commented Sep 20, 2024

tsc

Uh oh!

TypeScript Bot (typescript-bot) commented Sep 20, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

TypeScript Bot (typescript-bot) commented Sep 20, 2024•
edited
Loading