TS 5 Regression. tsconfig extends stop resolving references to node_modules #53314

Vidda777 · 2023-03-17T11:57:50Z

Bug Report

🔎 Search Terms

TS 5, tsconfig, extends, node modules

🕗 Version & Regression Information

5.0.2

In latest stable build, 4.9.5, tsconfig extends resolve correctly references to libraries on node modules. However, after trying out 5.0.2 it has stop working

This changed between versions 4.9.5 and 5.0.2

⏯ Playground Link

No Playground, I quickly check and there is no support for tsconfig, package.json,...

💻 Code

No code, it's just configuration. Having a package.json declaring

 "devDependencies": {
    "@mylibrary/commons": "1.0.0",
    "typescript": "5.0.2"
  }

and a tsconfig with:
"extends": "@mylibrary/commons/configs/tsconfig.backend.json",

🙁 Actual behavior

The command tsc --build finish with error:

tsconfig.json:2:14 - error TS6053: File '@mylibrary/commons/configs/tsconfig.backend.json' not found.

2   "extends": "@mylibrary/commons/configs/tsconfig.backend.json",

🙂 Expected behavior

The command tsc --build finish correctly.

The text was updated successfully, but these errors were encountered:

ilogico · 2023-03-17T17:38:53Z

This is most likely because @mylibrary/commons has an exports field on package,json without exporting the file.

jakebailey · 2023-03-17T18:33:21Z

I don't think we consider exports for tsconfig, just paths. But, I could be wrong.

I think what we need is the layout of whatever @mylibrary/commons is (plus maybe package.json). Bascially, a minimal repro, as this issue isn't enough.

ilogico · 2023-03-17T18:35:13Z

The reason I said is because I hit this problem when upgrading to 5.0 and I fixed it by adding an entry to the exports map.

jakebailey · 2023-03-17T18:36:43Z

Oh, very interesting!

RyanCavanaugh · 2023-03-17T20:06:13Z

I think this is a bug, AFAIK extends lookups should always be done as CJS lookups. Probably we'll have to revisit that logic at some point...

ilogico · 2023-03-17T20:09:36Z

Subpath exports are not specific to ESM.
In fact, I would say ignoring exports was the bug, even if fixing it is a breaking change.

ilogico · 2023-03-17T20:11:02Z

And considering this to be a bug and "fixing" it is also a breaking change.

RyanCavanaugh · 2023-03-17T20:18:20Z

"breaking change" does not include undoing accidental changes back to the prior behavior. That's an unusable definition.

ilogico · 2023-03-17T20:33:37Z

I don't want to discuss the semantics of breaking changes. Of course I accept that fixing bug might be a desirable breaking change, that was my initial point.
I think it's reasonable to assume that TS would use the same lookup algorithm as NodeJS and that everything else is a bug, a quirk, non-standard behaviour or whatever you want to call it. But if you think it's more important to keep the previous behaviour, I would say that's reasonable as well.

But maybe there's a middle ground where the lookup is done in the standard way (looking at the exports field) and then falling back to the directory structure as it did before.

loucyx · 2023-03-18T07:26:04Z

IDK if this is useful for the conversation and for debugging, but I had my exports field with this property set for a while now:

"exports": {
  // ...
  "./*.json": "./lib/*.json"
  // ...
}

And I still get the "File not found" error when trying to import it from other packages, which indeed is a regression from my point of view, but also indicates that the fix isn't "just using exports," because the "*" syntax is valid, and also having to specify file by file in the exports field is kinda unrealistic.

Hope I'm adding something useful to the conversation and this isn't just unwanted noise.

mike-lischke · 2023-03-18T11:22:50Z

I just upgraded to TS 5 and found the same issue with one of my own node packages ( repo, npm). With TS 5 I now get the error

Cannot find module 'antlr4-c3' or its corresponding type declarations.ts(2307)

Needless to say that I did not change any bit in the project where I'm using the node package. Just upgrading to TS 5 broke the import.

I played a bit with other node module resolution settings, but nothing helped. What sticks out when looking in the bundled node package is that there's no index.js file in the root folder. All the code is in the out/ folder.

Update: I solved the issue by setting the main entry in package.json to ./out, so it's not a critical problem (for me).

jakebailey · 2023-03-18T16:23:28Z

@mike-lischke This issue is about tsconfig's extends clause. Your issue is unrelated; please file a separate issue.

Vidda777 · 2023-03-20T06:41:14Z

Hi, sorry for not answering sooner. What @ilogico said seems reasonable as a workaround, adding the config file as an export entry in the package.json of the library. We don't have it there and maybe this is the way to enforce it to be "exportable". Thanks for the tip.

However, the current TS 5.0.2 behaviour is a regression to what previous 4.x did. So here's the point, as I didn't see a 5.0 changelog announcing this as a breaking change (and the corresponding how-to fix), I assume this is a legit regression bug.

Thanks to all who have contributed to the post. Sorry if I didn't add a fully reproducible environment, I though it was straighforward case.

