fileheader 插件安装后需手动启用auto_add_to_new_file、配置模板变量、重启编辑器并保存带后缀文件,才能使新建文件自动生成头部信息。

FileHeader 插件装完不会自动加任何头部,必须手动启用 auto_add_to_new_file、配对模板变量、重启编辑器并保存带后缀文件,才可能让新建文件立刻生成作者和版权信息。
安装 FileHeader 插件本身很简单,但只是第一步
打开命令面板(Ctrl+Shift+P 或 Cmd+Shift+P),输入 Package Control: Install Package,回车后搜索 FileHeader 并安装。安装完成后,Preferences → Package Settings → FileHeader 里出现菜单项即表示成功。
但这只是把插件放进了目录——它默认完全不工作,所有自动行为都处于关闭状态。
-
auto_add_to_new_file在Settings - Default中是false,且不会被继承 - 不改这个值,新建
.py、.js甚至.vue文件,都不会有任何反应 - 安装后直接测试新建文件却没看到头部?不是插件故障,是开关根本没打开
必须在 Settings - User 里写入 auto_add_to_new_file: true
打开 Preferences → Package Settings → FileHeader → Settings - User,粘贴这一行(仅此一行,不要多余逗号,不要注释):
"auto_add_to_new_file": true
常见错误包括:
- 写在
Settings - Default里(升级后会被覆盖,且 User 配置会静默忽略它) - 用
//或/* */注释掉这行(JSON 不支持注释,会导致整个配置解析失败) - 拼错成
auto_add_new_file或auto_add_to_new_files(键名严格匹配) - 改完只保存设置,没彻底退出 Sublime Text(macOS 尤其要注意:Activity Monitor 中确认
Sublime Text进程已终止)
支持 .vue / .ts / .html 等非默认后缀要补两处
插件默认只识别 python、javascript、java 等小写语言名,不认 .vue 后缀——即使你保存为 index.vue,若未显式声明支持,它就跳过。
- 在
Settings - User中添加:"supported_filetypes": ["vue", "ts", "html"](注意是小写英文名,不是.vue) - 进
Preferences → Browse Packages → FileHeader → template → header,确认存在对应.tmpl文件:
– 没有vue.tmpl?复制javascript.tmpl改名
– 没有typescript.tmpl?同理
–html.tmpl必须用<!-- -->包裹变量,不能用//或/* */
作者名、邮箱、日期等变量不显示?90% 是大小写或位置错
这些值不会从系统自动读取,必须显式声明在 Settings - User 的 Default 对象里,且大小写必须和模板中 {{author}} 完全一致。
{
"Default": {
"author": "Zhang San",
"email": "zhang@example.com",
"desc": "Component for user login"
},
"date_format": "Y-m-d H:i:s"
}
- 模板里写
{{Author}}或${author}?留空 -
Default对象外直接写"author": "xxx"?不生效 -
{{create_time}}格式由date_format控制,H是 24 小时制,h是 12 小时制;写成h:i:s可能输出06:22:15而非18:22:15 -
{{file_name}}和{{file_path}}在文件未保存前返回空字符串,别拿它们做条件判断或拼接路径
新建文件后右下角显示 Plain Text,插件就彻底跳过——哪怕你配了 auto_add_to_new_file: true 也无济于事。语法识别失败是比配置错误更隐蔽的卡点。











