[GH-ISSUE #3355] CloudBeaver TypeScript Path Resolution Problem #1238

Closed
opened 2026-03-07 21:01:31 +03:00 by kerem · 4 comments
Owner

Originally created by @vivianma83 on GitHub (Apr 2, 2025).
Original GitHub issue: https://github.com/dbeaver/cloudbeaver/issues/3355

Originally assigned to: @SychevAndrey on GitHub.

Please, describe your question in details.

I'm trying to set up the CloudBeaver project in VS Code for local development. I installed the dependencies using yarn install, and opened the root directory. However, in the webapp package, all imports like @cloudbeaver/core-app-settings show red squiggly lines in VS Code (cannot find module).

Image

I suspect it's related to the monorepo structure and TypeScript path aliases. I tried adding a tsconfig.json in the root directory like this:

{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@cloudbeaver/*": ["packages/*/src"]
    }
  }
}

But the issue still persists. Could you please clarify:

Is there an official tsconfig.json setup that works with VS Code?

How do you recommend setting up the editor for local development and type resolution?

Originally created by @vivianma83 on GitHub (Apr 2, 2025). Original GitHub issue: https://github.com/dbeaver/cloudbeaver/issues/3355 Originally assigned to: @SychevAndrey on GitHub. Please, describe your question in details. I'm trying to set up the CloudBeaver project in VS Code for local development. I installed the dependencies using `yarn install`, and opened the root directory. However, in the `webapp` package, all imports like `@cloudbeaver/core-app-settings` show red squiggly lines in VS Code (cannot find module). <img width="1109" alt="Image" src="https://github.com/user-attachments/assets/85c96360-52db-46c5-b065-45f8245cc561" /> I suspect it's related to the monorepo structure and TypeScript path aliases. I tried adding a `tsconfig.json` in the root directory like this: ``` { "compilerOptions": { "baseUrl": ".", "paths": { "@cloudbeaver/*": ["packages/*/src"] } } } ``` But the issue still persists. Could you please clarify: Is there an official tsconfig.json setup that works with VS Code? How do you recommend setting up the editor for local development and type resolution?
kerem 2026-03-07 21:01:31 +03:00
Author
Owner

@LonwoLonwo commented on GitHub (Apr 3, 2025):

Thanks for the report. We will look at it.

<!-- gh-comment-id:2775286873 --> @LonwoLonwo commented on GitHub (Apr 3, 2025): Thanks for the report. We will look at it.
Author
Owner

@SychevAndrey commented on GitHub (Apr 7, 2025):

HI @vivianma83 !

The issue is related to how VSCode handles package references in projects using Yarn PnP (Plug'n'Play).

How to fix:

  1. Install the official ZipFS extension for Yarn PnP support:
    vscode-file://vscode-app/Applications/Visual%20Studio%20Code.app/Contents/Resources/app/out/vs/code/electron-sandbox/workbench/workbench.html

  2. Configure TypeScript to work with PnP:
    yarn dlx @yarnpkg/sdks vscode
    This command will create the correct settings for TypeScript in VSCode with PnP support.

  3. Switch TypeScript version:
    After installing extensions, press Ctrl+Shift+P (or Cmd+Shift+P on Mac)
    Type "TypeScript: Select TypeScript Version"
    Select "Use Workspace Version"

  4. Check VS Code settings: Your settings.json should have settings like:
    "typescript.tsdk": "webapp/.yarn/sdks/typescript/lib",

  5. Restart VS Code after all changes.

Please let me know if this solution worked for you.

<!-- gh-comment-id:2782308544 --> @SychevAndrey commented on GitHub (Apr 7, 2025): HI @vivianma83 ! The issue is related to how VSCode handles package references in projects using Yarn PnP (Plug'n'Play). ### How to fix: 1. **Install the official ZipFS extension for Yarn PnP support:** vscode-file://vscode-app/Applications/Visual%20Studio%20Code.app/Contents/Resources/app/out/vs/code/electron-sandbox/workbench/workbench.html 2. **Configure TypeScript to work with PnP:** `yarn dlx @yarnpkg/sdks vscode` _This command will create the correct settings for TypeScript in VSCode with PnP support._ 3. **Switch TypeScript version:** After installing extensions, press `Ctrl+Shift+P `(or `Cmd+Shift+P` on Mac) Type "TypeScript: Select TypeScript Version" Select "Use Workspace Version" 4. **Check VS Code settings: Your settings.json should have settings like:** `"typescript.tsdk": "webapp/.yarn/sdks/typescript/lib",` 5. **Restart VS Code after all changes.** Please let me know if this solution worked for you.
Author
Owner

@SychevAndrey commented on GitHub (Apr 7, 2025):

We plan to add these files to git in a future release, so you won't have to set them up manually.

<!-- gh-comment-id:2782830567 --> @SychevAndrey commented on GitHub (Apr 7, 2025): We plan to add these files to git in a future release, so you won't have to set them up manually.
Author
Owner

@LonwoLonwo commented on GitHub (Apr 7, 2025):

Changes are available in devel already.

<!-- gh-comment-id:2783369136 --> @LonwoLonwo commented on GitHub (Apr 7, 2025): Changes are available in devel already.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/cloudbeaver#1238
No description provided.