不再手写重复代码VSCode插件自动生成

阿敏君_5091

阿敏君_5091

2026-08-16

827人浏览

原创

autohotkey 不适合自动生成代码片段,因其仅做字符串替换、不理解语法上下文且无法联动 vscode 编辑器状态;可靠方式应使用 vscode snippet 机制或扩展 api。

不再手写重复代码vscode插件自动生成

为什么 AutoHotkey 不适合自动生成代码片段

很多人第一反应是用 AutoHotkey 或系统级热键工具来“自动敲代码”,结果发现粘贴进来的代码缩进错乱、光标位置丢失、无法动态插入当前文件名或函数名。根本原因是这类工具只做字符串替换,不理解语法上下文,也无法和 VSCode 的编辑器状态(比如选中内容、光标所在作用域)联动。

真正可靠的生成方式,必须走 VSCode 的 snippet 机制或扩展 API。它能读取当前语言模式、变量名、文件路径,甚至调用 vscode.workspace.getConfiguration() 获取用户设置。

snippets.json 中的 body 怎么写才不崩格式

直接复制 IDE 自动生成的代码块进 body,常因换行/缩进导致实际展开后缩进爆炸或换行丢失。VSCode 的 snippet 引擎默认把每行开头的空白当作“统一缩进基准”,不是原始空格数。

  • 用 $1、$2 占位符时,确保它们出现在行首或合理缩进位置,否则 Tab 导航会跳偏
  • 多行 body 每行开头不要手动加空格,用 \t 或留空由编辑器自动对齐(推荐后者)
  • 需要保留空行?写成 "", 而不是直接空着一行——JSON 不允许裸空行
  • 插入当前文件名用 ${fileBasenameNoExtension},不是 ${file},否则带后缀容易出错

示例(React 组件模板):

"React Component": {
  "prefix": "rc",
  "body": [
    "import React from 'react';",
    "",
    "const ${1:ComponentName} = () => {",
    "\treturn (",
    "\t\t<div>${2:content}</div>",
    "\t);",
    "};",
    "",
    "export default ${1:ComponentName};"
  ],
  "description": "Create a basic React functional component"
}

什么时候该写插件而不是改 snippets.json

当你要生成的内容依赖运行时信息,比如:根据当前光标所在行的函数签名自动补全测试用例、读取 package.json 版本号注入到注释、或者把选中文本转成驼峰再拼进变量名——这些都超出了静态 snippet 的能力边界。

VSCode
VSCode

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

下载

这时得写一个最小插件,核心就三步:

  • 在 package.json 里注册一个 command,比如 extension.generateTest
  • 主文件里用 vscode.window.activeTextEditor 获取当前编辑器、editor.selection 获取选区
  • 调用 editor.insertSnippet() 插入动态生成的 vscode.SnippetString,它支持运行时计算占位符值

注意:不要在命令回调里直接用 editor.edit() 手动拼接字符串插入,那样会破坏撤销栈,用户按 Ctrl+Z 会跳过你的插入内容。

生成代码后光标没停在预期位置?检查 tabStop 和 placeholder

VSCode snippet 的 $0 是最终光标位置,但很多人误以为它是“第一个停靠点”。实际上,$1 到 $9 是按数字顺序跳转的,$0 是最后停留处。如果没写 $0,光标会停在最后一个 $N 后面,往往不是你想要的地方。

  • 多个同名占位符(如都写 ${1:props})会被同步替换,适合重复字段;但别和 $1 混用,行为不可控
  • 想让光标先停在参数位置、再跳到函数体,就明确写 $1 和 $2,结尾加 $0
  • 如果生成后光标直接消失或卡住,大概率是 body 数组某一行末尾多了逗号,导致 JSON 解析出错,VSCode 会静默忽略整个 snippet

最隐蔽的问题:某些语言模式(比如 typescriptreact)会覆盖全局 snippet,必须在 snippets 配置里指定 "scope": "typescriptreact",否则 rc 模板在 .tsx 文件里根本不生效。

相关文章

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

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

下载

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

相关专题

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

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

2023.06.30

1335

18

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

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

2023.07.21

2812

3

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

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

2024.03.14

1949

12

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

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

2024.03.14

1727

8

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

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

2024.03.15

2607

12

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

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

2024.03.15

1818

14

vscode用途介绍
vscode用途介绍

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

2024.03.15

1242

10

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

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

2024.03.15

1116

8

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

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

2024.03.15

474

5

热门下载

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

精品课程

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