https://github.com/venmo/synx

A command-line tool that reorganizes your Xcode project folder to match your Xcode groups
https://github.com/venmo/synx

Last synced: 5 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/venmo/synx
• Owner: venmo
• License: mit
• Created: 2014-04-29T20:28:39.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2019-07-18T23:40:39.000Z (almost 6 years ago)
• Last Synced: 2024-04-24T19:26:37.626Z (12 months ago)
• Language: Ruby
• Homepage:
• Size: 17.5 MB
• Stars: 6,082
• Watchers: 134
• Forks: 275
• Open Issues: 58
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-ios - Synx - A command-line tool that reorganizes your Xcode project folder to match your Xcode groups. (Xcode / Other Xcode)
• awesome-iOS-Library-Curator - SYNX
• awesome-ios-star - Synx - A command-line tool that reorganizes your Xcode project folder to match your Xcode groups. (Xcode / Other Xcode)
• awesome-ios-cn - 官网

README

        
![synx logo](https://raw.githubusercontent.com/venmo/synx/marklarr/dev/docs/images/synx-logo.png?token=760261__eyJzY29wZSI6IlJhd0Jsb2I6dmVubW8vc3lueC9tYXJrbGFyci9kZXYvZG9jcy9pbWFnZXMvc3lueC1sb2dvLnBuZyIsImV4cGlyZXMiOjE0MDE5MzExNDF9--6c8a22318eaafed2185cb16d39189dcadb75c742)

[![Gem Version](https://badge.fury.io/rb/synx.svg)](http://badge.fury.io/rb/synx)

 [![Build Status](https://travis-ci.org/venmo/synx.svg?branch=master)](https://travis-ci.org/venmo/synx)

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

![synx gif](https://raw.githubusercontent.com/venmo/synx/marklarr/dev/docs/images/synx.gif?token=760261__eyJzY29wZSI6IlJhd0Jsb2I6dmVubW8vc3lueC9tYXJrbGFyci9kZXYvZG9jcy9pbWFnZXMvc3lueC5naWYiLCJleHBpcmVzIjoxNDAxODU2NzAyfQ%3D%3D--fc7d8546f3d4860df9024b1ee82ea13b86a2da88)

##### Xcode

![synx Xcode](https://raw.githubusercontent.com/venmo/synx/marklarr/dev/docs/images/synx-Xcode.jpg?token=760261__eyJzY29wZSI6IlJhd0Jsb2I6dmVubW8vc3lueC9tYXJrbGFyci9kZXYvZG9jcy9pbWFnZXMvc3lueC1YY29kZS5qcGciLCJleHBpcmVzIjoxNDAxOTMxMDY5fQ%3D%3D--969e312f6ee33430855c495f25d9f5ff78fa9e96)

##### Finder

![synx finder before/after](https://raw.githubusercontent.com/venmo/synx/marklarr/dev/docs/images/synx-finder-before-after.png?token=760261__eyJzY29wZSI6IlJhd0Jsb2I6dmVubW8vc3lueC9tYXJrbGFyci9kZXYvZG9jcy9pbWFnZXMvc3lueC1maW5kZXItYmVmb3JlLWFmdGVyLnBuZyIsImV4cGlyZXMiOjE0MDE5MzEwOTd9--8cff7616e4af2f6f2eed624623092745184c0235)

## Installation

    $ gem install synx

## Usage

### Basic

:warning: **WARNING: Make sure that your project is backed up through source control before doing anything** :warning:

Execute the command on your project to have it reorganize the files on the file system:

     $ synx path/to/my/project.xcodeproj

     

It may have confused CocoaPods. If you use them, execute this command:

    $ pod install

    

You're good to go!

### Advanced

Synx supports the following options:

```

  --prune, -p                   remove source files and image resources that are not referenced by the the Xcode project

  --no-color                    removes all color from the output

  --no-default-exclusions       doesn't use the default exclusions of /Libraries, /Frameworks, and /Products

  --no-sort-by-name             disable sorting groups by name

  --quiet, -q                   silence all output

  --exclusion, -e EXCLUSION     ignore an Xcode group while syncing

```

For example, OCMock could have been organized using this command:

    $ synx -p -e "/OCMock/Core Mocks" -e /OCMockTests Source/OCMock.xcodeproj/

if they had wanted not to sync the `/OCMock/Core Mocks` and `/OCMockTests` groups, and also remove (`-p`) any image/source files found by synx that weren't referenced by any groups in Xcode.

## Contributing

We'd love to see your ideas for improving this library! The best way to contribute is by submitting a pull request. We'll do our best to respond to your patch as soon as possible. You can also submit a [new Github issue](https://github.com/venmo/synx/issues/new) if you find bugs or have questions. :octocat:

Please make sure to follow our general coding style and add test coverage for new features!

## Contributors

* [@vrjbndr](https://github.com/vrjbndr), awesome logo!

* [@ayanonagon](https://github.com/ayanonagon) and [@benzguo](https://github.com/benzguo), feedback.