Packagerun:VSCode 扩展 快捷执行命令
Packagerun:VSCode 快捷命令扩展(兼容cursor)
Packagerun 是一个为 前端和node开发者设计的 VSCode 扩展,旨在简化 package.json
中脚本的执行,并支持自定义命令以提升开发效率。通过右键菜单、快捷键或自定义配置,你可以快速运行项目脚本,告别繁琐的 npm run xxx
命令。当然,你也可以自定义命令,不止限于npm
功能概述
- 快速运行脚本:直接从
package.json
中选择并执行 scripts。 - 自定义命令:支持全局或项目级别的自定义命令配置。
- 智能路径检测:自动查找最近的
package.json
,无需手动指定路径。 - 跨平台支持:兼容 Windows 和 Mac,快捷键操作简单。
提示:目前 Packagerun 依赖
package.json
,未来可能支持更多项目类型。欢迎到 GitHub 提交需求或点个 Star 支持我们!😁
安装
- 打开 VSCode,进入 扩展 面板(快捷键
Ctrl+Shift+X
/Cmd+Shift+X
)。 - 搜索 Packagerun,点击 安装。
- 安装完成后,无需额外配置即可使用。
使用方法
1. 右键运行
- 在 VSCode 资源管理器中,找到你的
package.json
文件。 - 右键点击,选择 Packagerun 菜单。
- 从弹出的列表中选择需要运行的脚本。
2. 快捷键触发
- 在项目中打开任意文件,使用以下快捷键:
- Windows:
Ctrl + Alt + X
- Mac:
Ctrl + Cmd + X
- Windows:
- Packagerun 会自动查找最近的
package.json
并显示可运行的脚本列表。 - 选择脚本后,命令将在
package.json
所在目录执行。
3. 自定义命令
你可以通过全局设置或项目配置文件添加自定义命令,满足特定需求。
配置
全局配置
在 VSCode 的 settings.json
中添加 packagerun.commandOptions
配置,适用于所有项目:
"packagerun.commandOptions": [{"label": "运行示例脚本","script": "node example.js","path": "D:/projects/example/" // 可选,指定执行目录// 若未指定 path 或设为 "package",则在最近的 package.json 目录执行}
]
访问设置:
- 打开 VSCode 设置(
Ctrl+,
/Cmd+,
)。 - 搜索
packagerun
。 - 编辑
packagerun.commandOptions
字段。
项目级配置
在 package.json
同级目录下创建 packagerun.config.json
文件,仅对当前项目生效:
{"commandOptions": [{"label": "安装依赖","script": "npm i","path": "package" // 在 package.json 所在目录执行}]
}
配置字段说明
字段 | 说明 |
---|---|
label | 命令的显示名称,必须唯一,用于在菜单中标识命令。 |
script | 要执行的命令,例如 npm i 或 node xxx.js 。 |
path | 可选,指定命令执行的目录。设为 "package" 或省略时,使用 package.json 所在目录。 |
警告
重要:请确保每个命令的
label
在全局和项目配置中保持唯一,否则可能导致命令冲突。
示例场景
场景 1:快速运行开发服务器
假设你的 package.json
包含以下脚本:
{"scripts": {"dev": "vite"}
}
- 右键
package.json
或使用快捷键Ctrl + Alt + X
。 - 选择
dev
,即可启动开发服务器。
场景 2:自定义命令
你需要在项目中频繁运行 node scripts/build.js
,可以添加以下配置到 packagerun.config.json
:
{"commandOptions": [{"label": "构建项目","script": "node scripts/build.js","path": "package"}]
}
之后,通过快捷键或右键菜单即可快速运行该命令。
常见问题
Q:为什么快捷键没有反应?
A:确保你已打开项目中的文件,且项目中存在 package.json
。检查快捷键是否被其他扩展占用(在 VSCode 设置中搜索 keyboard shortcuts
)。
Q:如何在非 Node.js 项目中使用?
A:目前 Packagerun 依赖 package.json
,但你可以通过自定义命令运行任意脚本。欢迎到 GitHub 提交需求以支持更多场景。
贡献与支持
Packagerun 是一个开源项目,我们欢迎你的反馈和贡献!
- 提交建议:访问 GitHub Issues 提交功能需求或 bug 报告。
- 支持项目:点个 Star 鼓励我们开发更多功能!😁
- 参与开发:欢迎提交 Pull Request,共同完善 Packagerun。
感谢使用 Packagerun!希望它能为你的开发工作带来便利!🚀