Extension fails to load 'tsconfig.json' with 'references' option.

[Alb11747]

Describe the bug

The extension crashes on start. I think the issue is with references typescript option. If you remove references in tsconfig.json the extension type checking and linting works but the code no longer runs.

Initialize language server at  file:///d%3A/Temp/PotPlayerChat
Initialize new ts service at  d:/Temp/PotPlayerChat/tsconfig.json
Trying to load configs for d:/Temp/PotPlayerChat
Loaded config at  d:\Temp\PotPlayerChat\svelte.config.mjs
SnapshotManager File Statistics:
Project files: 48
Svelte files: 6
From node_modules: 0
Total: 48
RangeError: Maximum call stack size exceeded
    at String.replace (<anonymous>)
    at Object.toFileNameLowerCase [as getCanonicalFileName] (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:3371:46)
    at getCanonicalFileName (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:128900:17)
    at toPath (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:8994:10)
    at toPath3 (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:127422:12)
    at findSourceFileWorker (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:128577:18)
    at findSourceFile (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:128565:20)
    at findSourceFileWorker (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:128585:23)
    at findSourceFile (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:128565:20)
    at findSourceFileWorker (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:128585:23)
TypeError: Cannot read properties of undefined (reading 'getSourceFile')
    at getValidSourceFile (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:152724:32)
    at Object.getEncodedSemanticClassifications3 [as getEncodedSemanticClassifications] (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:153404:77)
    at SemanticTokensProviderImpl.getSemanticTokens (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\typescript\features\SemanticTokensProvider.js:38:32)
    at async PluginHost.tryExecutePlugin (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\PluginHost.js:397:20)
    at async PluginHost.executePlugins (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\PluginHost.js:382:33)
    at async PluginHost.execute (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\PluginHost.js:374:24)
    at async PluginHost.getSemanticTokens (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\PluginHost.js:242:16)
TypeError: Cannot read properties of undefined (reading 'getSyntacticDiagnostics')
    at Object.getSyntacticDiagnostics (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:152986:20)
    at DiagnosticsProviderImpl.getDiagnostics (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\typescript\features\DiagnosticsProvider.js:64:32)
    at async PluginHost.tryExecutePlugin (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\PluginHost.js:397:20)
    at async Promise.all (index 2)
    at async PluginHost.execute (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\PluginHost.js:374:24)
    at async PluginHost.getDiagnostics (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\PluginHost.js:47:38)
    at async DiagnosticsManager.update (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\lib\DiagnosticsManager.js:38:29)
RangeError: Maximum call stack size exceeded
    at String.replace (<anonymous>)
    at Object.toFileNameLowerCase [as getCanonicalFileName] (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:3371:46)
    at getCanonicalFileName (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:128900:17)
    at toPath (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:8994:10)
    at toPath3 (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:127422:12)
    at findSourceFileWorker (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:128577:18)
    at findSourceFile (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:128565:20)
    at findSourceFileWorker (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:128585:23)
    at findSourceFile (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:128565:20)
    at findSourceFileWorker (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:128585:23)
TypeError: Cannot read properties of undefined (reading 'getSyntacticDiagnostics')
    at Object.getSyntacticDiagnostics (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:152986:20)
    at DiagnosticsProviderImpl.getDiagnostics (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\typescript\features\DiagnosticsProvider.js:64:32)
    at async PluginHost.tryExecutePlugin (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\PluginHost.js:397:20)
    at async Promise.all (index 2)
    at async PluginHost.execute (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\PluginHost.js:374:24)
    at async PluginHost.getDiagnostics (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\PluginHost.js:47:38)
    at async DiagnosticsManager.update (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\lib\DiagnosticsManager.js:38:29)
TypeError: Cannot read properties of undefined (reading 'getSourceFile')
    at getValidSourceFile (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:152724:32)
    at Object.getEncodedSemanticClassifications3 [as getEncodedSemanticClassifications] (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:153404:77)
    at SemanticTokensProviderImpl.getSemanticTokens (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\typescript\features\SemanticTokensProvider.js:38:32)
    at async PluginHost.tryExecutePlugin (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\PluginHost.js:397:20)
    at async PluginHost.executePlugins (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\PluginHost.js:382:33)
    at async PluginHost.execute (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\PluginHost.js:374:24)
    at async PluginHost.getSemanticTokens (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\PluginHost.js:242:16)
