AssetChecker使用手册

AssetChecker使用手册

AssetChecker👮Sanitize your Assets.xcassets files项目地址:https://gitcode.com/gh_mirrors/as/AssetChecker

---

项目介绍

AssetChecker 是由 freshOS 开发的一个 iOS 工具集的一部分，旨在简化 Asset Catalog 的使用过程，并确保图像资源管理的安全性。它是一款便捷的脚本工具，能够在构建过程中自动执行，帮助开发者识别缺失的资产以及提醒未使用的资产，从而维护项目资源的整洁与高效。

• 自动检查：在每次构建时自动运行，检查缺失的资产和未使用的资产。
• 跨平台兼容：适用于使用 cocoapods 的项目或手动集成。
• 配置灵活：可自定义忽略特定未使用资产的列表。

---

项目快速启动

通过 CocoaPods 安装

1. 打开你的 Podfile ，加入以下行来引入 AssetChecker：

   pod 'AssetChecker', :git => 'https://github.com/freshOS/AssetChecker.git'
   

2. 在终端中定位到项目目录并运行 pod install 来安装。

3. 添加 Run Script 到你的 Xcode 项目中:

   • 打开你的 Xcode 项目设置。
   • 导航到 Build Phases。
   • 点击 "+" 按钮，选择 New Run Script Phase。
   • 输入以下脚本内容:

     ${PODS_ROOT}/AssetChecker/run --catalog ${SRCROOT}/Resource/Images.xcassets
     

   注意：这里假设你的 Asset Catalog 位于 Resource/Images.xcassets。

手动集成

1. 直接从 GitHub 仓库下载 AssetChecker 脚本到你的项目。
2. 在 Xcode 中添加一个新的 Run Script 阶段，并指向下载的脚本路径，同时提供正确的参数配置。

---

应用案例和最佳实践

应用案例

当你的项目随着时间增长，图像资源日益增多，AssetChecker 可以帮助你：

• 在早期阶段捕获由于资产删除导致的潜在引用断裂问题。
• 自动化清理未使用的图像资源，保持项目精简。
• 教育团队成员关于有效管理资源的重要性。

最佳实践

• 在每次提交前运行 AssetChecker，以保证资源引用的准确性。
• 定期审查并处理脚本报告的未使用资产，避免资源浪费。
• 对于动态生成名称的资产，维护好 ignoredUnusedNames 列表，避免误报。

---

典型生态项目

虽然 AssetChecker 主要聚焦于 iOS 和 Swift 生态，但在类似的资源管理场景中，比如 Unity 开发环境，也有类似目的的工具如 AssetChecker-Win。它适用于Unity项目，强调资源管理和优化，虽非同一项目但展示了资源管理工具在不同技术栈中的重要性和通用需求。这些工具共同构成了生态系统中资源效率和项目健康度的关键组成部分。

---

通过遵循以上指南，您可以有效地利用 AssetChecker 保持您的 iOS 项目资源目录整洁有序，提升开发效率。

AssetChecker👮Sanitize your Assets.xcassets files项目地址:https://gitcode.com/gh_mirrors/as/AssetChecker