Skip to content

Adds WebStorm documentation #5736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
arcanis wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Adds WebStorm documentation #5736

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89d9e4e
Adds WebStorm documentation
arcanis Sep 13, 2023
a30da57
Update editor-sdks.md
arcanis Sep 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions packages/docusaurus/docs/getting-started/extra/editor-sdks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,3 +113,23 @@ yarn dlx @yarnpkg/sdks vscode
3. Pick "Use Workspace Version"

Your VSCode project is now configured to use the exact same version of TypeScript as the one you usually use, except that it will be able to properly resolve the type definitions.

### WebStorm / IntelliJ

Most of the configuration should be automatically picked by WebStorm. However, a bug in the IDE may cause issue with Yarn PnP when the TypeScript version is 5.x or higher. The following is a workaround until [WEB-62221](https://youtrack.jetbrains.com/issue/WEB-62221/TypeScript-service-doesnt-work-with-yarn-pnp-when-typescript-version-is-5.x-or-higher) is fixed (the WebStorm teams are aware and signaled working on it).
Copy link
Member

@RDIL RDIL Oct 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Most of the configuration should be automatically picked by WebStorm. However, a bug in the IDE may cause issue with Yarn PnP when the TypeScript version is 5.x or higher. The following is a workaround until [WEB-62221](https://youtrack.jetbrains.com/issue/WEB-62221/TypeScript-service-doesnt-work-with-yarn-pnp-when-typescript-version-is-5.x-or-higher) is fixed (the WebStorm teams are aware and signaled working on it).
Most of the configuration should be automatically picked by WebStorm. However, a bug in the IDE may cause issue with Yarn PnP when the TypeScript version is 5.x or higher. The following is a workaround until [WEB-62221](https://youtrack.jetbrains.com/issue/WEB-62221/TypeScript-service-doesnt-work-with-yarn-pnp-when-typescript-version-is-5.x-or-higher) is fixed (the WebStorm team is aware and has signaled they are working on it).

Just grammar tweaks


1. Run the following command:

```bash
yarn dlx @yarnpkg/sdks base
```

2. In Settings, go to `Preferences | Languages & Frameworks | TypeScript`

3. Change the TypeScript path to point to the `.yarn/sdks/typescript` directory in the root of your project

4. Also make sure "Show project errors" is enabled

:::warning
Some problems with module resolution have also been reported around the use of the `workspace:` protocol ([WEB-59218](https://youtrack.jetbrains.com/issue/WEB-59218/Modules-referenced-using-workspace-protocol-not-resolved-in-Yarn-PnP-workspaces)).
:::