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,
+      IntegrityCheck.self,
       Test.self,
       VerifySourceCode.self,
     ]

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

@@ -114,9 +114,13 @@ struct Format: ParsableCommand {
   /// 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)
@@ -170,6 +174,8 @@ struct Format: ParsableCommand {
 
   /// 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()
@@ -191,6 +197,8 @@ struct Format: ParsableCommand {
 
   /// 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/IntegrityCheck.swift

@@ -0,0 +1,56 @@
+//===----------------------------------------------------------------------===//
+//
+// 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 IntegrityCheck: ParsableCommand {
+  static var configuration: CommandConfiguration {
+    return 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 {
+    try runCommand("format")
+
+    try runCommand("generate-source-code")
+
+    try runCommand("test", "--use-remote-deps")
+
+    try runCommand("build", "--use-remote-deps")
+  }
+
+  private func runCommand(_ command: String...) throws {
+    try ProcessRunner(
+      executableURL: Paths.swiftExec,
+      arguments: [
+        "run",
+        "--package-path",
+        Paths.devUtilsDir.path,
+        "--package-path",
+        "SwiftSyntaxDevUtils",
+        "swift-syntax-dev-utils",
+      ] + command
+    )
+    .run(
+      captureStdout: false,
+      captureStderr: false,
+      verbose: verbose
+    )
+  }
+}

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

@@ -18,7 +18,7 @@ struct BuildArguments: ParsableArguments {
     help: "The path to the toolchain that shall be used to build SwiftSyntax.",
     transform: URL.init(fileURLWithPath:)
   )
-  var toolchain: URL
+  var toolchain: URL?
 
   @Option(
     help: """
@@ -62,6 +62,14 @@ struct BuildArguments: ParsableArguments {
   )
   var enableTestFuzzing: Bool = false
 
+  @Flag(
+    help: """
+      Switch to using remote dependencies instead of local ones in the unified build process. \
+      When not set, local dependencies are utilized by default.
+      """
+  )
+  var useRemoteDeps: Bool = false
+
   @Flag(help: "Treat all warnings as errors.")
   var warningsAsErrors: Bool = false
 

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

@@ -68,8 +68,8 @@ extension BuildCommand {
 
     args += additionalArguments
 
-    let processRunner = ProcessRunner(
-      executableURL: arguments.toolchain.appendingPathComponent("bin").appendingPathComponent("swift"),
+    let processRunner = try ProcessRunner(
+      executableURL: arguments.toolchain?.appendingPathComponent("bin").appendingPathComponent("swift") ?? Paths.swiftExec,
       arguments: args,
       additionalEnvironment: additionalEnvironment
     )
@@ -116,8 +116,10 @@ extension BuildCommand {
       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 !arguments.useRemoteDeps {
+      // Tell other projects in the unified build to use local dependencies
+      additionalEnvironment["SWIFTCI_USE_LOCAL_DEPS"] = "1"
+    }
 
     return additionalEnvironment
   }

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

@@ -42,6 +42,11 @@ enum Paths {
       .appendingPathComponent("CodeGeneration")
   }
 
+  static var devUtilsDir: URL {
+    packageDir
+      .appendingPathComponent("swift-syntax-dev-utils")
+  }
+
   static var editorExtensionProjectPath: URL {
     packageDir
       .appendingPathComponent("EditorExtension")

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

@@ -18,7 +18,7 @@ struct SourceCodeGeneratorArguments: ParsableArguments {
     help: "The path to the toolchain that shall be used to build SwiftSyntax.",
     transform: URL.init(fileURLWithPath:)
   )
-  var toolchain: URL
+  var toolchain: URL?
 
   @Flag(help: "Enable verbose logging.")
   var verbose: Bool = false

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

@@ -38,8 +38,8 @@ extension SourceCodeGeneratorCommand {
       "SWIFTCI_USE_LOCAL_DEPS": nil,
     ]
 
-    let process = ProcessRunner(
-      executableURL: arguments.toolchain.appendingPathComponent("bin").appendingPathComponent("swift"),
+    let process = try ProcessRunner(
+      executableURL: arguments.toolchain?.appendingPathComponent("bin").appendingPathComponent("swift") ?? Paths.swiftExec,
       arguments: args,
       additionalEnvironment: additionalEnvironment
     )