Merge 2f2fd65370 into f51719ce29

* add cache command

* docs: update git hook info

CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## Next Version
 
+## 2.41.0
+
+### Added
+
+- Added `xcodegen cache` command that writes the cache. Useful for `post-commit` git hook integration #1476 @yonaskolb
+
+### Changed
+
+- Include folders in file sorting #1466 @jflan-dd
+
 ### Fixed
 
 - Fixed `supportedDestinations` validation when it contains watchOS for multiplatform apps. #1470 @tatsuky
@@ -133,6 +143,8 @@
 - Config setting presets can now also be loaded from the main bundle when bundling XcodeGenKit #1135 @SofteqDG
 - Added ability to generate multiple projects in one XcodeGen launch #1270 @skofgar
 - Use memoization during recursive SpecFiles creation. This provides a drastic performance boost with lots of recursive includes #1275 @ma-oli
+- Added `--render-markdowns` command flag to generate the `.xcodesamplecode.plist` inside the project container and let Xcode render the markdown files with `md` extension.
+- Added `renderMarkdown` spec option generate the `.xcodesamplecode.plist` inside the project container and let Xcode render the markdown files with `md` extension.
 
 ### Fixed
 

Docs/FAQ.md

@@ -9,10 +9,14 @@ Absolutely. You will get the most out of XcodeGen by adding your project to your
 >Note that you can run `xcodegen` as a step in your build process on CI.
 
 ## What happens when I switch branches
-If files were added or removed in the new checkout you will most likely need to run `xcodegen` again so that your project will reference all your files. Unfortunately this is a manual step at the moment, but in the future this could be automated.
+If files were added or removed in the new checkout you will most likely need to run `xcodegen` again so that your project will reference all your files.
 
-For now you can always add xcodegen as a git `post-checkout` hook.
-It's recommended to use `--use-cache` so that the project is not needlessly generated.
+It's recommended to set up some [git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) to automate the process:
+- run `xcodegen generate --use-cache` on the following hooks. This will make sure the project is up to date when checking out, merging and rebasing
+  - `post-checkout`
+  - `post-rewrite`
+  - `post-merge`
+- run `xcodegen cache` on `pre-commit`. This will make sure that when switching branches the cache will be updated in case you made local changes, or are ammending a commit that added a new file.
  
 ## Can I use CocoaPods
 Yes, you will just need to run `pod install` after the project is generated to integrate Cocoapods changes.

Makefile

@@ -1,6 +1,6 @@
 TOOL_NAME = XcodeGen
 export EXECUTABLE_NAME = xcodegen
-VERSION = 2.40.1
+VERSION = 2.41.0
 
 PREFIX = /usr/local
 INSTALL_PATH = $(PREFIX)/bin/$(EXECUTABLE_NAME)

README.md

@@ -113,7 +113,7 @@ swift run xcodegen
 Add the following to your Package.swift file's dependencies:
 
 ```swift
-.package(url: "https://github.com/yonaskolb/XcodeGen.git", from: "2.40.1"),
+.package(url: "https://github.com/yonaskolb/XcodeGen.git", from: "2.41.0"),
 ```
 
 And then import wherever needed: `import XcodeGenKit`

Sources/ProjectSpec/SpecOptions.swift

