如何开发一个简单的VSCode扩展

184 阅读1分钟

步骤 1: 准备工作

确保你的计算机上安装了最新版本的 Visual Studio Code

步骤 2: 创建扩展项目

  1. 打开 VSCode,按下 Ctrl+ (Windows/Linux)或 Cmd+ (Mac) 打开终端。

  2. 执行命令npm install -g yo generator-code 安装YeomanVS Code Extension Generator,这是VSCode官方提供的脚手架开发项目工具。

  3. 运行以下命令以创建一个扩展项目:

    yo code
    

    这会启动 Yeoman 生成器,引导你完成创建扩展的过程。选择“New Extension”并按照提示操作。

步骤 3: 编写代码

  1. 进入你新创建的扩展项目目录:

    cd your-extension-name
    
  2. 打开 src/extension.ts 文件,这是你扩展的主要入口点。

  3. activate 方法中添加以下代码,这是扩展启动时运行的代码:

    export function activate(context: vscode.ExtensionContext) {
        // 注册一个命令
        let disposable = vscode.commands.registerCommand('extension.sayHello', () => {
            // 显示信息框
            vscode.window.showInformationMessage('Hello, VSCode Extension!');
        });
    ​
        context.subscriptions.push(disposable);
    }
    

步骤 4: 测试你的扩展

  1. F5 启动扩展调试。
  2. 打开 VSCode 命令面板(Ctrl+Cmd+ ),输入 Hello World,选择 Hello World 命令并执行。

你应该会看到一个信息框显示 "Hello, VSCode Extension!"。

步骤 5: 自定义你的扩展

你可以根据需要在 activate 方法中添加更多的命令和功能。查看 VSCode API 文档 以获取更多信息和示例。

步骤 6: 发布你的扩展

完成开发后,你可以按照 官方文档 的指南将你的扩展发布到 Visual Studio Code Marketplace。

PS:如果有需要补充的内容,请在评论区留言

转载时请注明“来自掘金 - EvenZhu”