Add ability to set an order of groups

CHANGELOG.md

@@ -5,6 +5,7 @@
 - Improve speed of metadata parsing and dependency resolution. [#803](https://github.com/yonaskolb/XcodeGen/pull/803) @michaeleisel
 - Improve support for iOS sticker packs and add support for `launchAutomaticallySubstyle` to run schemes. [#824](https://github.com/yonaskolb/XcodeGen/pull/824) @scelis
 - Add --project-root option to generate command. [#828](https://github.com/yonaskolb/XcodeGen/pull/828) @ileitch
+- Add an ability to set an order of groups with `options.groupOrdering` [#480](https://github.com/yonaskolb/XcodeGen/pull/613) @Beniamiiin
 
 #### Fixed
 - Fixed issue when linking and embeding static frameworks: they should be linked and NOT embed. [#820](https://github.com/yonaskolb/XcodeGen/pull/820) @acecilia

Docs/ProjectSpec.md

@@ -118,6 +118,7 @@ Note that target names can also be changed by adding a `name` property to a targ
   - `none` - sorted alphabetically with all the other files
   - `top` - at the top, before files
   - `bottom` (default) - at the bottom, after other files
+- [ ] **groupOrdering**: **[[GroupOrdering]](#groupOrdering)** - An order of groups.
 - [ ] **transitivelyLinkDependencies**: **Bool** - If this is `true` then targets will link to the dependencies of their target dependencies. If a target should embed its dependencies, such as application and test bundles, it will embed these transitive dependencies as well. Some complex setups might want to set this to `false` and explicitly specify dependencies at every level. Targets can override this with [Target](#target).transitivelyLinkDependencies. Defaults to `false`.
 - [ ] **generateEmptyDirectories**: **Bool** - If this is `true` then empty directories will be added to project too else will be missed. Defaults to `false`.
 - [ ] **findCarthageFrameworks**: **Bool** - When this is set to `true`, all the invididual frameworks for Carthage dependencies will automatically be found. This property can be overriden individually for each carthage dependency - for more details see See **findFrameworks** in the [Dependency](#dependency) section. Defaults to `false`.
@@ -133,6 +134,23 @@ options:
   postGenCommand: pod install
 ```
 
+### GroupOrdering
+
+Describe an order of groups. Available parameters:
+
+- [ ] **pattern**: **String** - A group name pattern. Can be just a single string and also can be a regex pattern. Optional option, if you don't set it, it will pattern for the main group, i.e. the project.
+- [ ] **order**: **[String]** - An order of groups.
+
+```yaml
+options:
+  groupOrdering: 
+    - order: [Sources, Resources, Tests, Support files, Configurations]
+    - pattern: '^.*Screen$'
+      order: [View, Presenter, Interactor, Entities, Assembly]
+```
+
+In this example, we set up the order of two groups. First one is the main group, i.e. the project, note that in this case, we shouldn't set `pattern` option and the second group order is for groups whose names ends with `Screen`.
+
 ### Configs
 
 Each config maps to a build type of either `debug` or `release` which will then apply default build settings to the project. Any value other than `debug` or `release` (for example `none`), will mean no default build settings will be applied to the project.

Sources/ProjectSpec/GroupOrdering.swift

@@ -0,0 +1,32 @@
+import Foundation
+import JSONUtilities
+
+/// Describes an order of groups.
+public struct GroupOrdering: Equatable {
+
+    /// A group name pattern.
+    public var pattern: String
+
+    /// A group name regex.
+    public var regex: NSRegularExpression?
+
+    /// Subgroups orders.
+    public var order: [String]
+
+    public init(pattern: String = "", order: [String] = []) {
+        self.pattern = pattern
+        self.regex = try? NSRegularExpression(pattern: pattern)
+        self.order = order
+    }
+
+}
+
+extension GroupOrdering: JSONObjectConvertible {
+
+    public init(jsonDictionary: JSONDictionary) throws {
+        pattern = jsonDictionary.json(atKeyPath: "pattern") ?? ""
+        regex = try? NSRegularExpression(pattern: pattern)
+        order = jsonDictionary.json(atKeyPath: "order") ?? []
+    }
+
+}

Sources/ProjectSpec/NSRegularExpressionExtensions.swift

@@ -0,0 +1,10 @@
+import Foundation
+
+public extension NSRegularExpression {
+
+    func isMatch(to string: String) -> Bool {
+        let range = NSRange(location: 0, length: string.utf16.count)
+        return self.firstMatch(in: string, options: [], range: range) != nil
+    }
+
+}

Sources/ProjectSpec/SpecOptions.swift

@@ -26,6 +26,7 @@ public struct SpecOptions: Equatable {
     public var defaultConfig: String?
     public var transitivelyLinkDependencies: Bool
     public var groupSortPosition: GroupSortPosition
+    public var groupOrdering: [GroupOrdering]
     public var generateEmptyDirectories: Bool
     public var findCarthageFrameworks: Bool
     public var localPackagesGroup: String?
@@ -85,6 +86,7 @@ public struct SpecOptions: Equatable {
         defaultConfig: String? = nil,
         transitivelyLinkDependencies: Bool = transitivelyLinkDependenciesDefault,
         groupSortPosition: GroupSortPosition = groupSortPositionDefault,
+        groupOrdering: [GroupOrdering] = [],
         generateEmptyDirectories: Bool = generateEmptyDirectoriesDefault,
         findCarthageFrameworks: Bool = findCarthageFrameworksDefault,
         localPackagesGroup: String? = nil,
@@ -107,6 +109,7 @@ public struct SpecOptions: Equatable {
         self.defaultConfig = defaultConfig
         self.transitivelyLinkDependencies = transitivelyLinkDependencies
         self.groupSortPosition = groupSortPosition
+        self.groupOrdering = groupOrdering
         self.generateEmptyDirectories = generateEmptyDirectories
         self.findCarthageFrameworks = findCarthageFrameworks
         self.localPackagesGroup = localPackagesGroup
@@ -137,6 +140,7 @@ extension SpecOptions: JSONObjectConvertible {
         defaultConfig = jsonDictionary.json(atKeyPath: "defaultConfig")
         transitivelyLinkDependencies = jsonDictionary.json(atKeyPath: "transitivelyLinkDependencies") ?? SpecOptions.transitivelyLinkDependenciesDefault
         groupSortPosition = jsonDictionary.json(atKeyPath: "groupSortPosition") ?? SpecOptions.groupSortPositionDefault
+        groupOrdering = jsonDictionary.json(atKeyPath: "groupOrdering") ?? []
         generateEmptyDirectories = jsonDictionary.json(atKeyPath: "generateEmptyDirectories") ?? SpecOptions.generateEmptyDirectoriesDefault
         findCarthageFrameworks = jsonDictionary.json(atKeyPath: "findCarthageFrameworks") ?? SpecOptions.findCarthageFrameworksDefault
         localPackagesGroup = jsonDictionary.json(atKeyPath: "localPackagesGroup")

Sources/XcodeGenKit/PBXProjGenerator.swift

@@ -269,6 +269,7 @@ public class PBXProjGenerator {
 
         mainGroup.children = Array(sourceGenerator.rootGroups)
         sortGroups(group: mainGroup)
+        setupGroupOrdering(group: mainGroup)
         // add derived groups at the end
         derivedGroups.forEach(sortGroups)
         mainGroup.children += derivedGroups
@@ -573,6 +574,53 @@ public class PBXProjGenerator {
         let childGroups = group.children.compactMap { $0 as? PBXGroup }
         childGroups.forEach(sortGroups)
     }
+
+    public func setupGroupOrdering(group: PBXGroup) {
+        let groupOrdering = project.options.groupOrdering.first { groupOrdering in
+            let groupName = group.nameOrPath
+
+            if groupName == groupOrdering.pattern {
+                return true
+            }
+
+            if let regex = groupOrdering.regex {
+                return regex.isMatch(to: groupName)
+            }
+
+            return false
+        }
+
+        if let order = groupOrdering?.order {
+            let files = group.children.filter { $0 is PBXFileReference }
+            var groups = group.children.filter { $0 is PBXGroup }
+
+            var filteredGroups = [PBXFileElement]()
+
+            for groupName in order {
+                guard let group = groups.first(where: { $0.nameOrPath == groupName }) else {
+                    continue
+                }
+
+                filteredGroups.append(group)
+                groups.removeAll { $0 == group }
+            }
+
+            filteredGroups += groups
+
+            switch project.options.groupSortPosition {
+            case .top:
+                group.children = filteredGroups + files
+            case .bottom:
+                group.children = files + filteredGroups
+            default:
+                break
+            }
+        }
+
+        // sort sub groups
+        let childGroups = group.children.compactMap { $0 as? PBXGroup }
+        childGroups.forEach(setupGroupOrdering)
+    }
 
     func getPBXProj(from reference: ProjectReference) throws -> PBXProj {
         if let cachedProject = projects[reference] {