本文档详细介绍了Front-End Checklist项目中使用的开发工具和依赖。它描述了支持开发的npm包、可用的npm脚本以及这些工具如何与项目质量保证工作流程集成。有关CI/CD实现的信息，请参阅GitHub Actions。
Front-End Checklist项目使用一套经过精心挑选的最小化开发依赖项，以保持代码质量和一致性。这些工具主要侧重于文档质量，因为项目的主要内容位于README.md文件中。
下图显示了开发依赖项及其主要功能
Husky (v9.1.6) 增强了Git钩子实现，使其更容易在开发团队中管理和共享。在此项目中，Husky设置了预推送钩子，在代码推送到仓库之前触发格式化和 linting 检查。
markdownlint-cli (v0.42.0) 是markdownlint的命令行接口，用于检查Markdown文件的风格问题。它确保项目的README.md遵循一致的格式和风格规则，提高了可读性和可维护性。
Prettier (v3.3.3) 是一个风格固定的代码格式化工具，强制执行一致的风格。在此项目中，它用于维护README.md文件中一致的格式，该文件包含实际的Front-End Checklist内容。
该项目在其 package.json 文件中定义了几个npm脚本来自动化常见的开发任务。这些脚本利用开发依赖项执行格式化、linting和设置操作。
下图显示了npm脚本与底层工具之间的关系
下表提供了每个npm脚本的详细概述
| 脚本 | 命令 | 目的 | 使用场景 |
|---|---|---|---|
| format:check | prettier --check README.md | 验证格式，不进行更改 | CI/CD管道，预推送 |
| format:fix | prettier --write README.md && markdownlint README.md | 修复格式问题并检查linting规则 | 本地开发 |
| prepare | husky || true | 在安装包期间设置Git钩子 | 初始设置，在 npm install 之后 |
下图将每个npm脚本映射到其在 package.json 文件中的确切位置
上述工具在项目的质量保证过程中起着至关重要的作用，确保README.md文件（其中包含实际的Front-End Checklist）保持一致的格式和风格。
来源：package.json5-9 package.json23-27
这些工具兼具本地安全和CI/CD检查的双重目的
本地开发:
format:check 脚本format:fix 来解决它们CI/CD 流水线:
这种集成确保了项目生命周期中一致的文档质量，并最大程度地减少了代码审查中与格式相关的反馈需求。
Front-End Checklist项目对其所有依赖项都使用了npm的caret范围说明符（^），这允许自动更新到次要版本和补丁版本，同时防止可能导致中断的主要版本更新。
| 依赖项 | 版本规范 | 允许更新至 |
|---|---|---|
| husky | ^9.1.6 | <10.0.0 |
| markdownlint-cli | ^0.42.0 | <0.43.0 |
| prettier | ^3.3.3 | <4.0.0 |
这种版本控制策略平衡了与错误修复和次要改进保持同步，以及引入破坏性更改的风险。