讲师中心 微信公众号
AI工具推荐 视频效率加速

VSCode插件生成各种资源文件的快速方式

小杰酱_8715

小杰酱_8715

发布时间:2026-08-20 09:34:41

|

423人浏览过

|

来源于php中文网

原创

最稳的插件开发起点是用 yo code 生成骨架,但需固化模板、路径和注入逻辑来避免手动创建资源目录;通过 npm scripts 批量建目录、vscode.Uri.joinPath 动态拼接路径、首次激活时自动复制模板文件,并注意跨平台兼容与编码问题。

vscode插件生成各种资源文件的快速方式

直接用 yo code 生成插件骨架是最稳的起点,但“快速生成资源文件”这事,不能只靠脚手架——关键在怎么把模板、路径、注入逻辑提前固化,避免每次手动建 icons/、media/、templates/ 这类目录和占位文件。

用 generator-code 自带模板生成基础资源结构

运行 yo code 时选 New Extension (TypeScript),它默认会创建 media/ 目录(含示例图标)和 package.json 中的 icon 字段。但注意:media/ 是空的,图标文件得自己放;而且它不建 templates/ 或 snippets/ 这类开发常用目录。

  • 如果插件需要图标,立刻把 icon.png 和 icon.svg 放进 media/,并在 package.json 的 icon 字段填相对路径,比如 "icon": "media/icon.svg"
  • 想加代码片段(snippets),得手动建 snippets/ 目录,并在 package.json 的 contributes.snippets 里声明 JSON 文件路径,VSCode 不会自动帮你注册
  • yo code 生成的 package.json 里没有 repository 或 license 字段,这些虽不算“资源文件”,但缺了会导致发布时校验失败或 GitHub 页面信息缺失

用 npm scripts 快速批量生成常用资源文件

手动建目录太慢,尤其当你反复调试新插件时。直接在 package.json 的 scripts 里加一条命令,比每次敲 mkdir -p 强得多:

VSCode
VSCode

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

下载
  "scripts": {
    "init:resources": "mkdir -p media snippets templates && touch snippets/custom.code-snippets && touch templates/README.md"
  }

执行 npm run init:resources 就能一次性拉起整套目录结构。注意两点:

  • Windows 用户需用 cmd /c mkdir 或改用 cross-env 兼容写法,否则 mkdir -p 在 PowerShell 下可能报错
  • touch 在 Windows 原生命令里不存在,可换成 type nul > snippets/custom.code-snippets,或者干脆装 touch-cli 作为 devDependency
  • 别把资源文件路径硬编码进 extension.ts —— 应该用 vscode.Uri.joinPath 动态拼接,否则打包后路径容易失效

模板文件预置 + 首次激活时自动复制

有些资源(比如初始配置 JSON、默认 CSS 片段)不适合放进 Git,但又希望用户第一次启用插件时就存在。这时别靠文档说明“请手动创建”,而是让插件自己动手:

  • 把模板文件(如 templates/default-config.json)放进项目,构建时确保它们被包含进 out/ 目录(检查 tsconfig.json 的 include 字段)
  • 在 activate 函数里判断目标路径是否存在,若无则用 vscode.workspace.fs.writeFile 把模板内容写过去
  • 特别注意权限:写入用户 .vscode/ 目录需用户确认,而写入插件自己的 context.extensionPath 下则无需弹窗
  • 不要在每次启动都覆盖——只做一次初始化,可用 context.globalState.get('firstRun') 标记

真正麻烦的不是生成文件,而是让它们在不同平台、不同打包方式(vsce vs webpack)、不同 VSCode 版本下都能被正确定位。路径拼接必须用 vscode.Uri.joinPath,绝对路径字符串几乎必挂;模板内容别硬编码成字符串,优先读取本地文件再 toString(),否则中文或特殊字符容易乱码。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

相关专题

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

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

1255

2023.06.30

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

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

2612

2023.07.21

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

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

1889

2024.03.14

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

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

1707

2024.03.14

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

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

2587

2024.03.15

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

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

1798

2024.03.15

vscode用途介绍
vscode用途介绍

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

1242

2024.03.15

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

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

1096

2024.03.15

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

80

2026.09.30

热门下载

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

精品课程

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

共0课时 | 0人学习

vscode常用插件与markdown语法介绍
vscode常用插件与markdown语法介绍

共10课时 | 1.5万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn