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

为什么 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 的能力边界。
这时得写一个最小插件,核心就三步:
- 在
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 文件里根本不生效。











