VSCode插件開發全攻略之package.json詳解

package.json
在詳細介紹vscode插件開發細節之前，這裡我們先詳細介紹一下vscode插件的 package.json 寫法，但是建議先只需要隨便看一下，瞭解個大概，等後面講到具體細節的時候再回過頭來看。
如下是 package.json 文件的常用配置，當然這裡還不是全部：
{ // 插件的名字，應全部小寫，不能有空格 "name": "vscode-plugin-demo", // 插件的友好顯示名稱，用於顯示在應用市場，支持中文 "displayName": "VSCode插件demo", // 描述 "description": "VSCode插件demo集錦", // 關鍵字，用於應用市場搜索 "keywords": ["vscode", "plugin", "demo"], // 版本號 "version": "1.0.0", // 發佈者，如果要發佈到應用市場的話，這個名字必須與發佈者一致 "publisher": "sxei", // 表示插件最低支持的vscode版本 "engines": { "vscode": "^1.27.0" }, // 插件應用市場分類，可選值： [Programming Languages, Snippets, Linters, Themes, Debuggers, Formatters, Keymaps, SCM Providers, Other, Extension Packs, Language Packs] "categories": [ "Other" ], // 插件圖標，至少128x128像素 "icon": "images/icon.png", // 擴展的激活事件數組，可以被哪些事件激活擴展，後文有詳細介紹 "activationEvents": [ "onCommand:extension.sayHello" ], // 插件的主入口 "main": "./src/extension", // 貢獻點，整個插件最重要最多的配置項 "contributes": { // 插件配置項 "configuration": { "type": "object", // 配置項標題，會顯示在vscode的設置頁 "title": "vscode-plugin-demo", "properties": { // 這裡我隨便寫了2個設置，配置你的暱稱 "vscodePluginDemo.yourName": { "type": "string", "default": "guest", "description": "你的名字" }, // 是否在啟動時顯示提示 "vscodePluginDemo.showTip": { "type": "boolean", "default": true, "description": "是否在每次啟動時顯示歡迎提示！" } } }, // 命令 "commands": [ { "command": "extension.sayHello", "title": "Hello World" } ], // 快捷鍵綁定 "keybindings": [ { "command": "extension.sayHello", "key": "ctrl+f10", "mac": "cmd+f10", "when": "editorTextFocus" } ], // 菜單 "menus": { // 編輯器右鍵菜單 "editor/context": [ { // 表示只有編輯器具有焦點時才會在菜單中出現 "when": "editorFocus", "command": "extension.sayHello", // navigation是一個永遠置頂的分組，後面的@6是人工進行組內排序 "group": "navigation@6" }, { "when": "editorFocus", "command": "extension.demo.getCurrentFilePath", "group": "navigation@5" }, { // 只有編輯器具有焦點，並且打開的是JS文件才會出現 "when": "editorFocus && resourceLangId == javascript", "command": "extension.demo.testMenuShow", "group": "z_commands" }, { "command": "extension.demo.openWebview", "group": "navigation" } ], // 編輯器右上角圖標，不配置圖片就顯示文字 "editor/title": [ { "when": "editorFocus && resourceLangId == javascript", "command": "extension.demo.testMenuShow", "group": "navigation" } ], // 編輯器標題右鍵菜單 "editor/title/context": [ { "when": "resourceLangId == javascript", "command": "extension.demo.testMenuShow", "group": "navigation" } ], // 資源管理器右鍵菜單 "explorer/context": [ { "command": "extension.demo.getCurrentFilePath", "group": "navigation" }, { "command": "extension.demo.openWebview", "group": "navigation" } ] }, // 代碼片段 "snippets": [ { "language": "javascript", "path": "./snippets/javascript.json" }, { "language": "html", "path": "./snippets/html.json" } ], // 自定義新的activitybar圖標，也就是左側側邊欄大的圖標 "viewsContainers": { "activitybar": [ { "id": "beautifulGirl", "title": "美女", "icon": "images/beautifulGirl.svg" } ] }, // 自定義側邊欄內view的實現 "views": { // 和 viewsContainers 的id對應 "beautifulGirl": [ { "id": "beautifulGirl1", "name": "國內美女" }, { "id": "beautifulGirl2", "name": "國外美女" }, { "id": "beautifulGirl3", "name": "人妖" } ] }, // 圖標主題 "iconThemes": [ { "id": "testIconTheme", "label": "測試圖標主題", "path": "./theme/icon-theme.json" } ] }, // 同 npm scripts "scripts": { "postinstall": "node ./node_modules/vscode/bin/install", "test": "node ./node_modules/vscode/bin/test" }, // 開發依賴 "devDependencies": { "typescript": "^2.6.1", "vscode": "^1.1.6", "eslint": "^4.11.0", "@types/node": "^7.0.43", "@types/mocha": "^2.2.42" }, // 後面這幾個應該不用介紹了 "license": "SEE LICENSE IN LICENSE.txt", "bugs": { "url": "https://github.com/sxei/vscode-plugin-demo/issues" }, "repository": { "type": "git", "url": "https://github.com/sxei/vscode-plugin-demo" }, // 主頁 "homepage": "https://github.com/sxei/vscode-plugin-demo/blob/master/README.md" }
activationEvents
插件在 VS Code 中默認是沒有被激活的，哪什麼時候才被激活呢？就是通過 activationEvents 來配置，目前支持一下8種配置：
onLanguage:${language}
onCommand:${command}
onDebug
workspaceContains:${toplevelfilename}
onFileSystem:${scheme}
onView:${viewId}
onUri
*
都比較好懂，我就不做一一介紹了，舉個例子，如果我配置了 onLanguage:javascript ，那麼只要我打開了JS類型的文件，插件就會被激活。
重點說一下 * ，如果配置了 * ，只要一啟動vscode，插件就會被激活，為了出色的用戶體驗，官方不推薦這麼做。看到這裡相信大家知道了我們前面HelloWord裡面為啥要配置 onCommand 了吧。
3.contributes
configuration：設置
commands：命令
menus：菜單
keybindings：快捷鍵綁定
languages：新語言支持
debuggers：調試
breakpoints：斷點
grammars
themes：主題
snippets：代碼片段
jsonValidation：自定義JSON校驗
views：左側側邊欄視圖
viewsContainers：自定義activitybar
problemMatchers
problemPatterns
taskDefinitions
colors