TypeError: Cannot read properties of undefined (reading 'getSourceFile')
    at getValidSourceFile (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:152724:32)
    at Object.getEncodedSemanticClassifications3 [as getEncodedSemanticClassifications] (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\typescript\lib\typescript.js:153404:77)
    at SemanticTokensProviderImpl.getSemanticTokens (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\typescript\features\SemanticTokensProvider.js:38:32)
    at async PluginHost.tryExecutePlugin (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\PluginHost.js:397:20)
    at async PluginHost.executePlugins (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\PluginHost.js:382:33)
    at async PluginHost.execute (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\PluginHost.js:374:24)
    at async PluginHost.getSemanticTokens (c:\Users\Albert\.vscode\extensions\svelte.svelte-vscode-109.10.1\node_modules\svelte-language-server\dist\src\plugins\PluginHost.js:242:16)

Reproduction

You can reproduce the issue with this project.

git clone https://github.com/Alb11747/PotPlayerChat
cd ./PotPlayerChat
npm install

// Open a Svelte file (.e.g. `src\renderer\src\App.svelte`)

tsconfig.json
tsconfig.node.json
tsconfig.web.json

Expected behaviour

TS language features like type checking and control clicking work. Currently errors are not reported, hovering does nothing, and clicking to find definition does not work.

System Info

• OS: Windows
• IDE: VSCode
• Extension Version: svelte.svelte-vscode-109.10

Which package is the issue about?

Svelte for VS Code extension

Additional Information, eg. Screenshots

I think a fix could be to add a vscode settings that allow the user to supply the path to the desired tsconfig (e.g. tsconfig.web.json), rather than assuming it's always tsconfig.json.

[jasonlyu123]

Note for later debugging, this started to happen in Typescript 5.8.3. From the stack trace, it sounds like it crashed in module resolution, maybe there's a file with a cyclic dependency.

[jasonlyu123]

The infinite recursion is in TypeScript's code. And it's deep in the call stack, so I don't think there is a way to fix it on our side. However, this is mostly a configuration problem. Your tsconfig.json should be a solution-style config. In the current config, your tconfig.json includes all the files that are also in the referenced project. If the tsconfig.json is something like this, it doesn't crash.

{
  "references": [
    {
      "path": "./tsconfig.node.json"
    },
    {
      "path": "./tsconfig.web.json"
    }
  ],
  "include": []
}

[Alb11747]

The fix worked for my current project. You can close the issue if you feel this is sufficient.
Otherwise you can add warning explaining the "include": [] solution when 'RangeError' is caught in 'findSourceFile' and 'references' is found in 'tsconfig.json'. Or submit a upstream TypeScript issue if this is a TS problem.

Edit: If you add "include": [] the extension works but the build fails. From npm create @quick-start/electron@latest the correct config is:

tsconfig.json

{
  "files": [],
  "references": [{ "path": "./tsconfig.node.json" }, { "path": "./tsconfig.web.json" }]
}

tsconfig.node.json

{
  "extends": "@electron-toolkit/tsconfig/tsconfig.node.json",
  "include": ["electron.vite.config.*", "src/main/**/*", "src/preload/**/*"],
  "compilerOptions": {
    "composite": true,
    "types": ["electron-vite/node"]
  }
}

tsconfig.web.json

{
  "extends": "@electron-toolkit/tsconfig/tsconfig.web.json",
  "include": [
    "src/renderer/src/env.d.ts",
    "src/renderer/src/**/*",
    "src/renderer/src/**/*.svelte",
    "src/preload/*.d.ts"
  ],
  "compilerOptions": {
    "verbatimModuleSyntax": true,
    "useDefineForClassFields": true,
    "strict": false,
    "allowJs": true,
    "checkJs": true,
    "lib": ["ESNext", "DOM", "DOM.Iterable"]
  }
}

I think the issue is if you have shared files between node and web?

[Alb11747]

I found a fix. Required args are "files": [] and remove "include" in 'tsconfig.json'.
I'm not sure why "files": [] is needed?

[jasonlyu123]

Oh. Yeah. It's usually "files": [] instead of "include": []. This is a pattern that is used to group multiple tsconfig.json "projects". This tsconfig.json isn't meant to load any files under it. That's why "files" is an empty array. It is instead meant to be a placeholder for the project reference to load other tsconfig.json. This solution-style tsconfig is usually used for mono-repo or used to load a tsconfig.json that isn't named "tsconfig.json". In your case, it's the latter, and it's the answer to what you asked for as a fix.

I think a fix could be to add a vscode settings that allow the user to supply the path to the desired tsconfig