如何开发一个VSCode插件

VSCode简介

VSCode是微软开源的一款基于Electron开发的代码编辑器。具有对TypeScript,JavaScript和Node.js的内置支持。同时提供了强大的插件拓展机制,并提供插件市场供开发者发布、下载插件。

VSCode组成

主要由三部分组成:Monaco EditorExtension Host以及Language Server Protocol & Debug Adapter Protocol

Monaco Editor:是一个网页版的编辑器,可以反映出符合LSP协议的插件的语言特性。

Extension Host:VSCode的主进程和插件进程是分开管理的,Extension Host就是用来管理插件进程的。

Language Server Protocol & Debug Adapter Protocol:是现在主流浏览器都会支持的两种协议,负责语言的编译和调试。

VSCode插件的作用

VSCode插件可以对以下几部分进行操作和扩展:主题通用功能工作区程序语言

主题包括色彩主题和图标主题两部分。
通用功能包括配置、快捷键、数据存储等。
工作区包括对活动栏、提示框、状态栏等扩展。
程序语言包括语法高亮、语义高亮、代码库管理等。

VSCode插件基础

插件-主题-色彩

pic1.png

插件-主题-图标

pic2.png

通用功能

通用功能包括:命令、配置、数据存储、显示通知、进度条等。


pic3.png
pic4.png
pic5.png

工作区扩展

工作区是指整个VS Code UI。包括:标题栏、活动栏、侧边栏、面板、编辑器群和状态栏。


pic6.png
pic7.png
pic8.png

程序语言-语言高亮

语言高亮包括语法高亮语义高亮
语法高亮包括两部分:分词主题化
分词:将文本分割为一系列符号(包括单词和标点)。
主题化:根据主题或用户设置,对符号进行着色添加样式。

VSCode插件开发

VSCode插件环境

环境变量 版本
vscode 1.52.1
npm 6.14.8
nodejs 14.9.0

pic9.png

yo脚手架会生成一个基础的VSCode插件项目。运行生成器,然后填好下列字段:

pic10.png

这样生成了最基本的VSCode插件。

VSCode生命周期

从生命周期来看,VSCode有三个部分:Activation Event(定义插件触发时间)、Contribution Point(定义插件功能)和Register(注册监听事件)。

pic11.png

Contribution Point定义的是插件作用的方面,以及实现某些功能,比如插件修改了哪些指令、配置以及视图。
Activation Event定义插件触发的时间点,比如输入某个指令、修改某个文件、打开某个视频。
Contribution Point和Activation Event通常是在package.json中定义。
Register注册监听事情,当监听到某个事件发生的时候,触发相应的操作。位于入口文件(默认是 extension.ts)的activate()函数中。

插件打包发布

使用vsce可以进行插件的打包、发布。(vsce一个用于将插件发布的命令行工具。)


pic12.png

可以使用以下方式将开发的插件发布到插件市场,便于其他人下载使用插件。


pic13.png

如果仅希望指定范围内使用,则无需发布。使用下面指令打包生成vsix文件,通过VSCode安装即可使用。
pic14.png
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 193,968评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,682评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,254评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,074评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,964评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,055评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,484评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,170评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,433评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,512评论 2 308
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,296评论 1 325
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,184评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,545评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,150评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,437评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,630评论 2 335

推荐阅读更多精彩内容