@@ -16,6 +16,7 @@ public struct SpecOptions: Equatable {
     public var carthageBuildPath: String?
     public var carthageExecutablePath: String?
     public var createIntermediateGroups: Bool
+    public var renderMarkdowns: Bool?
     public var bundleIdPrefix: String?
     public var settingPresets: SettingPresets
     public var disabledValidations: [ValidationType]
@@ -80,6 +81,7 @@ public struct SpecOptions: Equatable {
         carthageBuildPath: String? = nil,
         carthageExecutablePath: String? = nil,
         createIntermediateGroups: Bool = createIntermediateGroupsDefault,
+        renderMarkdowns: Bool? = nil,
         bundleIdPrefix: String? = nil,
         settingPresets: SettingPresets = settingPresetsDefault,
         developmentLanguage: String? = nil,
@@ -106,6 +108,7 @@ public struct SpecOptions: Equatable {
         self.carthageBuildPath = carthageBuildPath
         self.carthageExecutablePath = carthageExecutablePath
         self.createIntermediateGroups = createIntermediateGroups
+        self.renderMarkdowns = renderMarkdowns
         self.bundleIdPrefix = bundleIdPrefix
         self.settingPresets = settingPresets
         self.developmentLanguage = developmentLanguage
@@ -142,6 +145,7 @@ extension SpecOptions: JSONObjectConvertible {
         bundleIdPrefix = jsonDictionary.json(atKeyPath: "bundleIdPrefix")
         settingPresets = jsonDictionary.json(atKeyPath: "settingPresets") ?? SpecOptions.settingPresetsDefault
         createIntermediateGroups = jsonDictionary.json(atKeyPath: "createIntermediateGroups") ?? SpecOptions.createIntermediateGroupsDefault
+        renderMarkdowns = jsonDictionary.json(atKeyPath: "renderMarkdowns")
         developmentLanguage = jsonDictionary.json(atKeyPath: "developmentLanguage")
         usesTabs = jsonDictionary.json(atKeyPath: "usesTabs")
         xcodeVersion = jsonDictionary.json(atKeyPath: "xcodeVersion")

Sources/XcodeGen/main.swift

@@ -3,6 +3,6 @@ import ProjectSpec
 import XcodeGenCLI
 import Version
 
-let version = Version("2.40.1")
+let version = Version("2.41.0")
 let cli = XcodeGenCLI(version: version)
 cli.execute()

Sources/XcodeGenCLI/Commands/CacheCommand.swift

@@ -0,0 +1,44 @@
+import Foundation
+import PathKit
+import ProjectSpec
+import SwiftCLI
+import XcodeGenKit
+import XcodeProj
+import Version
+
+class CacheCommand: ProjectCommand {
+
+    @Key("--cache-path", description: "Where the cache file will be loaded from and save to. Defaults to ~/.xcodegen/cache/{SPEC_PATH_HASH}")
+    var cacheFilePath: Path?
+
+    init(version: Version) {
+        super.init(version: version,
+                   name: "cache",
+                   shortDescription: "Write the project cache")
+    }
+
+    override func execute(specLoader: SpecLoader, projectSpecPath: Path, project: Project) throws {
+
+        let cacheFilePath = self.cacheFilePath ?? Path("~/.xcodegen/cache/\(projectSpecPath.absolute().string.md5)").absolute()
+
+        var cacheFile: CacheFile?
+
+        // generate cache
+        do {
+            cacheFile = try specLoader.generateCacheFile()
+        } catch {
+            throw GenerationError.projectSpecParsingError(error)
+        }
+
+        // write cache
+        if let cacheFile = cacheFile {
+            do {
+                try cacheFilePath.parent().mkpath()
+                try cacheFilePath.write(cacheFile.string)
+                success("Wrote cache to \(cacheFilePath)")
+            } catch {
+                info("Failed to write cache: \(error.localizedDescription)")
+            }
+        }
+    }
+}

Sources/XcodeGenCLI/Commands/DumpCommand.swift

@@ -49,7 +49,7 @@ class DumpCommand: ProjectCommand {
             try file.parent().mkpath()
             try file.write(output)
         } else {
-            stdout.print(output)
+            success(output)
         }
     }
 }

Sources/XcodeGenCLI/Commands/GenerateCommand.swift

@@ -8,9 +8,6 @@ import Version
 
 class GenerateCommand: ProjectCommand {
 
-    @Flag("-q", "--quiet", description: "Suppress all informational and success output")
-    var quiet: Bool
-
     @Flag("-c", "--use-cache", description: "Use a cache for the xcodegen spec. This will prevent unnecessarily generating the project if nothing has changed")
     var useCache: Bool
 
@@ -22,6 +19,9 @@ class GenerateCommand: ProjectCommand {
 
     @Flag("--only-plists", description: "Generate only plist files")
     var onlyPlists: Bool
+    
+    @Flag("--render-markdowns", description: "Render markdown files with `.md` extension")
+    var renderMarkdowns: Bool
 
     init(version: Version) {
         super.init(version: version,
@@ -46,7 +46,7 @@ class GenerateCommand: ProjectCommand {
             Path("~/.xcodegen/cache/\(projectSpecPath.absolute().string.md5)").absolute()
         var cacheFile: CacheFile?
 
-        // read cache
+        // generate cache
         if useCache || self.cacheFilePath != nil {
             do {
                 cacheFile = try specLoader.generateCacheFile()
@@ -122,6 +122,39 @@ class GenerateCommand: ProjectCommand {
         } catch {
             throw GenerationError.writingError(error)
         }
+        
+        switch project.options.renderMarkdowns {
+        case .some(true):
+            do {
+                try fileWriter.writeMarkdownRendererPlist()
+                success("Xcode markdown rendering enabled")
+            } catch {
+                throw GenerationError.writingError(error)
+            }
+        case .some(false):
+            do {
+                try fileWriter.deleteMarkdownRendererPlist()
+                success("Xcode markdown rendering disabled")
+            } catch {
+                info("Failed to disable Xcode markdown rendering: \(error.localizedDescription)")
+            }
+        case .none: break
+            // No need for change
+        }
+        
+        // add markdown renderer if needed
+        /// - Note: this flag will override the spec option
+        if renderMarkdowns && project.options.renderMarkdowns != true {
+            do {
+                if project.options.renderMarkdowns == false {
+                    info("Overriding markdown rendering option because of the given --render-markdowns flag")
+                }
+                try fileWriter.writeMarkdownRendererPlist()
+                success("Xcode markdown rendering enabled")
+            } catch {
+                throw GenerationError.writingError(error)
+            }
+        }
 
         // write cache
         if let cacheFile = cacheFile {
@@ -138,22 +171,4 @@ class GenerateCommand: ProjectCommand {
             try Task.run(bash: command, directory: projectDirectory.absolute().string)
         }
     }
-
-    func info(_ string: String) {
-        if !quiet {
-            stdout.print(string)
-        }
-    }
-
-    func warning(_ string: String) {
-        if !quiet {
-            stdout.print(string.yellow)
-        }
-    }
-
-    func success(_ string: String) {
-        if !quiet {
-            stdout.print(string.green)
-        }
-    }
 }

Sources/XcodeGenCLI/Commands/ProjectCommand.swift

@@ -12,6 +12,9 @@ class ProjectCommand: Command {
     let name: String
     let shortDescription: String
 
+    @Flag("-q", "--quiet", description: "Suppress all informational and success output")
+    var quiet: Bool
+    
     @Key("-s", "--spec", description: "The path to the project spec file. Defaults to project.yml. (It is also possible to link to multiple spec files by comma separating them. Note that all other flags will be the same.)")
     var spec: String?
 
@@ -58,4 +61,22 @@ class ProjectCommand: Command {
     }
 
     func execute(specLoader: SpecLoader, projectSpecPath: Path, project: Project) throws {}
+
+    func info(_ string: String) {
+        if !quiet {
+            stdout.print(string)
+        }
+    }
+
+    func warning(_ string: String) {
+        if !quiet {
+            stdout.print(string.yellow)
+        }
+    }
+
+    func success(_ string: String) {
+        if !quiet {
+            stdout.print(string.green)
+        }
+    }
 }

Sources/XcodeGenCLI/XcodeGenCLI.swift

@@ -15,6 +15,7 @@ public class XcodeGenCLI {
             description: "Generates Xcode projects",
             commands: [
                 generateCommand,
+                CacheCommand(version: version),
                 DumpCommand(version: version),
             ]
         )

Sources/XcodeGenKit/FileWriter.swift

@@ -40,6 +40,16 @@ public class FileWriter {
             }
         }
     }
+    
+    public func writeMarkdownRendererPlist() throws {
+        let path = project.defaultProjectPath + ".xcodesamplecode.plist"
+        try writePlist([:], path: path.string)
+    }
+
+    public func deleteMarkdownRendererPlist() throws {
+        let path = project.defaultProjectPath + ".xcodesamplecode.plist"
+        try path.delete()
+    }
 
     private func writePlist(_ plist: [String: Any], path: String) throws {
         let path = project.basePath + path