Atom无官方“file-header”插件,atom-file-header已停更不兼容新版;唯一可靠方案是docblockr手动触发文件头,支持自定义模板但不自动保存插入。

Atom 没有官方叫 “file-header” 的插件,你搜到的大概率是 docblockr 或误传名称;真正能自动插入文件头(非函数级)且稳定支持自定义模板的,只有 atom-file-header ——但该插件已停更多年,无法兼容 Atom 1.60+ 版本,强行安装会报错或完全不生效。
为什么装了 “file-header” 插件新建文件没反应
常见现象:安装后新建 .js 或 .py 文件,Ctrl+S 也没加作者、时间等信息。
根本原因不是配置错,而是插件本身失效:
-
atom-file-header最后更新是 2018 年,依赖已被移除的 Atom API(如atom.project.onDidChangePaths),新版 Atom 直接跳过加载 - 社区里流传的 fork 版(如
atom-file-header-plus)多数未适配 Electron 25+ 和 Node.js 20 运行时,启动即报Cannot find module 'fs-plus' - 搜索 “file-header atom” 返回的推荐插件,90% 是旧文档搬运,实际链接已 404 或指向 GitHub archive 页面
替代方案:用 docblockr + 手动触发文件头
docblockr 默认只处理函数/类注释(/** → Tab),但它支持通过快捷键插入**文件级头部**,且模板可自定义——这是目前 Atom 上唯一可靠、无需改源码的方案:
- 安装后打开
Settings → Packages → docblockr → Settings - 在
Template输入框中粘贴(注意:必须以/**开头,结尾用*/):
/**
* @file {{filename}}
* @author {{author}}
* @date {{date}}
* @version 1.0.0
*/-
{{author}}值取自 Atom 全局设置:Settings → Core → Author Name(不是 Git config) - 新建文件后,把光标移到第一行,按
Cmd+Shift+P(macOS)或Ctrl+Shift+P(Windows/Linux),输入Docblockr: Insert file header回车即可 - 不能设成“保存自动触发”,因为
docblockr没提供该钩子;想接近自动化,得配合script插件写个一键命令
Vue / TS 等非默认语言怎么加文件头
docblockr 对 .vue 或 .ts 文件默认不响应快捷键,因为它的 scope 判断严格:
- 确认右下角状态栏显示的是
source.vue或source.ts,不是text.html.vue—— 后者会被当 HTML 处理,直接跳过 - 若显示错误,需手动设置语法:右键编辑区 →
Grammar → Vue Component(或TypeScript) - 模板中注释符号必须匹配语言:Vue 的
<script>块用//,HTML 部分用<!-- -->;docblockr只生成/** */风格,所以仅对 JS/TS/Vue script 块有效 - 想在
.vue的 template 区域加注释?得另配emerald或language-vue插件补全语法识别,否则docblockr根本不激活
真正麻烦的不是怎么装插件,而是 Atom 本身已停止维护(2022 年 12 月官方终止更新),所有“自动添加文件头”的功能都建立在过期 API 上。如果你需要开箱即用的自动头部,现在切到 VS Code + korofileheader 是唯一省心路径;非要留 Atom,就接受手动触发这个现实——毕竟连 atom-file-header 的 GitHub README 都写着:“This package is deprecated.”

















