Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/truebit/xunique

merge Xcode project file is so easy
https://github.com/truebit/xunique

merge-conflicts python xcode xcode-project-file

Last synced: 7 days ago
JSON representation

merge Xcode project file is so easy

Awesome Lists containing this project

README 

        
xUnique

=======



*xUnique*, is a pure Python script to regenerate ``project.pbxproj``,

a.k.a the Xcode project file, and make it unique and same on any

machine.



As you may know, the UUID generated by Xcode (a.k.a

`rfc4122 `__) in the file is not

unique for the same added file( or other entries like groups,build

phases,etc.) on different machines, which makes it a developer's

nightmare to merge and resolve conflicts in ``project.pbxproj``.



*xUnique* convert all the 96bits ``UUID``\ (24 alphanumeric chars) to

MD5 hex digest(32 hex chars), and Xcode do recognize these MD5 digests.



What it does & How it works

---------------------------



#. convert ``project.pbxproj`` to JSON format

#. Iterate all ``objects`` in JSON and give every UUID an absolute path,

   and create a new UUID using MD5 hex digest of the path



   -  All elements in this json object is actually connected as a tree

   -  We give a path attribute to every node of the tree using its

      unique attribute; this path is the absolute path to the root node,

   -  Apply MD5 hex digest to the path for the node



#. Replace all old UUIDs with the MD5 hex digest and also remove unused

   UUIDs that are not in the current node tree and UUIDs in wrong format

#. Sort the project file inlcuding ``children``, ``files``,

   ``PBXFileReference`` and ``PBXBuildFile`` list and remove all

   duplicated entries in these lists



   -  see ``sort_pbxproj`` method in xUnique.py if you want to know the

      implementation;

   -  It's ported from my modified `sort-Xcode-project-file `__,

      with some differences in ordering ``PBXFileReference`` and

      ``PBXBuildFile``



#. With different `options `__, you can use

   *xUnique* with more flexibility



Change Log

----------



The `change log `__

contains the list of changes and latest version information of each

version. Please download ``Latest Release`` for production environment

usage.



Installation

------------

- install from `PyPi `__:

  

  .. code-block:: bash



      $ pip install xUnique



- install locally:



  .. code-block:: bash



      $ python setup.py install



It will install a command line script ``xunique`` in dir ``/usr/local/bin`` (make sure you have added this dir to your ``$PATH`` ). So you can invoke xUnique directly from command line:



.. code-block:: bash



    $ xunique -h



How to use

----------



There are many ways to use this script after you installed *xUnique* . I will introduce two.



My recommended method is git hook rather than other methods in Xcode, such like build post action or shell script build phase.

The reason is that Xcode may trigger these actions unnoticed when you've changed some files. That may cause a failure.



You could still use Xcode actions if you do not got such problems. But if you do got strange failures, try git hook method.



Git hook (Recommended)

~~~~~~~~~~~~~~~~~~~~~~



#. create a git hook in Terminal like:



   .. code-block:: bash



     $ { echo '#!/bin/sh'; echo 'xunique path/to/MyProject.xcodeproj'; } > .git/hooks/pre-commit



#. Add permission ``chmod 755 .git/hooks/pre-commit``

#. xUnique will be triggered when you trying to commit:



   -  Using option ``-c`` in command would fail the commit operation if

      project file is modified. Then you can add the modified project

      file and commit all the files again.

   -  Option ``-c`` is not activated by default. The commit operation

      will proceed successfully even if the project file is modified by

      xUnique. So do not push the commit unless you add the modified

      project file again and do another commit.



Xcode "build post-action"

~~~~~~~~~~~~~~~~~~~~~~~~~



#.  open ``Edit Scheme`` in Xcode (shortcut:

    ``⌘``\ +\ ``Shift``\ +\ ``,``)

#.  choose the scheme you use to run your project

#.  expand ``Build``, select ``Post-actions``

#.  click symbol ``+`` on the left bottom corner of the right pane

#.  choose ``New Run Script Action``

#.  choose your selected scheme name in ``Provide build settings from``

#.  input commands below:

    

    .. code-block:: bash



      $ xunique "${PROJECT_FILE_PATH}/project.pbxproj"



#.  click ``Close`` and it's all done.

#.  Next time when you Build or Run the project, xUnique would be

    triggered after build success. If the build works, you could commit

    all files.

#. Demo gif animation is `here `__



CocoaPods users

~~~~~~~~~~~~~~~



If your project uses CocoaPods AND added ``Pods`` directory to source control, you may also need to uniquify ``Pods.xcodeproj``: 



-  Xcode "build post-action" : add extra command below

        

   .. code-block:: bash



     $ xunique "${PODS_ROOT}/Pods.xcodeproj"



   **Note** : according to `Cocoapods wiki `__,

   make sure `xcproj `__ is installed in ``$PATH``.



-  Git hook: add one more command in hook script



   .. code-block:: bash



     $ { echo '#!/bin/sh'; echo 'xunique path/to/MyProject.xcodeproj'; echo 'xunique path/to/Pods.xcodeproj'; } > .git/hooks/pre-commit



**Note**: If ``project.pbxproj`` file is in XML format, please install `xcproj `__ and add it to your $PATH. This would make Cocoapods converting it to Xcode default format automatically:



.. code-block:: bash



    brew install xcproj



`Detailed Cocoapods explanation here `__



Supported argument options

~~~~~~~~~~~~~~~~~~~~~~~~~~



Use options in xUnique:



.. code-block:: bash



    $ xunique [options] "path_to/YourProject.xcodeproj/or_project.pbxproj"



-v    print verbose output, and generate ``debug_result.json`` file for debug.

-u    uniquify project file, that is, replace UUID to MD5 digest.

-s    sort project file including ``children``, ``files``, ``PBXFileReference`` and ``PBXBuildFile`` list and remove all duplicated entries in these lists. Supports both original and uniquified project file.

-p    sort ``PBXFileReference`` and ``PBXBuildFile`` sections in project file ordered by file names. Only works with ``-s``. Before v4.0.0, this was hard-coded in ``-s`` option and cannot be turned off. Starting from v4.0.0, without this option along with ``-s``, xUnique will sort these two types by MD5 digests, the same as Xcode does.

-c    When project file was modified, xUnique quit with non-zero status. Without this option, the status code would be zero if so. This option is usually used in Git hook to submit xUnique result combined with your original new commit.



**Note**: If neither ``-u`` nor ``-s`` exists, ``-u -s`` will be appended to existing option list.



Examples

--------



-  `APNS Pusher `__ is a Xcode project which contains a subproject named "Fragaria" as git submodule. Use *xUnique* to convert it. You can clone `my forked repo `__ and try to open and build it in Xcode. You will find that ``xUnique`` does not affect the project at all.

-  The initial diff result could be found `here `__.

-  The diff result with my modified `sort-Xcode-project-file `__ with ``PBXBuildFile`` and ``PBXFileReference`` sort support could be found `here `__.

-  Pure python sort result could be found `here `__

-  PBX sections sorted by MD5 digest result (default in v4.0.0) could be

   found `below `__



add xUnique to Xcode post action

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~



.. figure:: https://raw.github.com/truebit/xUnique/gif/xUnique_Build_Post_Action.gif

   :alt: xUnique\_Build\_Post\_Action



NOTICE

------



-  All project members must add the build post-action or git hook. Thus

   the project file would be consistent in the repository.

-  Tested supported ``isa`` types:



   -  ``PBXProject``

   -  ``XCConfigurationList``

   -  ``PBXNativeTarget``

   -  ``PBXTargetDependency``

   -  ``PBXContainerItemProxy``

   -  ``XCBuildConfiguration``

   -  ``PBXSourcesBuildPhase``

   -  ``PBXFrameworksBuildPhase``

   -  ``PBXResourcesBuildPhase``

   -  ``PBXFrameworksBuildPhase``

   -  ``PBXCopyFilesBuildPhase``

   -  ``PBXHeadersBuildPhase``

   -  ``PBXShellScriptBuildPhase``

   -  ``PBXBuildRule``

   -  ``PBXBuildFile``

   -  ``PBXReferenceProxy``

   -  ``PBXFileReference``

   -  ``PBXGroup``

   -  ``PBXVariantGroup``



Authors

-------



-  Xiao Wang (`seganw `__)



Contributions

-------------



-  I only tested on several single projects and several projects with a

   subproject, so maybe there should be more unconsidered conditions. If

   you get any problem, feel free to fire a Pull Request or Issue



-  You can also buy me a cup of tea: |Donate to xUnique|



License

-------



Licensed under the Apache License, Version 2.0 (the "License"); you may

not use this file except in compliance with the License. You may obtain

a copy of the License at



::



    http://www.apache.org/licenses/LICENSE-2.0



Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.



.. |Donate to xUnique| image:: https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif

   :target: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=QQNATFYESVT76&item_name=xUnique