UD5工具箱
使用教程与最佳实践
第一步：准备 package.json 内容
在使用本工具之前，你需要准备好要检查的 package.json 文件内容。有三种方式获取内容：第一，直接打开项目的 package.json 文件，全选复制其中的 JSON 内容。第二，使用工具提供的"加载示例"按钮，这会填充一个符合规范的示例 package.json，适合初次体验工具功能。第三，使用"加载问题示例"按钮，这会填充一个包含常见错误的 package.json，适合了解工具的检测能力。准备好内容后，将其粘贴到编辑器区域，或者通过文件上传功能直接加载本地文件。
第二步：执行验证检查
内容就绪后，点击"验证"按钮启动检查流程。工具会按照预定义的检查规则集对 package.json 进行全面审查。检查过程包括：首先验证 JSON 语法是否正确，解析是否成功。然后逐一检查各个字段的存在性和格式正确性。对于依赖相关字段，会解析版本号范围并验证格式。对于脚本字段，会检查是否包含标准的构建和测试脚本。整个过程通常在毫秒级完成，结果会即时显示在下方的结果面板中。
第三步：解读检查结果
检查结果分为三个级别：错误（红色标识）表示必须修复的问题，如 JSON 语法错误、必填字段缺失或格式严重不合规；警告（黄色标识）表示建议修复的问题，如版本号未使用推荐格式、缺少推荐配置的字段等；通过（绿色标识）表示检查正常的字段。首先关注错误级别的问题，这些会直接影响 npm 发布和项目运行。然后处理警告级别的问题，这些会影响项目的可维护性和可发现性。所有检查项都附有详细的描述和修复建议，按照建议逐一修改即可。
第四步：修复问题并重新验证
根据检查结果修复 package.json 中的问题后，将修改后的内容重新粘贴到编辑器中，再次点击"验证"按钮进行二次检查。重复这个过程直到所有错误被消除，警告数量也尽可能降到最低。建议在项目初始化阶段和每次发布前都执行一次检查，确保 package.json 始终保持规范状态。对于团队项目，可以将本工具集成到 CI/CD 流水线中，实现自动化的 package.json 质量检查。
最佳实践：name 字段
name 字段是 package.json 中最重要的必填字段之一。它必须符合 npm 的命名规范：全小写字母，可以包含连字符和数字，不能包含大写字母、空格、下划线或特殊字符，不能以点或下划线开头。对于 scoped 包，名称格式为 @scope/package-name。建议名称简洁明了，能准确描述包的功能，便于在 npm 仓库中被发现。
最佳实践：version 字段
version 字段必须遵循语义化版本号（Semantic Versioning，简称 SemVer）规范，格式为 MAJOR.MINOR.PATCH。MAJOR 版本在做了不兼容的 API 修改时递增，MINOR 版本在做了向下兼容的功能新增时递增，PATCH 版本在做了向下兼容的问题修正时递增。建议在项目初期使用 0.1.0 作为起始版本号，表示项目尚处于开发阶段。