AssetChecker
AssetChecker is a tiny run script that keeps your Assets.xcassets files clean and emits warnings when something is suspicious.
Because Image Assets files are not safe, if an asset is ever deleted, nothing will warn you that an image is broken in your code.
Try it!
AssetChecker is part of freshOS iOS toolset. Try it in an example App! Download Starter Project
How
By using a script running automatically, you have a safety net that makes using Asset Catalog a breeze.
What
Automatically (On build)
- Raises Errors for Missing Assets
- Raises warnings for Unused Assets
Installation
Installation available via Cocoapods. Add the following to your Podfile:
pod 'AssetChecker', :git => 'https://github.com/freshOS/AssetChecker.git'
Or copy the script into your project.
Add the following Run Script in XCode, this will run the script at every build. If you installed via Cocoapods, you can use the following script:
${PODS_ROOT}/AssetChecker/run --catalog ${SRCROOT}/Resource/Images.xcassets
with arguments:
--catalog Absolute path to your Asset catalog (required)
--source Absolute path to your source directory. Defaults to $SRCROOT
If you didn't use Cocoapods, use the path of where you copied AssetChecker script:
${SRCROOT}/{PATH_TO_THE_SCRIPT}/AssetChecker.swift ${SRCROOT}/Sources ${SRCROOT}/Resources/Images.xcassets
In this example your source files are located in /Sources and your Asset catalog is in /Resources/Images.xcassets.
And configure top section of the script :
// Configure me \o/
let sourcePath = "/Sources"
let assetCatalogPath = "/Resources/Assets.xcassets"
let ignoredUnusedNames = [String]()
Run and Enjoy \o/
False positives
Sometimes you're building the asset names dynamically so there is no way for AssetChecker to find out statically by looking at the codebase.
In this case the script will emit a false positive.
You can manually declare these false positives so that they get ignored !
Set the ignoredUnusedNames variable in the script file like so:
let ignoredUnusedNames = [
"voteEN",
"voteES",
"voteFR"
]
Author
Sacha Durand Saint Omer, [email protected]
Contributing
Contributions to AssetChecker are very welcomed and encouraged!
License
AssetChecker is available under the MIT license. See LICENSE for more information.
Backers
Like the project? Offer coffee or support us with a monthly donation and help us continue our activities :)
Sponsors
Become a sponsor and get your logo on our README on Github with a link to your site :)
1 Nov 23, 2021
3 Oct 24, 2022
4 Apr 9, 2022
72 Feb 4, 2022
3 Aug 9, 2022
2 May 11, 2022
235 Dec 20, 2022
7 Dec 23, 2022
0 Nov 12, 2021
0 Dec 29, 2021
2 Feb 5, 2022
647 Jan 7, 2023
10 Aug 20, 2022
566 Dec 6, 2022
69 Dec 17, 2022
676 Dec 25, 2022
2.2k Dec 29, 2022
28 Dec 3, 2022
8.3k Jan 5, 2023
348 Sep 18, 2022
2.6k Dec 17, 2022
11 May 27, 2021
1.3k Jan 1, 2023
7 Dec 5, 2022
339 Dec 6, 2022