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!希望它能為你的開發工作帶來便利!🚀