Swiftpack.co - bloomberg/xcdiff as Swift Package

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
See all packages published by bloomberg.
bloomberg/xcdiff 0.7.0
A tool which helps you diff xcodeproj files.
⭐️ 703
🕓 17 weeks ago
macOS
.package(url: "https://github.com/bloomberg/xcdiff.git", from: "0.7.0")

xcdiff logo

Build Status Coverage Status

xcdiff is an extensible tool that finds differences between two .xcodeproj project files. It can be thought of as git diff for .xcodeproj files, which can be used directly from the command line as well as a library supporting your own set of tools.

How to use xcdiff

Running the command xcdiff in your project directory will search for two .xcodeproj files in this directory and use all of xcdiff's comparators on the projects (e.g. targets, sources and headers).

You can also specify two particular projects for xcdiff to compare.

xcdiff -p1 OriginalProject.xcodeproj -p2 GeneratedProject.xcodeproj

Here is an example output:

xcdiff demo

To see a detailed report of differences you can specify the --verbose (-v) option.

xcdiff -p1 OriginalProject.xcodeproj -p2 GeneratedProject.xcodeproj -v

xcdiff demo -v

Use Cases

  • When adopting project generation (e.g. using tools like XcodeGen or Tuist), comparing the generated xcodeproj files against the original ones can help boost confidence in the migration process.
  • Probably a few more we haven't thought of yet!...

Installation

Documentation

Contributions

All improvements to xcdiff are very welcome!

If you see an issue that you would like to see fixed, the best way to make it happen is to help out by submitting a Pull Request implementing it. Before sending a Pull Request, please make sure you read our Contribution Guidelines. Information in Development Documentation can help you to set up your local development environment.

We also welcome Issue Reports. Be sure to choose the proper issue template for your issue, so that all necessary details are provided.

Attributions

We would like to thank the authors and contributors of the following projects:

Code of Conduct

This project has adopted a Code of Conduct. If you have any concerns about the Code, or behavior which you have experienced in the project, please contact us at opensource@bloomberg.net.

Security Vulnerability Reporting

If you believe you have identified a security vulnerability in this project, please send email to the project team at opensource@bloomberg.net, detailing the suspected issue and any methods you've found to reproduce it.

Please do NOT open an issue in the GitHub repository, as we'd prefer to keep vulnerability reports private until we've had an opportunity to review and address them.

License

xcdiff is released under version 2.0 of the Apache License.

GitHub

link
Stars: 703
Last commit: 3 weeks ago
jonrohan Something's broken? Yell at me @ptrpavlik. Praise and feedback (and money) is also welcome.

Release Notes

0.7.0
17 weeks ago

Notable Changes

  • Include target attributes in the attributes comparator (#86)

All Changes

  • Bump version to 0.7.0 (#92)
  • Fix commands test generator for Xcode 12.5+ (#91)
  • Update version of tools used (#90)
  • Include target attributes in the attributes comparator (#86)
  • Update XcodeProj to 8.0.0 (#84)
  • Ensure fixtures contain the appropriate copyright notices (continued) (#83)
  • Ensure fixtures contain the appropriate copyright notices (#82)
  • Static checksum comparision of codecov script (#80)
  • Run CI with Xcode 12.4 (#79)
  • Update changelog command in release docs (#78)

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics