依赖管理规范
五个问题
添加依赖之前,按顺序回答以下五个问题:
- 项目里是否已有现成实现?
- 框架、平台或标准工具链是否已经提供该能力?
- 这个依赖是否解决真实需求?
- 维护成本是否划算?
- 它与标准工具链是否兼容?
示例:在 TypeScript 项目中考虑用 zod 校验运行时输入:
- 项目:没有现成的运行时校验功能。
- 平台:TypeScript 类型仅在编译期生效;请求体和环境变量在运行时没有类型信息。
- 需求:外部输入会跨越运行时边界,使用前必须校验。
- 维护:这是一个用途单一、API 范围较小的库,只需跟踪一个依赖。
- 工具链:
zod是纯运行时库;用 pnpm 安装,与 oxlint、oxfmt 不冲突。
决定:添加 zod。
用同样的问题排除不必要的依赖:truncate 之类的字符串工具库过不了第 3 问——用三行清晰代码即可实现,无需添加依赖;平台的 fetch 已经满足需求时,axios 过不了第 2 问。
几行代码就能写清楚的逻辑,不要为此引入库。
未经用户明确批准,不要用其他依赖替换标准化工具。
兼容性参考
根据强制工具链评估兼容性:
- TypeScript 工具链——pnpm、oxlint、oxfmt
- Python 工具链——uv、ruff
- 质量门禁——prek
- Git 工作流——用 Cocogitto 校验 Conventional Commits
推荐的库选型见前端框架和Python API 技术栈。
这些规则所依据的标准化原则见核心工程原则。