VSCode如何使用Yeoman生成插件模板_VSCode Yeoman生成插件模板教程

浅晨同学_4300

浅晨同学_4300

2026-04-04

1015人浏览

原创

yeoman 已弃用,必须用 npm create vscode-extension@latest 创建 vs code 插件;yo code 会失败或生成过时模板,因 vs code 1.80+ 移除支持、api 和工具链已升级,新 cli 提供 typescript、webview、测试等现代配置。

vscode如何使用yeoman生成插件模板_vscode yeoman生成插件模板教程

Yeoman 已不推荐用于新建 VS Code 插件 —— 官方早已弃用 generator-code 的旧流程,现在必须用 vscode-dev-cli(即 npm create vscode-extension@latest)。

为什么 yo code 现在会失败或生成过时模板

VS Code 1.80+ 彻底移除了对 generator-code 的支持;即使你全局装了 yo 和 generator-code,运行 yo code 也会卡在选择语言、报 Cannot find module 'yeoman-environment' 或生成出不含 package.json#engines.vscode、无 TypeScript 配置、无 Webview 示例的老旧结构。

根本原因是:Yeoman 模板长期未更新,而 VS Code 插件 API、打包工具链(如 @vscode/test-electron)、TypeScript 版本和 ESLint 规则已全面升级。

  • yo code 生成的 activationEvents 还是 *,不符合当前性能审查要求
  • 默认不启用 webviewScripts 安全配置,本地资源加载直接被拦截
  • 测试脚本仍依赖已废弃的 vscode npm 包(非 @vscode/test-electron)

正确创建插件模板:只用一行命令

跳过 Yeoman,直接使用官方维护的现代 CLI:

VSCode
VSCode

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

下载
npm create vscode-extension@latest

它会交互式询问:extension name、publisher name、是否启用 TypeScript、是否包含 Webview、是否添加测试等。全程无依赖冲突,生成结果与 VS Code Marketplace 提交规范完全一致。

  • 生成的 package.json 自动设 "engines": {"vscode": "^1.85.0"}(随 CLI 版本动态更新)
  • TypeScript 配置启用 isolatedModules: true 和 verbatimModuleSyntax,适配新 TS 版本
  • src/extension.ts 中的 activate 函数默认按功能点拆分,而非全塞进一个函数
  • 测试环境预置 beforeAll 启动真实 VS Code 实例,非模拟对象

如果已有旧项目,怎么迁移到新结构

不要试图把 yo code 模板“升级”,而是用新 CLI 初始化空项目,再手动迁移核心逻辑:

  • 复制旧项目的 src/ 下业务代码(如 registerCommand、WebviewPanel 创建逻辑)到新项目的 src/extension.ts
  • 检查 package.json#contributes 是否遗漏 menus、keybindings 等声明 —— 新 CLI 不自动生成这些,需你按需补全
  • 替换测试入口:旧项目用 ./test/runTest.ts + vscode 包,新项目改用 ./test/suite/index.ts + @vscode/test-electron
  • 删除 node_modules/.yo-rc.json 和所有 yo-related devDependencies(如 yo、generator-code)

常见报错与绕过方式

执行 npm create vscode-extension@latest 时若提示 command not found,不是网络问题,而是 Node.js 版本太低:

  • 必须 Node.js ≥ 18.17.0(npm -v 应 ≥ 9.6.7);低于此版本会静默失败,看似没反应
  • 若用 pnpm/yarn,需显式加前缀:pnpm dlx vscode-dev-cli 或 yarn create vscode-extension
  • Windows 上 PowerShell 执行失败?换用 VS Code 内置终端(Ctrl+Shift+`),确保是 Node.js 环境而非旧版 cmd
  • 生成后 npm install 报 EBADENGINE?删掉 package-lock.json 和 node_modules,再重装

真正麻烦的从来不是“怎么生成”,而是生成后没意识到 activationEvents 必须精确到 command ID、Webview 的 localResourceRoots 必须显式声明、以及打包时 vsce package 会校验 engines.vscode 是否匹配当前 VS Code 版本 —— 这些细节,新 CLI 模板都帮你设对了,旧 Yeoman 模板不会。

相关文章

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

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

下载

相关标签:

vscode

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

相关专题

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

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

2026.02.13

272

17

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

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

2026.02.25

480

17

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

2026.03.13

331

19

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

2026.06.03

246

29

TypeScript Node.js 全栈工程化与Monorepo架构实践
TypeScript Node.js 全栈工程化与Monorepo架构实践

本专题围绕 TypeScript 在 Node.js 全栈开发中的工程化实践展开,系统讲解 Monorepo 架构设计、包管理策略、模块复用机制以及服务端与前端统一类型系统的构建方法。通过真实项目案例,帮助开发者提升大型全栈项目的可维护性与协作效率。

2026.06.16

518

8

json数据格式
json数据格式

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

2023.08.07

1995

5

json是什么
json是什么

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

2023.08.23

2862

1

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

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

2023.10.13

976

3

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

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

2025.09.10

3219

7

热门下载

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

精品课程

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