vscode插件开发(1)

这期从最简单的hello world(其实就是实例代码)开始
vscode插件开发现在有非常方便的脚手架工具,直奔主题地:
npm install -g yo generator-code
安装这两个依赖,然后使用官方的脚手架工具
yo code
会自动生成一个带hello world的demo插件工程。直接f5就可以运行了。vscode会打开一个新的窗口专门给这个插件调试用,ctrl+shift+p之后可以输入指令hello world,就会弹出一个hello world的提示。

![MHTM{$GLF6EASMRY)3O9A}K.png](https://upload-images.jianshu.io/upload_images/24121227-a019be2a9d94e12e.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

那么这个项目的代码和vscode干了什么呢?首先看vscode看了什么:
f5之后vscode会生成.vscode文件夹,会有extensions.json launch.json settings.json tasks.json四个文件。这些文件会规定vscode在f5的时候干些什么,总的来说就是干两件事:
第一件是运行yarn run compile,这会在根目录下生成一个out/的文件夹,其中是项目的编译结果
另一个就是打开一个新的专门给插件用的vscode窗口,并且在这个窗口中启用项目的插件

再看代码本身:代码逻辑在src/extension.ts中:

export function activate(context: vscode.ExtensionContext) {

    // Use the console to output diagnostic information (console.log) and errors (console.error)
    // This line of code will only be executed once when your extension is activated
    console.log('Congratulations, your extension "my-plugin" is now active!');

    // The command has been defined in the package.json file
    // Now provide the implementation of the command with registerCommand
    // The commandId parameter must match the command field in package.json
    let disposable = vscode.commands.registerCommand('my-plugin.helloWorld', () => {
        // The code you place here will be executed every time your command is executed

        // Display a message box to the user
        vscode.window.showInformationMessage('Hello World from my-pluginmmm!');
    });

    context.subscriptions.push(disposable);
}

具体的api暂且不说,可以直观地看到是注册了一个指令叫'my-plugin.helloWorld',当输入这个指令时会弹出一个提示。那么这个指令的名字是怎么和“hello world”对应的呢?这就是在package.json中可以看到的设置:

    "activationEvents": [
        "onCommand:my-plugin.helloWorld"
    ],
    "main": "./out/extension.js",
    "contributes": {
        "commands": [
            {
                "command": "my-plugin.helloWorld",
                "title": "Hello World"
            }
        ]
    },

可以看到activationEvents中规定了一个事件:onCommand:my-plugin.helloWorld。onCommand表示命令激活,也就是从ctrl shift p进入的时候激活的(当然还有别的激活方式)。下面则有对命令的具体定义,可以看到my-plugin.helloWorld有一个title Hello World也就是在指令菜单中实际输入/看到的那个名字。输入Hello World会触发my-plugin.helloWorld指令,而这个指令的事件则定义在extension.ts中,可以看到这样整个逻辑就捋通了。

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