Simplify structure of artifact bundle (#6239)

Author: SimplyDanny

CHANGELOG.md

@@ -4,7 +4,18 @@
 
 ### Breaking
 
-* None.
+* The structure of `SwiftLintBinary.artifactbundle.zip` is now simpler. Internal paths no
+  longer contain version numbers, especially. So in an Xcode Run Script build phase,
+  you can refer to the `swiftlint` binary like this:
+
+  ```bash
+  SWIFT_PACKAGE_DIR="${BUILD_DIR%Build/*}SourcePackages/artifacts"
+  SWIFTLINT_CMD="$SWIFT_PACKAGE_DIR/swiftlintplugins/SwiftLintBinary/SwiftLintBinary.artifactbundle/macos/swiftlint"
+  ```
+  
+  All other consumers of the artifact bundle do not need to change anything. Swift Package
+  Manager resolves the new paths automatically.  
+  [SimplyDanny](https://github.com/SimplyDanny)
 
 ### Experimental
 

Makefile

@@ -107,12 +107,11 @@ portable_zip: installables
 	(cd "$(TEMPORARY_FOLDER)"; zip -yr - "swiftlint" "LICENSE") > "./portable_swiftlint.zip"
 
 spm_artifactbundle: swiftlint swiftlint_linux_amd64 swiftlint_linux_arm64
-	mkdir -p "$(ARTIFACT_BUNDLE_PATH)/swiftlint-$(VERSION_STRING)-macos/bin"
-	mkdir -p "$(ARTIFACT_BUNDLE_PATH)/swiftlint-$(VERSION_STRING)-linux-gnu/bin"
+	mkdir -p "$(ARTIFACT_BUNDLE_PATH)/macos" "$(ARTIFACT_BUNDLE_PATH)/linux/{amd,arm}64"
 	sed 's/__VERSION__/$(VERSION_STRING)/g' tools/info.json.template > "$(ARTIFACT_BUNDLE_PATH)/info.json"
-	cp -f swiftlint "$(ARTIFACT_BUNDLE_PATH)/swiftlint-$(VERSION_STRING)-macos/bin/swiftlint"
-	cp -f swiftlint_linux_amd64 "$(ARTIFACT_BUNDLE_PATH)/swiftlint-$(VERSION_STRING)-linux-gnu/bin/swiftlint_amd64"
-	cp -f swiftlint_linux_arm64 "$(ARTIFACT_BUNDLE_PATH)/swiftlint-$(VERSION_STRING)-linux-gnu/bin/swiftlint_arm64"
+	cp -f swiftlint "$(ARTIFACT_BUNDLE_PATH)/macos/swiftlint"
+	cp -f swiftlint_linux_amd64 "$(ARTIFACT_BUNDLE_PATH)/linux/amd64/swiftlint"
+	cp -f swiftlint_linux_arm64 "$(ARTIFACT_BUNDLE_PATH)/linux/arm64/swiftlint"
 	cp -f LICENSE "$(ARTIFACT_BUNDLE_PATH)"
 	(cd "$(TEMPORARY_FOLDER)"; zip -yr - "SwiftLintBinary.artifactbundle") > "./SwiftLintBinary.artifactbundle.zip"
 

Package.swift

@@ -14,14 +14,6 @@ let swiftFeatures: [SwiftSetting] = [
 let strictConcurrency = [SwiftSetting.enableExperimentalFeature("StrictConcurrency=complete")]
 let targetedConcurrency = [SwiftSetting.enableExperimentalFeature("StrictConcurrency=targeted")]
 
-let swiftLintPluginDependencies: [Target.Dependency]
-
-#if os(macOS)
-swiftLintPluginDependencies = [.target(name: "SwiftLintBinary")]
-#else
-swiftLintPluginDependencies = [.target(name: "swiftlint")]
-#endif
-
 let package = Package(
     name: "SwiftLint",
     platforms: [.macOS(.v13)],
@@ -72,7 +64,7 @@ let package = Package(
         .plugin(
             name: "SwiftLintBuildToolPlugin",
             capability: .buildTool(),
-            dependencies: swiftLintPluginDependencies,
+            dependencies: [.target(name: "SwiftLintBinary")],
             packageAccess: false
         ),
         .plugin(
@@ -85,7 +77,7 @@ let package = Package(
                     ),
                 ]
             ),
-            dependencies: swiftLintPluginDependencies,
+            dependencies: [.target(name: "SwiftLintBinary")],
             packageAccess: false
         ),
         .target(
@@ -212,15 +204,10 @@ let package = Package(
             path: "Tests/TestHelpers",
             swiftSettings: swiftFeatures + strictConcurrency
         ),
+        .binaryTarget(
+            name: "SwiftLintBinary",
+            url: "https://github.com/realm/SwiftLint/releases/download/0.61.0/SwiftLintBinary.artifactbundle.zip",
+            checksum: "b765105fa5c5083fbcd35260f037b9f0d70e33992d0a41ba26f5f78a17dc65e7"
+        ),
     ]
 )
-
-#if os(macOS)
-package.targets.append(
-    .binaryTarget(
-        name: "SwiftLintBinary",
-        url: "https://github.com/realm/SwiftLint/releases/download/0.61.0/SwiftLintBinary.artifactbundle.zip",
-        checksum: "b765105fa5c5083fbcd35260f037b9f0d70e33992d0a41ba26f5f78a17dc65e7"
-    )
-)
-#endif

README.md

@@ -339,13 +339,13 @@ following way:
 
 ```bash
 SWIFT_PACKAGE_DIR="${BUILD_DIR%Build/*}SourcePackages/artifacts"
-SWIFTLINT_CMD=$(ls "$SWIFT_PACKAGE_DIR"/swiftlintplugins/SwiftLintBinary/SwiftLintBinary.artifactbundle/swiftlint-*-macos/bin/swiftlint | head -n 1)
+SWIFTLINT_CMD="$SWIFT_PACKAGE_DIR/swiftlintplugins/SwiftLintBinary/SwiftLintBinary.artifactbundle/macos/swiftlint"
 
 if test -f "$SWIFTLINT_CMD" 2>&1
 then
     "$SWIFTLINT_CMD"
 else
-    echo "warning: `swiftlint` command not found - See https://github.com/realm/SwiftLint#installation for installation instructions."
+    echo "warning: `swiftlint` command not found - See https://github.com/realm/SwiftLint#xcode-run-script-build-phase for installation instructions."
 fi
 ```
 

tools/info.json.template

@@ -6,15 +6,15 @@
             "type": "executable",
             "variants": [
                 {
-                    "path": "swiftlint-__VERSION__-macos/bin/swiftlint",
+                    "path": "macos/swiftlint",
                     "supportedTriples": ["x86_64-apple-macosx", "arm64-apple-macosx"]
                 },
                 {
-                    "path": "swiftlint-__VERSION__-linux-gnu/bin/swiftlint_amd64",
-                    "supportedTriples": ["x86_64-unknown-linux-gnu"]
+                    "path": "linux/amd64/swiftlint",
+                    "supportedTriples": ["x86_64-unknown-linux-gnu", "amd64-unknown-linux-gnu"]
                 },
                 {
-                    "path": "swiftlint-__VERSION__-linux-gnu/bin/swiftlint_arm64",
+                    "path": "linux/arm64/swiftlint",
                     "supportedTriples": ["aarch64-unknown-linux-gnu", "arm64-unknown-linux-gnu"]
                 }
             ]