repository·master·Indexed 25 days ago
https://github.com/onevcat/fengniaoA command-line utility for Xcode projects that identifies and deletes unused image resource files to reduce project size. It scans for resource files and verifies their usage within source code files, offering options to exclude specific directories, customize file extensions, and integrate into Xcode Build Phases.
Navigate to your Xcode project folder and run fengniao to scan for unused image resources. The tool will identify unused files and prompt you for deletion.
Warning: Deletion is an un-restorable operation. Ensure you have a backup or are using version control before proceeding.
fengniaoTo automatically clean unused resources every time you build your project:
--force flag and it is highly recommended to --exclude vendor folders (like Pods or Carthage).Example script content:
fengniao --exclude Carthage --forceYou can install FengNiao using Mint or by compiling it from source.
If you have Mint installed, run:
mint install onevcat/fengniaoClone the repository, build the release version, and move the executable to your PATH (e.g., /usr/local/bin):
git clone https://github.com/onevcat/FengNiao.git
cd FengNiao
swift build -c release
sudo cp .build/release/FengNiao /usr/local/bin/fengniaomint install onevcat/fengniaofengniao is a command-line tool designed to find and delete unused resources in Xcode projects. It searches for resource files (like images) and checks if they are referenced in your source code files (like .swift or .m files). By default, it will prompt you before deleting files.To scan the current directory while skipping third-party dependency folders like Carthage or Pods, use the --exclude flag:
fengniao --project . --exclude Carthage Pods> fengniao --project . --exclude Carthage PodsAvailable command-line arguments for fengniao:
| Argument | Description |
|---|---|
-p, --project | Root path of your Xcode project. Default is current folder. |
--force | Delete the found unused files without asking. |
-e, --exclude | Exclude paths from search. |
-r, --resource-extensions | Resource file extensions to search. Default: imageset jpg png gif pdf |
-f, --file-extensions | File types to search for resource usage. Default: m mm swift xib storyboard |
--skip-proj-reference | Skip the Project file (.pbxproj) reference cleaning. Keeps the project file untouched. |
--xcode-warnings | Print results as Xcode warnings and return a non-zero exit code if any are found. |
--list-only | List unused files and exit without prompting. |
--version | Print version. |
-h, --help | Print this help message. |
fengniao --helpThe following options and flags are available for the fengniao command:
--project <String> (or -p): Root path of your Xcode project. Default is the current folder (.).--exclude <[String]> (or -e): Exclude specific paths from the search.--resource-extensions <[String]> (or -r): Resource file extensions to search for. Default: imageset jpg png gif pdf.--file-extensions <[String]> (or -f): File types to search for resource usage. Default: h m mm swift xib storyboard plist.--force: Delete the found unused files without asking for confirmation.--skip-proj-reference: Skip the .pbxproj reference cleaning. This leaves the project file untouched, which is useful if you are building multiple projects with dependencies and want to keep .pbxproj unchanged.--xcode-warnings: Print results as Xcode warnings and return a non-zero exit code if any unused resources are found.--list-only: List unused files and exit without prompting for action.The fengniao CLI uses specific exit codes to communicate the result of the operation:
0: Success (no unused resources found or operation completed successfully).1: Unused resources were found (when using --xcode-warnings).64: Usage error (e.g., invalid arguments or missing required extensions).