IDE
code-inspector-plugin 会扫描系统当前运行中的进程,自动识别用户所使用的 IDE,所以多数情况下你无需手动指定 IDE。
指定 IDE
如果 code-inspector-plugin 自动识别失败,或者你同时运行了多个 IDE 想指定打开的 IDE,你有两种方式指定 IDE:通过 .env.local 文件指定或者在 codeInspectorPlugin 中添加 editor 参数。
TIP
如果项目团队成员使用不同的 IDE,使用 editor 参数指定可能会彼此冲突,所以更推荐使用 .env.local 文件指定
.env.local 文件指定
在项目根目录添加一个名为 .env.local 的文件并添加: CODE_EDITOR=[IDE编码名称]。以 vscode 为例,它对应的 IDE编码名称 是 code,则对应在 .env.local 中添加如下内容:
# 指定 IDE 为 vscode
CODE_EDITOR=codeeditor 参数指定
你也可以通过在 codeInspectorPlugin 中添加 editor 参数指定 IDE:
codeInspectorPlugin({
bundler: 'vite',
editor: 'code', // 指定 IDE 为 vscode
})支持的 IDE 列表
支持自动识别的 IDE、对应的 IDE 编码名称及支持的系统如下表所示:
| IDE | IDE 编码名称 | MacOS | Windows | Linux |
|---|---|---|---|---|
| Visual Studio Code | code | ✅ | ✅ | ✅ |
| Cursor | cursor | ✅ | ✅ | |
| Windsurf | windsurf | ✅ | ✅ | |
| Trae | trae | ✅ | ✅ | |
| 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 | ✅ |
其他 IDE
如果你使用的 IDE 不在上述支持自动识别的 IDE 列表内,可能导致识别失败。你需要在项目根目录添加一个名为 .env.local 的文件并添加: CODE_EDITOR=[IDE可执行程序路径],IDE可执行程序路径参考如下。
MAC 系统
以 VSCodium 为例(其他的 IDE 步骤相同),要在 MAC 系统中获取 IDE 可执行程序路径,步骤如下:
打开 IDE 程序 VSCodium
打开 MAC 自带的活动监视器,在进程中找到 VSCodium 并双击:
双击后,在窗口的【打开文件和端口】Tab 中,找到第一个 txt 下面对应的路径,即为 IDE 可执行程序路径:
将 IDE 可执行路径程序复制到
.env.local文件中即可:
# .env.local
CODE_EDITOR=/Applications/VSCodium.app/Contents/MacOS/ElectronWindows 系统
以 Webstorm 为例(其他的 IDE 步骤相同),要在 Windows 系统中获取 IDE 可执行程序路径,步骤如下:
找到 IDE 的快捷方式(如果没有则创建一个),右键点击快捷方式,选择【属性】:
打开后,在【快捷】Tab 找到【目标】,去掉【目标】中的双引号即为 IDE 可执行路径:
将 IDE 可执行路径程序复制到
.env.local文件中即可:
# .env.local
CODE_EDITOR=D:\webstorm\WebStorm 2023.1.3\bin\webstorm64.exe