Anyway, here's the part of the package.json and the capture of the library structure

"exports": {
    ".": {
      "import": "./dist/mjs/src/main/index.js",
      "require": "./dist/cjs/src/main/index.js"
    },
    "./configs/jest.config.js": {
      "require": "./configs/jest.config.js"
    },
    "./configs/.eslintrc.backend.js": {
      "require": "./configs/.eslintrc.backend.js"
    },
    "./configs/.prettierrc.js": {
      "require": "./configs/.prettierrc.js"
    }
  },

jakebailey · 2023-03-20T16:20:58Z

I assume this is a legit regression bug.

Yes, note the label on the issue.

andrewbranch · 2023-03-20T18:47:35Z

It looks like the current behavior was accepted as being intentional in #48665, and implemented in #50955. Are we wanting to reconsider that decision, or did we just forget to mark it as a breaking change?

loucyx · 2023-03-20T20:01:33Z

Even if it is intentional, is still "broken", because as I mentioned in my previous comment, the "*" exports don't work. So #50955 doesn't fully support the exports specification. It's either a regression or an incomplete breaking change.

andrewbranch · 2023-03-20T20:08:54Z

Yeah, it looks like the exports pattern trailer feature flag is just missing.

andrewbranch · 2023-03-22T21:39:41Z

We decided this was intentional, minus the wildcard issue, which I’ll put up a fix for shortly. If a package wants to make its tsconfig.json available for extending, and has an "exports" in its package.json, it needs to make sure the tsconfig is reachable via those "exports".

barca-reddit · 2023-03-28T13:12:11Z

We decided this was intentional, minus the wildcard issue, which I’ll put up a fix for shortly. If a package wants to make its tsconfig.json available for extending, and has an "exports" in its package.json, it needs to make sure the tsconfig is reachable via those "exports".

Hello. Apologies if this is a silly question, but is this fix for wildcard exports going to be part of Typescript 5.0.3? I checked the milestones page for 5.0.3 and 5.1.0 and it wasn't part of it.

I also tested the fix with typescript@next, but I was still getting the same error as before:

// package.json
{
    "name": "@repo/config",
    "exports": {
        "./*.json": {
            "require": "./typescript/*.json"
        }
    }
}

// tsconfig.json (elsewhere in the monorepo)
{
    "extends": "@repo/config/typescript/tsconfig.browser.json",
}
// ❌ File '@repo/config/typescript/tsconfig.browser.json' not found.

Essentially all I am asking is when is this going to be available in nightly or main versions of TS?

Cheers!

jakebailey · 2023-03-28T14:15:25Z

The fix is already available in nightly. I just had the bot open a PR to pull the fix back into 5.0, since I think we wanted that.

If it's not working in nightly, then that's a problem.

barca-reddit · 2023-03-28T15:10:54Z

If it's not working in nightly, then that's a problem.

Apologies for the false alarm. After spending some more time to setup everything from scratch on a clean repository, I got the nightly version to work correctly with wildcards, so the fix is indeed working.

I just had the bot open a PR to pull the fix back into 5.0, since I think we wanted that.

Just one quick question if you don't mind - if I understand correctly, this means that when the next version of Typescript releases (5.0.3), this fix will be included in it, and until then I can use nightly versions?

Cheers!

jakebailey · 2023-03-28T15:26:59Z

If we take it, 5.0.3.

barca-reddit · 2023-03-28T15:49:50Z

If we take it, 5.0.3.

I am not entirely certain what to "take it" means, but nevertheless I appreciate the response and your help. Will just be keeping an eye on the release notes.

Cheers again! 👍

jakebailey · 2023-03-28T16:07:09Z

See #53557. @DanielRosenwasser

"If" was a little too loose; we definitely wanted this to be backported to 5.0, per design meeting discussion. We just have to merge the cherry-pick before release.

TypeScript used to be able to resolve the extends field in `tsconfig.json` using the node require algorithm. Recent versions of TypeScript have a regression that means that if a module has an exports map, the extendable typescript config file has to be in that exports map so add it here. Refs: microsoft/TypeScript#53314

naftalimurgor · 2023-11-21T13:00:07Z

Still experiencing the same issue. Was this fully resolved?

kirillgroshkov · 2023-11-22T21:07:35Z

Still experiencing the same issue. Was this fully resolved?

Yes, we also noticed the regression in 5.3.2 (while it was working in 5.2.2).

jakebailey · 2023-11-22T21:14:05Z

The original issue here is most definitely fixed. If you are having a problem in a recent release, please file a new issue.

If you are using ts-node, maybe you are seeing #56492.

kirillgroshkov · 2023-11-22T21:21:07Z

If you are using ts-node, maybe you are seeing #56492.

It turned out to be exactly that, thank you for the pointer 🙏

milon27 · 2024-06-13T07:07:54Z

yes facing the same issue

RyanCavanaugh · 2024-06-13T17:16:43Z

Please open a new issue with repro steps if you're having a problem

RyanCavanaugh added the Bug A bug in TypeScript label Mar 17, 2023

