实现一个简单的hello world vs-code插件

开发 VS Code 插件可以让你扩展编辑器的功能,从简单的代码片段到复杂的语言支持都可以实现。

一、环境准备

  1. 安装工具

    • 安装 Node.js(v14+,需要 npm 或 yarn)

    • 安装 VS Code

    • 安装 Yeoman 和 VS Code 插件生成器:

      bash 复制代码
      npm install -g yo generator-code
  2. 创建插件项目 运行 yo code,选择插件类型(如 New Extension (JavaScript) 或 TypeScript),填写项目信息(名称、描述、标识符等),生成基础项目结构。

二、核心项目结构

生成的项目包含以下关键文件:

bash 复制代码
your-extension/
├── src/
│   └── extension.js      # 插件入口逻辑
├── package.json          # 插件配置(核心文件)
├── README.md             # 插件说明
└── .vscode/              # 调试配置
  • package.json:定义插件的激活事件、贡献点(命令、菜单等)、依赖等,是插件的「身份证」。
  • extension.js :实现插件功能的代码,入口为 activate 函数(插件激活时执行)和 deactivate 函数(插件销毁时执行)。

三、开发Hello World 功能

  1. 配置 package.json :在 contributes.commands 中注册命令,在 activationEvents 中定义激活事件(如命令被调用时激活):
json 复制代码
{
  "activationEvents": ["onCommand:your-extension.helloWorld"],
  "contributes": {
    "commands": [
      {
        "command": "your-extension.helloWorld",
        "title": "Hello World"
      }
    ]
  }
}
  1. 实现功能(extension.js) :在 activate 函数中注册命令的回调:
js 复制代码
const vscode = require('vscode');

function activate(context) {
  // 注册命令
  let disposable = vscode.commands.registerCommand('your-extension.helloWorld', () => {
    // 显示弹窗
    vscode.window.showInformationMessage('Hello VS Code Extension!');
  });

  context.subscriptions.push(disposable);
}

function deactivate() {}

module.exports = { activate, deactivate };

四、调试插件

  1. 按 F5 启动「扩展开发宿主」窗口(一个新的 VS Code 窗口)。
  2. 在新窗口中按 Ctrl+Shift+P(或 Cmd+Shift+P)打开命令面板,输入并运行 Hello World 命令,即可看到弹窗。

五、核心概念

  1. 激活事件(Activation Events) 定义插件何时被激活(避免不必要的性能消耗),常见类型:

    • onCommand:命令名:命令被调用时
    • onStartupFinished:VS Code 启动完成后
    • onLanguage:语言名:打开特定语言文件时(如 onLanguage:javascript)
  2. 贡献点(Contribution Points) 定义插件对 VS Code 的扩展点,常见类型:

    • commands:注册命令
    • keybindings:绑定快捷键
    • menus:添加右键菜单或顶部菜单
    • snippets:添加代码片段
    • themes:自定义主题
  3. API 调用 VS Code 提供了丰富的 API,例如:

    • vscode.window:操作窗口(弹窗、状态栏等)
    • vscode.workspace:操作工作区(文件、配置等)
    • vscode.editor:操作编辑器(文本编辑、选中内容等)

六、打包与发布

  1. 打包成 VSIX:安装打包工具:

    bash 复制代码
    npm install -g @vscode/vsce

    在项目根目录运行:

    bash 复制代码
    vsce package

    生成 your-extension-x.x.x.vsix 文件,可手动安装到 VS Code。

  2. 发布到市场 注册 Azure DevOps 账号,获取个人访问令牌(PAT),然后通过 vsce publish 发布到 VS Code 市场。

相关推荐
开开心心_Every2 小时前
免费压缩软件WinRAR无弹窗、广告干扰
java·开发语言·前端·spring·智能手机·word·winrar
特立独行的猫A2 小时前
用仓颉语言写桌面应用:cj-tauri 框架与 AI 笔记软件 cjnote 实战
前端
特立独行的猫A2 小时前
我为什么推荐用仓颉语言的cj-tauri 写桌面应用(附 cjnote 最小的markdown笔记AI软件)
前端
纸片人2 小时前
牛一越界,大屏 3 秒飞到它身边:我用真实卫星数据 + Three.js 做了个 3D 智慧牧场
前端
cc_瀚海知行2 小时前
工具调用 6|助手什么时候该停下来?
java·服务器·前端·人工智能·python·ai
溪语流沙2 小时前
【Web全栈进阶】Nginx反向代理 + HTTPS:正式上线
前端·vue.js·python·nginx·https·fastapi
vivo互联网技术2 小时前
域名埋点零侵入实时校验实践:基于代理转发与规则驱动的工具设计
前端·测试·监控·代理·埋点
喵个咪2 小时前
GoWind ShortPlay 拆解:Flutter 沉浸式 Feed 的播放器工程——生命周期、手势状态机与游客降级
前端·flutter·架构
白日做梦Q2 小时前
Chrome商店访问不了,无法现在安装插件?利用Edge商店迁移扩展完整实操教程问题背景
前端·chrome·edge