当积分策略、注册奖励、bcrypt 配置散落在各个文件时,任何一个手动改动都可能造成线上事故。为此,我们开发了新的配置巡检脚本 npm run config:check
,帮助运维和客服在一分钟内完成全局检查。本文提供完整的实操指南。
一、脚本能检查哪些内容?
- 安全项:bcrypt 轮数是否符合安全标准。
- 积分策略:默认积分、邀请奖励是否与策略文件一致。
- 文档同步:运维文档是否已更新最新配置,避免信息滞后。
- 自定义钩子:可扩展检查 API key、第三方服务配置等。
二、运行前准备
- 确保项目依赖已安装:
npm install
- 建议在 staging 或测试环境先执行。
- 准备好当前策略文档,方便对照。
三、运行命令
npm run config:check
执行后终端会输出检查项与状态:
✔ bcryptRounds >= 12
✔ defaultPoints == policy.defaultPoints
✔ inviteReward == policy.inviteReward
ℹ Docs outdated: 请同步 docs/staging/[open]onboarding-incentives-config.md
四、如何处理输出结果
- 通过:绿色
✔
表示配置符合预期,可记录在巡检日志。 - 警告:蓝色
ℹ
提醒需要同步文档或关注,即刻安排相关同学更新。 - 失败:红色
✖
表示配置不一致,需检查最近的代码或部署记录。
五、结合日常流程的建议
- 发布前必跑:将脚本加入 CI/CD 流程,部署前自动检查。
- 客服排障:遇到“积分不一致”时,客服可请求运维运行脚本,避免人工猜测。
- 定期巡检:建议每周固定时间运行并记录结果,纳入运维手册。
- 文档同步:输出包含文档路径,可提醒文档负责人更新内容。
六、FAQ
- 可以自定义检查项吗? 可以,打开
scripts/check-config.js
,按照示例新增校验逻辑。 - 脚本会修改配置吗? 不会,它仅做读取和比对。
- Windows 环境能运行吗? 可以,脚本使用 Node.js,无平台限制。
- 能否导出报告? 目前可通过
npm run config:check --json
(开发中)导出 JSON,方便接入监控系统。
七、推荐配套措施
- 配合《积分策略统一上线》一文,建立统一配置基线。
- 使用进度快照记录重大配置变更时间点。
- 在团队知识库中新增“日常巡检”板块,存档每次检查结果。
只需一行命令,就能让积分、安全配置心中有数。现在就回到项目根目录,运行一次 npm run config:check
,为下一次上线建立信心。