Support auto-correct

[finnvoor]

Hi! The new buildFilesAreOrderedRule looks great, and I would love to add an optional rule to ensure files in a group are sorted alphabetically, but actually correcting these issues manually in the pbxproj is a nightmare. It would be great if some rules could provide auto corrections when adding a --fix flag or whatever, similar to SwiftLint or SwiftFormat.

[mattmassicotte]

Thank you for this idea! I'd like to add a check for group ordering as well: #7.

XcodeProj can do this I think. It is capable of writing out Xcode projects. I don't fully understand the implications, if any, but I think it's definitely worth exploring. I'm more focused, right now, on the foundational stuff so this can actually be usable. Next up is support for configuration. But, I'm excited to play around with this, I think it could be wonderful.

[finnvoor]

Took a stab at this but it looks like XcodeProj doesn't support editing group order / any group edits at all at the moment, so might need some changes to XcodeProj.

PBXProj is mostly read-only: https://github.com/tuist/XcodeProj/blob/069cdafc08cd8519104a7ae2db6ac1916e17ca0d/Sources/XcodeProj/Objects/Project/PBXProj.swift#L198-L228

[mattmassicotte]

Huh, that's surprising. I was under the impression it was used to produce xcodeproj files as output. I wonder if there is a separate system for doing the generation?

[finnvoor]

There's methods that Tuist uses to create groups / add files to a group (see here), but there isn't any way to modify the order of files in a group that's already created, so we would have to recreate the PBXProj from scratch I think.

[mattmassicotte]

Oh I misunderstood. Yes, I think you're right, you'd have to re-create the entire PBXProj structure. Still pretty annoying.