VSCode 插件開發

假期學習了一下 VSCode 插件開發,這裏寥作筆記。git

項目結構

microsoft/vscode-extension-samples 這個倉庫提供了許多示例代碼,我先選擇了最簡單的 helloworld-minimal-sample,一個簡單的插件其實就兩個文件:github

  • extension.js
  • package.json

package.json 是插件的 Manifest 文件,其中 main 字段指定了插件的入口文件,即 extension.js,此外,package.json 同時也是 npm 包管理文件。package.json 其餘的字段能夠參考 Extension Manifestnpm

extension.js 主要導出以下兩個函數:json

  • function activate(context) {}
  • function deactivate() {}

分別在插件被激活和掛起時調用。api

運行項目

參考 Your First Extension,在執行 npm i 後,點擊 VSCode 左邊欄的調試按鈕,點擊 Run Extension,VSCode 會調起一個新的 VSCode 實例,這個 VSCode 實例就安裝了 helloworld-minimal-sample 插件了。運行命令 Hello World,就能夠看到右下角出現 Hello World 小彈窗,表示插件已經被調用。函數

打包插件

因爲暫時沒有發佈插件的打算,這裏簡單嘗試了一下使用 vsce 打包插件。首先使用 npm 全局安裝 vsce,而後在插件項目裏執行 vsce package,就看到生成了 helloworld-minimal-sample-0.0.1.vsix 文件,而後在 VSCode 裏選擇 Install from VSIX 安裝。學習

這樣本身寫的插件就安裝完畢。插件

相關文章
相關標籤/搜索