Add one script to run them all

Add the script to the swift-syntax dev utils package to allow developers run all necessary actions before submitting a PR

Author: Matejkob

SwiftSyntaxDevUtils/Sources/swift-syntax-dev-utils/SwiftSyntaxDevUtils.swift

@@ -28,6 +28,7 @@ struct SwiftSyntaxDevUtils: ParsableCommand {
       Build.self,
       Format.self,
       GenerateSourceCode.self,
+      LocalPrPrecheck.self,
       Test.self,
       VerifySourceCode.self,
     ]

SwiftSyntaxDevUtils/Sources/swift-syntax-dev-utils/commands/Format.swift

@@ -163,9 +163,13 @@ struct FormatExecutor {
   /// Ensure that we have an up-to-date checkout of swift-format in `.swift-format-build`.
   private func cloneOrUpdateSwiftFormat() throws {
     if FileManager.default.fileExists(atPath: Paths.swiftFormatBuildDir.appendingPathComponent(".git").path) {
+      logSection("Updating swift-format")
+
       try runGitCommand("checkout", Self.swiftFormatBranch)
       try runGitCommand("pull")
     } else {
+      logSection("Cloning swift-format")
+
       try FileManager.default.createDirectory(atPath: Paths.swiftFormatBuildDir.path, withIntermediateDirectories: true)
       try runGitCommand("clone", "https://github.com/apple/swift-format.git", ".")
       try runGitCommand("checkout", Self.swiftFormatBranch)
@@ -219,6 +223,8 @@ struct FormatExecutor {
 
   /// Format all files in the repo using the locally-built swift-format.
   private func formatFilesInRepo() throws {
+    logSection("Formatting code with swift-format")
+
     let swiftFormatExecutable = try findSwiftFormatExecutable()
 
     let filesToFormat = self.filesToFormat()
@@ -240,6 +246,8 @@ struct FormatExecutor {
 
   /// Lint all files in the repo using the locally-built swift-format.
   private func lintFilesInRepo() throws {
+    logSection("Running swift-format linter")
+
     let swiftFormatExecutable = try findSwiftFormatExecutable()
 
     let filesToFormat = self.filesToFormat()

SwiftSyntaxDevUtils/Sources/swift-syntax-dev-utils/commands/GenerateSourceCode.swift

@@ -32,7 +32,7 @@ struct GenerateSourceCode: ParsableCommand {
 
 struct GenerateSourceCodeExecutor {
   /// The path to the toolchain that shall be used to build SwiftSyntax.
-  private let toolchain: URL
+  private let toolchain: URL?
 
   /// Enable verbose logging.
   private let verbose: Bool
@@ -41,7 +41,7 @@ struct GenerateSourceCodeExecutor {
   /// - Parameters:
   ///   - toolchain: The path to the toolchain that shall be used to build SwiftSyntax.
   ///   - verbose: Enable verbose logging.
-  init(toolchain: URL, verbose: Bool = false) {
+  init(toolchain: URL?, verbose: Bool = false) {
     self.toolchain = toolchain
     self.verbose = verbose
   }
@@ -65,8 +65,8 @@ struct GenerateSourceCodeExecutor {
       "SWIFTCI_USE_LOCAL_DEPS": nil,
     ]
 
-    let process = ProcessRunner(
-      executableURL: toolchain.appendingPathComponent("bin").appendingPathComponent("swift"),
+    let process = try ProcessRunner(
+      executableURL: toolchain?.appendingPathComponent("bin").appendingPathComponent("swift") ?? Paths.swiftExec,
       arguments: args,
       additionalEnvironment: additionalEnvironment
     )

SwiftSyntaxDevUtils/Sources/swift-syntax-dev-utils/commands/LocalPrPrecheck.swift

@@ -0,0 +1,51 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2023 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import ArgumentParser
+import Foundation
+
+struct LocalPrPrecheck: ParsableCommand {
+  static let configuration = CommandConfiguration(
+    abstract: """
+      Ensure changes are fully tested, formatted, and validated before pull request submission.
+      """
+  )
+
+  @Flag(help: "Enable verbose logging.")
+  var verbose: Bool = false
+
+  func run() throws {
+    let executor = LocalPrPrecheckExecutor(verbose: verbose)
+    try executor.run()
+  }
+}
+
+struct LocalPrPrecheckExecutor {
+  private let formatExecutor: FormatExecutor
+  private let generateSourceCodeExecutor: GenerateSourceCodeExecutor
+  private let buildExecutor: BuildExecutor
+  private let testExecutor: TestExecutor
+
+  init(verbose: Bool = false) {
+    self.formatExecutor = FormatExecutor(update: false)
+    self.generateSourceCodeExecutor = GenerateSourceCodeExecutor(toolchain: nil, verbose: verbose)
+    self.buildExecutor = BuildExecutor(swiftPMBuilder: SwiftPMBuilder(toolchain: nil, useLocalDeps: false))
+    self.testExecutor = TestExecutor(swiftPMBuilder: SwiftPMBuilder(toolchain: nil, useLocalDeps: false))
+  }
+
+  func run() throws {
+    try formatExecutor.run()
+    try generateSourceCodeExecutor.run(sourceDir: Paths.sourcesDir)
+    try buildExecutor.run()
+    try testExecutor.run()
+  }
+}

SwiftSyntaxDevUtils/Sources/swift-syntax-dev-utils/common/SwiftPMBuilder.swift

@@ -15,7 +15,7 @@ import Foundation
 /// Wrapper around `swift build` and `swift test` to build and test SwiftPM packages.
 struct SwiftPMBuilder {
   /// The path to the toolchain that shall be used to build SwiftSyntax.
-  let toolchain: URL
+  let toolchain: URL?
 
   /// The directory in which build products shall be put.
   ///
@@ -38,19 +38,23 @@ struct SwiftPMBuilder {
   /// no round-trip or assertion failures.
   let enableTestFuzzing: Bool
 
+  /// A flag indicating whether to use local dependencies during the build process.
+  let useLocalDeps: Bool
+
   /// Treat all warnings as errors.
   let warningsAsErrors: Bool
 
   /// Enable verbose logging.
   let verbose: Bool
 
   init(
-    toolchain: URL,
+    toolchain: URL?,
     buildDir: URL? = nil,
     multirootDataFile: URL? = nil,
     release: Bool = false,
     enableRawSyntaxValidation: Bool = false,
     enableTestFuzzing: Bool = false,
+    useLocalDeps: Bool = true,
     warningsAsErrors: Bool = false,
     verbose: Bool = false
   ) {
@@ -60,6 +64,7 @@ struct SwiftPMBuilder {
     self.release = release
     self.enableRawSyntaxValidation = enableRawSyntaxValidation
     self.enableTestFuzzing = enableTestFuzzing
+    self.useLocalDeps = useLocalDeps
     self.warningsAsErrors = warningsAsErrors
     self.verbose = verbose
   }
@@ -110,8 +115,8 @@ struct SwiftPMBuilder {
 
     args += additionalArguments
 
-    let processRunner = ProcessRunner(
-      executableURL: toolchain.appendingPathComponent("bin").appendingPathComponent("swift"),
+    let processRunner = try ProcessRunner(
+      executableURL: toolchain?.appendingPathComponent("bin").appendingPathComponent("swift") ?? Paths.swiftExec,
       arguments: args,
       additionalEnvironment: additionalEnvironment
     )
@@ -139,8 +144,10 @@ struct SwiftPMBuilder {
       additionalEnvironment["SWIFTPARSER_ENABLE_ALTERNATE_TOKEN_INTROSPECTION"] = "1"
     }
 
-    // Tell other projects in the unified build to use local dependencies
-    additionalEnvironment["SWIFTCI_USE_LOCAL_DEPS"] = "1"
+    if useLocalDeps {
+      // Tell other projects in the unified build to use local dependencies
+      additionalEnvironment["SWIFTCI_USE_LOCAL_DEPS"] = "1"
+    }
 
     return additionalEnvironment
   }