TypeError: hostOrText.readFile is not a function when extending @tsconfig/node18

[avidj]

Current Behavior

Given the devDependency "@tsconfig/node18": "1.0.1"
and a tsconfig.json with "extends": "@tsconfig/node18"
every target (here: linting) results in

TypeError: hostOrText.readFile is not a function
Occurred while linting .../quality/large-test-base/src/assertions.ts:1
Rule: "@nrwl/nx/enforce-module-boundaries"
    at readJsonOrUndefined (.../node_modules/typescript/lib/typescript.js:19519:74)
    at Object.readJson (.../node_modules/typescript/lib/typescript.js:19528:16)

The reason is a call to readFile in typescript/typescript.js line 19519:
var jsonText = ts.isString(hostOrText) ? hostOrText : hostOrText.readFile(path);

It can be interpreted as a breaking change in typescript where a surrounding try-block was removed:
microsoft/TypeScript#51644

However, IMHO at least judging from the referenced discussion, it also seems to be a bug in nx as it provides a host that is missing the readFile method in nx/utils/typescript.js line 23:

const host = {
        readDirectory: () => [],
        fileExists: tsModule.sys.fileExists,
    };

Remark: I got the stack trace with linting. But there were also situations (I think just tsc) where I only got the error message. This made tracking down the problem unnecessarily difficult.

Expected Behavior

no error

Github Repo

No response

Steps to Reproduce

See above

1. add dependency "@tsconfig/node18": "1.0.1"`
2. add "extends": "@tsconfig/node18" to tsconfig.json
3. npx nx lint

Nx Report

[547][d068511.C02C78CRMD6T: sapgraph]$ npx nx report

 >  NX   hostOrText.readFile is not a function

   
   Because of the error the Nx daemon process has exited. The next Nx command is going to restart the daemon process.
   If the error persists, please run "nx reset".

[548][d068511.C02C78CRMD6T: sapgraph]$

Failure Logs

Occurred while linting /project-root/quality/large-test-base/src/assertions.ts:1
   Rule: "@nrwl/nx/enforce-module-boundaries"

TypeError: hostOrText.readFile is not a function
Occurred while linting /project-root/quality/large-test-base/src/assertions.ts:1
Rule: "@nrwl/nx/enforce-module-boundaries"
    at readJsonOrUndefined (/project-root/node_modules/typescript/lib/typescript.js:19519:74)
    at Object.readJson (/project-root/node_modules/typescript/lib/typescript.js:19528:16)
    at getPackageJsonInfo (/project-root/node_modules/typescript/lib/typescript.js:44767:41)
    at loadModuleFromSpecificNodeModulesDirectory (/project-root/node_modules/typescript/lib/typescript.js:45316:27)
    at loadModuleFromImmediateNodeModulesDirectory (/project-root/node_modules/typescript/lib/typescript.js:45296:58)
    at /project-root/node_modules/typescript/lib/typescript.js:45286:39
    at Object.forEachAncestorDirectory (/project-root/node_modules/typescript/lib/typescript.js:8224:26)
    at loadModuleFromNearestNodeModulesDirectoryWorker (/project-root/node_modules/typescript/lib/typescript.js:45280:19)
    at loadModuleFromNearestNodeModulesDirectory (/project-root/node_modules/typescript/lib/typescript.js:45272:16)
    at tryResolve (/project-root/node_modules/typescript/lib/typescript.js:44358:34)

Additional Information

The attached patch fixes the problem. As a workaround, you may want to apply it with patch-package as postinstall.
nx+15.4.4.patch

[AgentEnder]

I see you have a patch which fixes the issue. Would you like to open a PR?

[aukevanleeuwen]

Same issue here as well, upgraded to TypeScript 4.9 and started failing. We're under a bit of pressure so didn't have time to look into it deeply, but it's the same situation (be it with @tsconfig/node16).

Can confirm that patching ./node_modules/nx/src/utils/typescript.js works.

Note

I first patched ./node_modules/@nrwl/workspace/src/utilities/typescript.js, which had a very similar

function readTsConfigOptions(tsConfigPath) {
  // ...
}

But that didn't seem to do anything for my use case. Just wanted to say that it's in the code base twice:

1. nx/packages/nx/src/utils/typescript.ts

   Lines 34 to 38 in 6d35fd4

   	// we don't need to scan the files, we only care about options
   	const host = {
   	readDirectory: () => [],
   	fileExists: tsModule.sys.fileExists,
   	};

2. nx/packages/workspace/src/utilities/typescript.ts

   Lines 40 to 44 in 6d35fd4

   	// we don't need to scan the files, we only care about options
   	const host: Partial<ts.ParseConfigHost> = {
   	readDirectory: () => [],
   	fileExists: tsModule.sys.fileExists,
   	};

[aukevanleeuwen]

@AgentEnder: I've created a PR for it: #14380

[github-actions]

This issue has been closed for more than 30 days. If this issue is still occuring, please open a new issue with more recent context.