RyanCavanaugh assigned andrewbranch Mar 17, 2023

RyanCavanaugh added this to the TypeScript 5.1.0 milestone Mar 17, 2023

RyanCavanaugh mentioned this issue Mar 22, 2023

Design Meeting Notes, 2023-03-22 #53442

Closed

andrewbranch mentioned this issue Mar 22, 2023

Support wildcard exports in tsconfig lookup #53443

Merged

typescript-bot added the Fix Available A PR has been opened for this issue label Mar 22, 2023

andrewbranch closed this as completed in #53443 Mar 22, 2023

RyanCavanaugh mentioned this issue Mar 24, 2023

Tsconfig Extends From Base Configuration as NPM package File Not Found Error #53495

Closed

DanielRosenwasser modified the milestones: TypeScript 5.1.0, TypeScript 5.0.3 Mar 28, 2023

mcous mentioned this issue Apr 4, 2023

Update TypeScript and ESLint configs for compatibility viamrobotics/js-config#5

Merged

achingbrain mentioned this issue May 17, 2023

fix: add tsconfig to exports map ipfs/aegir#1278

Merged

Rugvip mentioned this issue Nov 27, 2023

🐛 Bug Report: Typescript 5.3 causes config-schema-generator to fail to find @backstage/cli's tsconfig.json backstage/backstage#21448

Closed

2 tasks

tknickman mentioned this issue Nov 30, 2023

[turborepo] code generator not working. vercel/turborepo#6656

Closed

microsoft locked as resolved and limited conversation to collaborators Jun 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TS 5 Regression. tsconfig extends stop resolving references to node_modules #53314

TS 5 Regression. tsconfig extends stop resolving references to node_modules #53314

Vidda777 commented Mar 17, 2023 •

edited

Loading

ilogico commented Mar 17, 2023

jakebailey commented Mar 17, 2023

ilogico commented Mar 17, 2023

jakebailey commented Mar 17, 2023

RyanCavanaugh commented Mar 17, 2023

ilogico commented Mar 17, 2023

ilogico commented Mar 17, 2023

RyanCavanaugh commented Mar 17, 2023

ilogico commented Mar 17, 2023

loucyx commented Mar 18, 2023

mike-lischke commented Mar 18, 2023 •

edited

Loading

jakebailey commented Mar 18, 2023

Vidda777 commented Mar 20, 2023

jakebailey commented Mar 20, 2023

andrewbranch commented Mar 20, 2023

loucyx commented Mar 20, 2023

andrewbranch commented Mar 20, 2023

andrewbranch commented Mar 22, 2023

barca-reddit commented Mar 28, 2023

jakebailey commented Mar 28, 2023

barca-reddit commented Mar 28, 2023

jakebailey commented Mar 28, 2023

barca-reddit commented Mar 28, 2023

jakebailey commented Mar 28, 2023

naftalimurgor commented Nov 21, 2023

kirillgroshkov commented Nov 22, 2023

jakebailey commented Nov 22, 2023

kirillgroshkov commented Nov 22, 2023

milon27 commented Jun 13, 2024

RyanCavanaugh commented Jun 13, 2024

TS 5 Regression. tsconfig extends stop resolving references to node_modules #53314

TS 5 Regression. tsconfig extends stop resolving references to node_modules #53314

Comments

Vidda777 commented Mar 17, 2023 • edited Loading

Bug Report

🔎 Search Terms

🕗 Version & Regression Information

⏯ Playground Link

💻 Code

🙁 Actual behavior

🙂 Expected behavior

ilogico commented Mar 17, 2023

jakebailey commented Mar 17, 2023

ilogico commented Mar 17, 2023

jakebailey commented Mar 17, 2023

RyanCavanaugh commented Mar 17, 2023

ilogico commented Mar 17, 2023

ilogico commented Mar 17, 2023

RyanCavanaugh commented Mar 17, 2023

ilogico commented Mar 17, 2023

loucyx commented Mar 18, 2023

mike-lischke commented Mar 18, 2023 • edited Loading

jakebailey commented Mar 18, 2023

Vidda777 commented Mar 20, 2023

jakebailey commented Mar 20, 2023

andrewbranch commented Mar 20, 2023

loucyx commented Mar 20, 2023

andrewbranch commented Mar 20, 2023

andrewbranch commented Mar 22, 2023

barca-reddit commented Mar 28, 2023

jakebailey commented Mar 28, 2023

barca-reddit commented Mar 28, 2023

jakebailey commented Mar 28, 2023

barca-reddit commented Mar 28, 2023

jakebailey commented Mar 28, 2023

naftalimurgor commented Nov 21, 2023

kirillgroshkov commented Nov 22, 2023

jakebailey commented Nov 22, 2023

kirillgroshkov commented Nov 22, 2023

milon27 commented Jun 13, 2024

RyanCavanaugh commented Jun 13, 2024

Vidda777 commented Mar 17, 2023 •

edited

Loading

mike-lischke commented Mar 18, 2023 •

edited

Loading