每次开新项目,我写下的头一段内容都不是代码,是从上一个项目复制一份 .gitignore。上周拆一个多语言仓库时,同事在 review 里问:"这个缓存目录怎么进了提交?"我点开忽略文件一看,全是在遮 Node 的东西——项目里明明一半是 Python 脚本。顺藤摸瓜还发现,这份清单是从三年前一个纯前端项目抄来的,中间换了两个技术栈,它一次都没变过。抄来的清单只记得住上一次的技术栈。这篇就说说怎么把它改成"按本次技术栈生成",三步走。
下面拿数据鱼API的「Gitignore 模板库」服务当例子。它先给你一份模板名清单,再把多个技术栈的忽略规则拼成一份文件,两步都是现成端点。
接入先调 GET /api/gitignore-gen/list。数据鱼API的这个 list 端点不用传参,直接返回当前支持的模板名。以文档实测输出为例,里面有 php、node、python、go、java 这些语言运行时,也有 macos、windows 这类操作系统,还有 vscode 这种编辑器条目。三组名字正好对应忽略规则的三层来源:
来源层 | 回答的问题 | 模板名示例 |
|---|---|---|
语言运行时 | 构建产物、依赖目录、虚拟环境 | node、python、go、java、php |
操作系统 | 缩略图缓存、系统服务文件 | macos、windows |
编辑器 | 工作区配置、本地缓存 | vscode |
建议把这份清单缓存进脚手架配置里,定期刷新一次即可——它不是高频变化的数据。但别在前端写死名单:接口哪天新增了模板,写死的名单就开始说谎。这份名单还有个隐藏用途:脚手架初始化时可以让用户勾选技术栈,勾完拿名单校验一遍再进入下一步,把参数错误挡在生成之前。
生成走 POST /api/gitignore-gen/generate,参数就一个:types,逗号分隔的模板名字符串。数据鱼这个接口的 generate 一次能把语言、系统、编辑器三层规则拼进同一份文件——比如 node,macos,vscode,产物就是一份跨三层的完整清单,不用你自己去合并去重。模板之间的条目重叠(比如多个栈都会产生的日志目录)也由服务端处理,比人肉拼接省心。
POST /api/gitignore-gen/generate
{"types": "node,python,macos,vscode"}有个要提醒的点:types 没传或格式不对,接口会返回 4001,提示 Invalid types array。所以头一步那份名单不只是参考,更是发起生成前的输入关——先确认模板名在名单里,再发起生成,报错基本可以避免。我的习惯是把"名字是否在名单里"做成脚手架里的一次静默校验,通过了直接生成,没通过就把名单回显给用户挑,交互上多一步,报错少十次。
生成结果拿到手后,值得接在两个位置。新项目初始化命令里调一次 generate,按声明的技术栈写盘,从此"抄清单"这个动作消失;脚手架升级时重新拉一份,和项目里的旧文件做对比,差异走 review。第二个位置常被忽略,但它才是防漂移的关键——技术栈变了,清单也要跟着重新生成一次。若团队有统一的 CI 配置仓库,也可以把生成动作放进初始化流水线,让每条新建分支从一开始就带着合规的忽略清单。
两个工程习惯顺手带上:生成请求放到脚手架的服务端,别把接口调用散在客户端各处;清单写盘前打一份 diff,让每次变更可见。配置类的东西,可见性就是安全性。
手抄的 .gitignore 回答的是"上个项目用了什么",生成的清单回答的是"这个项目用了什么"。三步接完,起手头一分钟欠的债就还上了,review 里也不会再出现"这目录怎么进来了"的悬案。
以上模板清单与端点说明,整理自数据鱼API「Gitignore 模板库」接口的公开文档;模板名以接口实时返回为准,文中示例为演示组合。
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。