Code InspectorIDE
code-inspector-plugin scans currently running processes in the system and automatically recognizes the IDE being used, so in most cases, you don't need to manually specify the IDE.
Specifying IDE
If code-inspector-plugin fails to automatically recognize your IDE, or if you're running multiple IDEs and want to specify which one to open, you have two ways to specify the IDE: through the .env.local file or by adding the editor parameter in codeInspectorPlugin.
TIP
If project team members use different IDEs, using the editor parameter might cause conflicts between them, so using .env.local file is more recommended
Specifying via .env.local file
Add a file named .env.local in the project root directory and add: CODE_EDITOR=[IDE code name]. For example, for vscode, its corresponding IDE code name is code, so add the following to .env.local:
# Specify IDE as vscode
CODE_EDITOR=codeSpecifying via editor parameter
You can also specify the IDE by adding the editor parameter in codeInspectorPlugin:
codeInspectorPlugin({
bundler: 'vite',
editor: 'code', // Specify IDE as vscode
})Supported IDE List
The following table shows the IDEs that support automatic detection, their corresponding IDE code names, and supported systems:
| IDE | IDE Code Name | MacOS | Windows | Linux |
|---|---|---|---|---|
| Visual Studio Code | code | ✅ | ✅ | ✅ |
| Cursor | cursor | ✅ | ✅ | |
| Windsurf | windsurf | ✅ | ✅ | |
| Visual Studio Code - Insiders | code-insiders | ✅ | ✅ | ✅ |
| VSCodium | codium | ✅ | ✅ | ✅ |
| WebStorm | webstorm | ✅ | ✅ | ✅ |
| Atom | atom | ✅ | ✅ | ✅ |
| HBuilderX | hbuilder | ✅ | ✅ | |
| PhpStorm | phpstorm | ✅ | ✅ | ✅ |
| Pycharm | pycharm | ✅ | ✅ | ✅ |
| IntelliJ IDEA | idea | ✅ | ✅ | ✅ |
| Brackets | brackets | ✅ | ✅ | ✅ |
| Appcode | appcode | ✅ | ||
| Atom Beta | atom-beta | ✅ | ||
| Clion | clion | ✅ | ✅ | |
| Rider | rider | ✅ | ✅ | ✅ |
| Rubymine | rubymine | ✅ | ✅ | ✅ |
| Emacs | emacs | ✅ | ||
| Sublime Text | sublime | ✅ | ✅ | ✅ |
| Notepad++ | notepad | ✅ | ||
| Vim | vim | ✅ |
Other IDEs
If your IDE is not in the above list of automatically supported IDEs, detection may fail. You'll need to add a file named .env.local in the project root directory and add: CODE_EDITOR=[IDE executable path]. Here's how to find the IDE executable path.
MAC System
Taking VSCodium as an example (steps are the same for other IDEs), to get the IDE executable path on MAC system:
Open the IDE program VSCodium
Open MAC's Activity Monitor, find VSCodium in the processes and double-click:
After double-clicking, in the "Open Files and Ports" tab of the window, find the path corresponding to the first txt, which is the IDE executable path:
Copy the IDE executable path to the
.env.localfile:
# .env.local
CODE_EDITOR=/Applications/VSCodium.app/Contents/MacOS/ElectronWindows System
Taking Webstorm as an example (steps are the same for other IDEs), to get the IDE executable path on Windows system:
Find the IDE shortcut (create one if it doesn't exist), right-click the shortcut, select "Properties":
After opening, in the "Shortcut" tab find "Target", remove the quotation marks from the "Target" to get the IDE executable path:
Copy the IDE executable path to the
.env.localfile:
# .env.local
CODE_EDITOR=D:\webstorm\WebStorm 2023.1.3\bin\webstorm64.exe