Detect path of swift-sh tool dynamically

Package.swift

@@ -12,26 +12,26 @@ let package = Package(
         .package(url: "https://github.com/jakeheis/SwiftCLI.git", from: "6.0.1"),
     ],
     targets: [
+        .executableTarget(
+            name: "AnyLintCLI",
+            dependencies: ["Rainbow", "SwiftCLI", "Utility"]
+        ),
         .target(
             name: "AnyLint",
             dependencies: ["Utility"]
         ),
+        .target(
+            name: "Utility",
+            dependencies: ["Rainbow"]
+        ),
         .testTarget(
             name: "AnyLintTests",
             dependencies: ["AnyLint"]
         ),
-        .executableTarget(
-            name: "AnyLintCLI",
-            dependencies: ["Rainbow", "SwiftCLI", "Utility"]
-        ),
         .testTarget(
             name: "AnyLintCLITests",
             dependencies: ["AnyLintCLI"]
         ),
-        .target(
-            name: "Utility",
-            dependencies: ["Rainbow"]
-        ),
         .testTarget(
             name: "UtilityTests",
             dependencies: ["Utility"]

README.md

@@ -90,7 +90,7 @@ anylint --init blank
 This will create the Swift script file `lint.swift` with something like the following contents:
 
 ```swift
-#!/usr/local/bin/swift-sh
+#!/opt/local/bin/swift-sh
 import AnyLint // @Flinesoft
 
 Lint.logSummaryAndExit(arguments: CommandLine.arguments) {
@@ -399,7 +399,7 @@ If you want to use regexes in your custom code, you can learn more about how you
 When using the `customCheck`, you might want to also include some Swift packages for [easier file handling](https://github.com/JohnSundell/Files) or [running shell commands](https://github.com/JohnSundell/ShellOut). You can do so by adding them at the top of the file like so:
 
 ```swift
-#!/usr/local/bin/swift-sh
+#!/opt/local/bin/swift-sh
 import AnyLint // @Flinesoft
 import ShellOut // @JohnSundell
 

Sources/AnyLintCLI/Globals/CLIConstants.swift

@@ -4,5 +4,49 @@ enum CLIConstants {
     static let commandName: String = "anylint"
     static let defaultConfigFileName: String = "lint.swift"
     static let initTemplateCases: String = InitTask.Template.allCases.map { $0.rawValue }.joined(separator: ", ")
-    static let swiftShPath: String = "/usr/local/bin/swift-sh"
+    static var swiftShPath: String {
+        switch self.getPlatform() {
+        case .intel:
+            return "/usr/local/bin/swift-sh"
+
+        case .appleSilicon:
+            return "/opt/homebrew/bin/swift-sh"
+
+        case .linux:
+            return "/home/linuxbrew/.linuxbrew/bin/swift-sh"
+        }
+    }
+}
+
+extension CLIConstants {
+    fileprivate enum Platform {
+        case intel
+        case appleSilicon
+        case linux
+    }
+
+    fileprivate static func getPlatform() -> Platform {
+        #if os(Linux)
+            return .linux
+        #else
+            // Source: https://stackoverflow.com/a/69624732
+            var systemInfo = utsname()
+            let exitCode = uname(&systemInfo)
+
+            let fallbackPlatform: Platform = .appleSilicon
+            guard exitCode == EXIT_SUCCESS else { return fallbackPlatform }
+
+            let cpuArchitecture = String(cString: &systemInfo.machine.0, encoding: .utf8)
+            switch cpuArchitecture {
+            case "x86_64":
+                return .intel
+
+            case "arm64":
+                return .appleSilicon
+
+            default:
+                return fallbackPlatform
+            }
+        #endif
+    }
 }

Sources/AnyLintCLI/Globals/ValidateOrFail.swift

@@ -7,7 +7,7 @@ enum ValidateOrFail {
     static func swiftShInstalled() {
         guard fileManager.fileExists(atPath: CLIConstants.swiftShPath) else {
             log.message(
-                "swift-sh not installed – please follow instructions on https://github.com/mxcl/swift-sh#installation to install.",
+                "swift-sh not installed – please try `brew install swift-sh` or follow instructions on https://github.com/mxcl/swift-sh#installation",
                 level: .error
             )
             log.exit(status: .failure)
@@ -18,7 +18,7 @@ enum ValidateOrFail {
     static func configFileExists(at configFilePath: String) throws {
         guard fileManager.fileExists(atPath: configFilePath) else {
             log.message(
-                "No configuration file found at \(configFilePath) – consider running `\(CLIConstants.commandName) --init` with a template.",
+                "No configuration file found at \(configFilePath) – consider running `--init` with a template, e.g.`\(CLIConstants.commandName) --init blank`.",
                 level: .error
             )
             log.exit(status: .failure)

Sources/AnyLintCLI/Tasks/InitTask.swift

@@ -26,6 +26,8 @@ extension InitTask: TaskHandler {
             return // only reachable in unit tests
         }
 
+        ValidateOrFail.swiftShInstalled()
+
         log.message("Making sure config file directory exists ...", level: .info)
         try Task.run(bash: "mkdir -p '\(configFilePath.parentDirectoryPath)'")
 

lint.swift

@@ -1,4 +1,4 @@
-#!/usr/local/bin/swift-sh
+#!/opt/local/bin/swift-sh
 import AnyLint // .
 import Utility
 import ShellOut // @JohnSundell