VSCode的Snippets Generator:轻松创建代码片段

14次阅读

vscode 中快速生成自定义代码片段有四种方法:一、使用内置 Snippets 管理功能;二、安装 Snippets Generator 扩展插件;三、用 node.js 脚本批量生成;四、利用在线可视化编辑器。

VSCode的Snippets Generator:轻松创建代码片段

如果您希望在 VSCode 中快速生成自定义代码片段,但手动编写 json 格式的 snippets 文件效率低且易出错,则可能是由于缺乏结构化工具辅助。以下是实现 Snippets Generator 功能的多种方法:

本文运行环境:MacBook Air,macos Sequoia。

一、使用 VSCode 内置 Snippets 管理功能

VSCode 提供原生支持通过命令面板快速打开用户或工作区代码片段文件,直接编辑 JSON 结构并实时生效,无需额外插件或外部工具。

1、按下 Cmd + Shift + P 打开命令面板。

2、输入 Configure User Snippets 并回车。

3、选择语言(如 javascript)或新建全局 New Global Snippets file

4、在打开的 JSON 文件中按规范添加 snippet 对象,包含 prefixbodydescription 字段。

二、安装 Snippets Generator 扩展插件

第三方扩展可将选中文本或函数签名自动转换为合法 snippets JSON 片段,大幅降低手写错误率,并支持多光标占位符智能推导。

1、在 VSCode 扩展市场中搜索 Snippets GeneratorSnippet Creator

2、安装评分高于 4.5 且最近更新日期在三个月内的插件,例如 Snippet Generator by dzhavat

3、重启 VSCode 后,右键选中文本,选择 Generate Snippet 上下文菜单项。

4、在弹出的输入框中填写 prefixdescription,插件自动生成完整 JSON 块并复制到剪贴板。

三、使用 Node.js 脚本批量生成 Snippets

当需为多个函数或组件统一生成标准化片段时,本地运行脚本可读取源码注释或 typescript 接口定义,输出符合 VSCode 格式的 JSON 文件。

1、在项目根目录创建 snippets-gen.js 文件。

2、使用 fs.readFileSync 读取含 JSDoc 的 .ts 文件内容。

3、通过正则匹配 @snippet 标签或函数名与参数列表。

4、将解析结果组装为 snippet 对象数组,调用 JSON.stringify 格式化后写入 code-snippets.json

四、利用在线 Snippets 可视化编辑器

脱离编辑器环境,在浏览器中通过表单交互方式构建 snippet 结构,实时预览 JSON 输出,并支持一键下载或复制到剪贴板。

1、访问 https://snippet-generator.apphttps://snipcart.com/snippet-editor

2、在 Prefix 输入框中填写触发关键字,例如 logt

3、在 Body 区域粘贴多行代码,用 $1$2 表示光标跳转位置。

4、点击 Generate JSON 按钮,复制输出内容并粘贴至 VSCode 的 snippets 文件对应语言块内。

text=ZqhQzanResources