VS Code 文件模板插件
一个用于管理和使用文件模板的 VS Code 插件,支持模板插入、导入和新建文件等功能。
功能特性
- 插入模板: 将模板内容插入到当前编辑器的光标位置
- 导入模板: 将模板目录下的文件批量导入到指定目录
- 新建文件: 基于模板创建新文件
- 保存为模板: 将选中的文本保存为新的模板文件
- 模板管理: 通过状态栏按钮快速访问模板管理功能
目录结构
插件要求模板目录具有以下结构:
templatedir/
├── import/ # 用于批量导入的模板目录
│ ├── a/
│ └── b/
├── insert/ # 用于插入的模板文件
│ ├── lua/
│ │ └── *.lua
│ ├── ts/
│ │ └── *.ts
│ ├── ini/
│ │ └── *.ini
│ └── 其他/
└── new/ # 用于新建文件的模板
├── *.lua
├── *.ts
└── *.其他文件类型
使用方法
1. 配置模板路径
首次使用需要配置模板存放路径:
- 点击状态栏的"模板"按钮
- 选择"配置模板路径"
- 在设置中配置
vs-file-template.templatePath 为你的模板目录路径
2. 插入模板
- 在编辑器中将光标定位到要插入模板的位置
- 右键选择"插入模板"
- 依次选择模板类型和具体模板文件(筛选框会自动填入当前文件的扩展名,按回车确认选择)
- 模板内容将插入到光标位置
3. 导入模板
- 在资源管理器中右键选择目标文件或文件夹
- 选择"导入模板"
- 选择要导入的模板目录
- 模板目录内的所有文件和子目录将被递归复制到目标位置(保留内部目录结构,但不包含选择的根目录本身)
4. 新建文件
- 在资源管理器中右键选择目标文件夹
- 选择"从模板新建文件"
- 选择模板文件并输入新文件名
- 新文件将被创建并自动打开
5. 管理模板
- 点击状态栏的"模板"按钮
- 选择"管理模板"
- 将在新窗口中打开模板目录,方便编辑模板文件
6. 保存为模板
- 在编辑器中选中要保存为模板的文本
- 右键选择"保存为模板"
- 选择目标模板分类目录(会自动匹配当前文件类型)
- 输入模板文件名
- 选中的文本将被保存为模板文件
快捷键
插件不提供默认快捷键,你可以在 VS Code 的键盘快捷键设置中为以下命令设置快捷键:
vs-file-template.insert : 插入模板
vs-file-template.import : 导入模板
vs-file-template.new : 从模板新建文件
vs-file-template.addToInsertDir : 保存为模板
vs-file-template.btn : 文件模板管理
注意事项
- 模板路径必须是绝对路径
- 模板目录下必须包含
import 、insert 、new 三个子目录,如果没有会自动创建
- 导入模板时,会递归复制并保留选中目录内部的完整目录结构
- 新建文件时,文件扩展名将与模板文件保持一致
开发信息
许可证
本项目采用 MIT 许可证 - 详情请参阅 LICENSE 文件。
| |