同事照着 README 的三行示例执行,没看到 --force 的说明,把已有配置文件覆盖,回滚花了 40 分钟。乍看像缓存或者权限的锅,追下去往往不是。

node bin/gen.js --help
# 期望列出 --force 的说明和影响范围
node bin/gen.js --module order --dry-run

追下去是这么回事:README 只有一条成功路径的示例,参数表缺失,危险参数和普通参数混在一起。帮助信息也只列名字不写后果。

「生成器文档缺失」相关的验证我通常做两遍,改完一次、隔天再看一次,确认不是临时生效。测试环境和线上的差别,往往就在版本号和那几行被忽略的配置上。

线上出问题先对时间点,跟发布、备份、任务执行的时刻排一排,能省掉一半功夫。日志级别临时调高可以,记得改回去,长期开着既占磁盘又掩盖真问题。

具体做法是,参数表里标出会修改或删除文件的选项;危险参数默认关闭 并在帮助里写明后果;README 补上常见误用和恢复方式;给 --help 加一个示例段落 覆盖最常用的三条命令。

验收就看一点,新人只看 --help 就能生成模块 误用 --force 时会被二次确认拦下。

作者 9823189