0

0

怎样创建一个简单的VSCode扩展来添加一个自定义的命令?

betcha

betcha

发布时间:2025-10-02 09:30:02

|

361人浏览过

|

来源于php中文网

原创

首先创建vscode扩展需准备node.js和yo generator-code,接着用yo code生成typescript项目,修改package.json注册命令,在extension.ts中编写弹窗逻辑,最后按f5测试命令是否正常触发提示信息。

怎样创建一个简单的vscode扩展来添加一个自定义的命令?

创建一个简单的 VSCode 扩展来添加自定义命令并不复杂,只需要几个基本文件和少量代码就能运行起来。下面是一个快速上手的步骤,帮助你从零开始创建一个能弹出消息的自定义命令扩展。

1. 准备开发环境

确保你已经安装了以下工具

  • Node.js(建议 16.x 或更高版本)
  • npm(随 Node.js 自动安装)
  • Visual Studio Code
  • Yeoman 和 VS Code Extension Generator

在终端中运行以下命令来安装生成器:

npm install -g yo generator-code

2. 创建扩展项目

运行 Yeoman 生成器来创建扩展:

yo code

按照提示选择:

  • 扩展类型:选择 "New Extension (TypeScript)"
  • 项目名称:比如 "Hello Command"
  • 其他选项使用默认即可

完成后进入项目目录:

cd hello-command

3. 理解核心文件结构

关键文件包括:

  • package.json:定义扩展元数据和激活事件、命令注册
  • src/extension.ts:主逻辑文件,包含激活函数和命令注册

package.json 中,找到 contributes.commands 字段,这是你在 VSCode 菜单中看到的命令入口。你可以修改它的标题:

智川X-Agent
智川X-Agent

中科闻歌推出的一站式AI智能体开发平台

下载
"contributes": { "commands": [ { "command": "hello-command.helloWorld", "title": "Say Hello" } ] }

4. 编写自定义命令逻辑

打开 src/extension.ts,你会看到默认的 `activate` 函数。它注册了一个命令并绑定回调函数

示例代码(无需修改,默认已存在):

typescript"> import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) { let disposable = vscode.commands.registerCommand('hello-command.helloWorld', () => { vscode.window.showInformationMessage('Hello from your own command!'); });

context.subscriptions.push(disposable); }

这个命令会在用户执行时弹出一条信息提示。

5. 运行和测试扩展

按 F5 启动扩展。VSCode 会打开一个“扩展开发主机”窗口。

在新窗口中:

  • Ctrl+Shift+P 打开命令面板
  • 输入 “Say Hello” 并执行
  • 你应该看到弹出的消息:“Hello from your own command!”

6. 打包与发布(可选)

如果你希望分享或安装这个扩展:

  • 全局安装 vsce 工具:
    npm install -g vsce
  • 打包:
    vsce package
  • 生成 .vsix 文件,可在其他 VSCode 实例中通过 “Install from VSIX” 安装

基本上就这些。你已经成功创建了一个带有自定义命令的简单 VSCode 扩展。后续可以加入更多功能,比如操作编辑器、读取配置、调用 API 等。不复杂但容易忽略细节,比如命令 ID 拼写或未激活扩展。保持代码简洁,逐步迭代就行。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

47

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

192

2026.02.25

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

455

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

546

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

334

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

530

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

576

2023.07.28

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
go语言零基础开发内容管理系统
go语言零基础开发内容管理系统

共34课时 | 2.7万人学习

第二十三期_前端开发
第二十三期_前端开发

共98课时 | 8.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号