VSCode插件快速生成各类插件架构代码

陌辰小哥_8585

陌辰小哥_8585

2026-08-14

845人浏览

原创

先安装node.js和npm,再执行npm install -g yo generator-code全局安装yeoman及vs code生成器;接着运行yo code,选择“new extension (typescript)”,按提示输入名称、标识符、描述等信息,即可自动生成含package.json、extension.ts等文件的完整项目骨架。

vscode插件快速生成各类插件架构代码

怎么用 Yeoman 快速生成 VSCode 插件骨架

VSCode 官方推荐的插件初始化方式就是 yo code,它比手动建文件、写 package.json、配入口点更可靠,也天然兼容 TypeScript 和最新 API。

常见错误现象:自己手搭项目时漏掉 activationEvents 导致插件不激活;或 main 指向错误路径,启动时报 Cannot find module './extension'。

  • 确保已安装 Node.js(≥18.17.0)和 npm
  • 全局安装:npm install -g yo generator-code
  • 运行 yo code,选 New Extension (TypeScript),填名称(如 my-prompt-helper)、描述、作者等
  • 生成后直接 npm install + npm run compile,再按 F5 启动调试环境

注意:生成器默认启用 vscode-languageclient 和 vscode-test,如果只是做简单命令/片段类插件,可以删掉相关依赖和测试代码,避免构建慢、打包体积大。

如何让插件支持代码片段(Snippets)注入

不是所有插件都需要注册语言服务器;如果目标只是往编辑器里塞模板,用 contributes.snippets 声明比写 registerCompletionItemProvider 简单得多,也更稳定。

使用场景:给 Vue、TS、Markdown 等语言批量添加常用结构,比如 v3 生成 <script setup lang="ts"></script> 模板。

  • 在 package.json 的 contributes 字段下加 snippets 数组,每个项指定 language 和 path
  • 片段文件必须是 .json 格式,放在插件根目录(如 snippets/vue.json),不能嵌套子目录
  • prefix 区分大小写,且不能与已存在片段冲突(比如 Volar 已占 vue,你就得用 v3setup)
  • 支持 $1、$2 光标跳转,但不支持动态变量(如 $CURRENT_YEAR)——那是用户代码片段才有的能力

容易踩的坑:路径写错导致 snippets 不加载;language 值必须是 VSCode 内置语言 ID(查 vscode.languages.getLanguages() 或官方文档),写 "vue" 没用,得写 "vue"(实际有效)或 "html"(对 .vue 模板区生效)。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载

为什么 registerCommand 比快捷键绑定更可控

直接在 keybindings 里绑 Ctrl+Shift+P 触发的命令,不如在插件里用 vscode.commands.registerCommand 显式注册——前者依赖用户手动配,后者能统一管理、带参数、可条件启用。

性能影响:大量 registerCommand 不会拖慢启动,但每个命令的回调函数里别做同步耗时操作(如读大文件、正则遍历整个文档),否则会卡 UI。

  • 注册时用唯一 ID,如 my-extension.insertVueTemplate,避免和其他插件冲突
  • 回调函数接收 vscode.Uri(当前活动文件)和可选参数,可用于判断是否在 .vue 文件中执行
  • 配合 when 条件(如 editorTextFocus && editorLangId == 'vue')在 package.json 中声明,比代码里 if 判断更轻量
  • 命令名不要含空格或特殊字符,否则 CLI 调用或 API 调用会失败

真实案例:有人把命令 ID 写成 insert vue template,结果调用 vscode.commands.executeCommand('insert vue template') 报错,必须改成 insert-vue-template 才行。

插件发布前必须检查的三个配置点

很多插件本地跑得好,一发布就失效,问题往往出在 package.json 的元数据或导出配置上,不是代码逻辑问题。

  • engines.vscode 必须明确指定最低版本,比如 =1.85.0";写 * 或留空会导致旧版用户安装失败且无提示
  • main 和 browser 字段不能同时存在,Web 版插件才需要 browser,桌面端只认 main,且路径必须相对于包根目录(如 ./out/extension.js)
  • activationEvents 如果用了 *,会被 Marketplace 拒绝;应精确到 onCommand:xxx、onLanguage:vue 或 onStartupFinished(慎用)

最容易被忽略的是 publisher 字段——它必须和你在 Marketplace 后台注册的 publisher ID 完全一致,大小写都不能错,否则上传时提示 “Publisher not found”。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1215

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

2512

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1869

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1707

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2567

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1798

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1222

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1096

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

434

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程