How do I use synx to remove unused files from my Xcode project?

Run synx with the --prune or -p flag, which will delete source and image files not referenced by any Xcode group. Always back up your project first, as noted in the README, to avoid accidental data loss.

Does synx work with Swift Package Manager or other dependency managers?

Synx doesn't explicitly support Swift Package Manager; it's designed for Xcode projects and may not handle SPM dependencies automatically. You might need to manually adjust paths or re-run SPM commands after syncing.

What are the best alternatives to synx for organizing Xcode projects?

Manual reorganization in Xcode or using scripts like the 'xcodeproj' gem are common alternatives. Synx automates this specifically for filesystem sync, but alternatives offer more control or better integration with newer tools.

How can I exclude a folder like 'Tests' from being synced by synx?

Use the --exclusion or -e option followed by the group path, e.g., synx -e "/Tests" project.xcodeproj. This is detailed in the advanced usage section with an example for OCMock.

Is synx safe to run on a large, legacy Xcode project?

While synx can handle large projects, the risk increases with size due to more complex dependencies and file references. The README warns to back up first, and testing on a copy is advisable to prevent disruptions.

Synx vs manually moving files in Finder: which is better?

Synx automates the process, ensuring consistency and saving time, especially for large projects. Manual moving gives more control but is error-prone and tedious, as highlighted in the README's philosophy.

Open-Awesome

Synx

MITRubyv0.0.52

A command-line tool that reorganizes your Xcode project folder structure to match your Xcode groups.

GitHub

6.0k stars264 forks0 contributors

What is Synx?

Synx is a command-line tool that automatically reorganizes the file system structure of an Xcode project to match the logical groups defined within the Xcode project file. It solves the problem of disorganized project directories that don't reflect the intended structure, making navigation and maintenance easier for developers.

Target Audience

iOS and macOS developers working with Xcode projects who want to maintain a clean, organized file structure that matches their project's group organization.

Value Proposition

Developers choose Synx because it automates a tedious manual process, ensures consistency between Xcode's interface and the filesystem, and includes features like pruning unreferenced files and custom exclusions for flexible project management.

Overview

A command-line tool that reorganizes your Xcode project folder to match your Xcode groups

Use Cases

Best For

Cleaning up disorganized Xcode project directories
Enforcing consistent file structure across team projects
Removing unused source and image files from projects
Maintaining project organization after major refactoring
Preparing projects for handoff to other developers
Automating project structure synchronization in build scripts

Not Ideal For

Projects using IDEs other than Xcode, such as Android Studio or Visual Studio
Teams with strict version control workflows where automatic file moving could complicate git history or merge conflicts
Projects integrated with complex, path-sensitive build systems or scripts that might break after file reorganization
Developers who prefer granular, manual control over every file move and don't mind the maintenance overhead

Pros & Cons

Pros

Automatic File Sync

Reorganizes the filesystem to exactly match Xcode group structures automatically, as demonstrated in the before/after GIF and images in the README, eliminating manual drudgery.

Unused File Cleanup

Includes a --prune option to remove source and image files not referenced by any Xcode group, helping to declutter projects and improve maintainability.

Flexible Exclusion Control

Allows custom exclusions for specific groups like libraries or tests using the -e flag, providing fine-grained control over what gets synced, as shown in the OCMock example.

CocoaPods Compatibility

Offers clear guidance to re-run 'pod install' after syncing, addressing common integration issues and ensuring dependency management remains intact.

Cons

High Risk of Breakage

The README's prominent warning to back up projects indicates that improper use can lead to lost files, broken references, or confused build tools like CocoaPods, requiring manual fixes.

Xcode-Only Limitation

Exclusively tied to the Xcode ecosystem, making it useless for cross-platform projects or newer tools like Swift Package Manager without additional work.

Disrupts Automated Workflows

Changing file paths can break existing scripts, CI/CD pipelines, or other tools that rely on static paths, adding extra steps and potential errors post-sync.

Frequently Asked Questions

Related Projects

Swift Macros

A curated list of awesome Swift Macros

Stars2,466

Forks106

Last commit6 months ago

SBShortcutMenuSimulator

3D Touch shortcuts in the Simulator

Stars1,732

Forks162

Last commit9 years ago

Swift-VIPER-Module

Xcode template for VIPER Architecture written in Swift 4

Stars542

Forks105

Last commit6 years ago

Xcode Developer Disk Images

Quick fix your Xcode with the missing developer disk images. iOS, tvOS, watchOS files available.

Stars322

Forks41

Last commit3 years ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub