Improve handling of working directory for Bazel (#838)

Author: ileitch

.mise/tasks/benchmark

@@ -8,7 +8,7 @@ cmd=""
 if [ "$usage_bazel" = "true" ]; then
     echo "INFO: Using Bazel"
     bazel build //:periphery
-    cmd='bazel-bin/Sources/Frontend scan --config /var/tmp/periphery_bazel/periphery.yml --generic-project-config bazel-bin/external/+generated+periphery_generated/rule/project_config.json'
+    cmd='bazel-bin/Sources/Frontend_opt scan --config /var/tmp/periphery_bazel/periphery.yml --generic-project-config bazel-bin/external/+generated+periphery_generated/rule/project_config.json'
 else
     mise r build --arch arm64
     cmd='./.build/release/periphery scan --quiet --skip-build'

BUILD.bazel

@@ -10,10 +10,7 @@ package_group(
     packages = ["//..."],
 )
 
-sh_binary(
+alias(
     name = "periphery",
-    srcs = ["//bazel/internal:run.sh"],
-    data = [
-        "//Sources:Frontend_opt",
-    ],
+    actual = "//Sources:Frontend_opt",
 )

MODULE.bazel

@@ -13,7 +13,7 @@ bazel_dep(name = "apple_support", version = "1.17.1")
 # Swift dependencies
 bazel_dep(name = "aexml", version = "4.7.0")
 bazel_dep(name = "swift_argument_parser", version = "1.5.0")
-bazel_dep(name = "swift-filename-matcher", version = "0.1.2")
+bazel_dep(name = "swift-filename-matcher", version = "2.0.0")
 bazel_dep(name = "swift-indexstore", version = "0.3.0")
 bazel_dep(name = "swift-syntax", version = "600.0.1")
 bazel_dep(name = "swift-system", version = "1.4.0")

MODULE.bazel.lock

@@ -8,7 +8,7 @@ var dependencies: [Package.Dependency] = [
     .package(url: "https://github.com/apple/swift-argument-parser", from: "1.0.0"),
     .package(url: "https://github.com/kateinoigakukun/swift-indexstore", from: "0.3.0"),
     .package(url: "https://github.com/apple/swift-syntax", from: "600.0.1"),
-    .package(url: "https://github.com/ileitch/swift-filename-matcher", from: "0.0.0"),
+    .package(url: "https://github.com/ileitch/swift-filename-matcher", from: "2.0.0"),
 ]
 
 #if os(macOS)

Package.resolved

@@ -19,6 +19,6 @@ public extension FilenameMatcher {
         let normalizedBase = traversedBase.hasSuffix("/") ? traversedBase : "\(traversedBase)/"
         let shouldPrependPwd = !["/", "*"].contains { relativePattern.hasPrefix($0) }
         let pattern = shouldPrependPwd ? "\(normalizedBase)\(traversedPattern)" : traversedPattern
-        self.init(pattern: pattern, caseSensitive: caseSensitive)
+        self.init(pattern: pattern, options: caseSensitive ? [.caseSensitive] : [])
     }
 }

Package.swift

@@ -18,6 +18,9 @@ struct ScanCommand: FrontendCommand {
     @Flag(help: "Enable guided setup")
     var setup: Bool = defaultConfiguration.guidedSetup
 
+    @Option(help: "Path to the root directory of your project")
+    var projectRoot: FilePath = projectRootDefault
+
     @Option(help: "Path to configuration file. By default Periphery will look for .periphery.yml in the current directory")
     var config: FilePath?
 
@@ -138,6 +141,10 @@ struct ScanCommand: FrontendCommand {
     private static let defaultConfiguration = Configuration()
 
     func run() throws {
+        if !FileManager.default.changeCurrentDirectoryPath(projectRoot.string) {
+            throw PeripheryError.changeCurrentDirectoryFailed(projectRoot)
+        }
+
         let configuration = Configuration()
 
         if !setup {
@@ -245,6 +252,14 @@ struct ScanCommand: FrontendCommand {
             throw PeripheryError.foundIssues(count: filteredResults.count)
         }
     }
+
+    // MARK: - Private
+
+    private static var projectRootDefault: FilePath {
+        let bazelWorkspace = ProcessInfo.processInfo.environment["BUILD_WORKSPACE_DIRECTORY"]
+        let root = bazelWorkspace ?? FileManager.default.currentDirectoryPath
+        return FilePath(root)
+    }
 }
 
 extension OutputFormat: ExpressibleByArgument {}

Sources/Extensions/FilenameMatcher+Extension.swift

@@ -18,6 +18,7 @@ public enum PeripheryError: Error, LocalizedError, CustomStringConvertible {
     case swiftVersionUnsupportedError(version: String, minimumVersion: String)
     case jsonDeserializationError(error: Error, json: String)
     case indexStoreNotFound(derivedDataPath: String)
+    case changeCurrentDirectoryFailed(FilePath)
 
     public var errorDescription: String? {
         switch self {
@@ -55,6 +56,8 @@ public enum PeripheryError: Error, LocalizedError, CustomStringConvertible {
             return "JSON deserialization failed: \(describe(error))\nJSON:\n\(json)"
         case let .indexStoreNotFound(derivedDataPath):
             return "Failed to find index datastore at path: \(derivedDataPath)"
+        case let .changeCurrentDirectoryFailed(path):
+            return "Failed to change current directory to: \(path)"
         }
     }
 

Sources/Frontend/Commands/ScanCommand.swift

@@ -1,3 +0,0 @@
-exports_files([
-    "run.sh",
-])