[GSoC] SwiftPM PR

Fixtures/Scripts/EchoArguments/EchoArguments.swift

@@ -0,0 +1,2 @@
+let arguments = CommandLine.arguments.dropFirst()
+print(arguments.map{"\"\($0)\""}.joined(separator: " "))

Fixtures/Scripts/EchoArguments/PackageSyntax.txt

@@ -0,0 +1,6 @@
+{
+  "dependencies" : [
+
+  ],
+  "sourceFile" : "SCRIPT_DIR\/EchoArguments.swift"
+}

Fixtures/Scripts/EchoCWD/EchoCWD.swift

@@ -0,0 +1,4 @@
+@package(name: "CwdDump", path: "cwd-dump")
+import CwdDump
+
+CwdDump.main()

Fixtures/Scripts/EchoCWD/PackageSyntax.txt

@@ -0,0 +1,16 @@
+{
+  "dependencies" : [
+    {
+      "package" : {
+        "raw" : "name:\"CwdDump\",path:\"SCRIPT_DIR\/cwd-dump\"",
+        "path" : "SCRIPT_DIR\/cwd-dump",
+        "name" : "CwdDump"
+      },
+      "modules" : [
+        "CwdDump"
+      ]
+    }
+  ],
+  "sourceFile" : "SCRIPT_DIR\/EchoCWD.swift"
+}
+

Fixtures/Scripts/EchoCWD/cwd-dump/Package.swift

@@ -0,0 +1,19 @@
+// swift-tools-version:5.5
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "CwdDump",
+    products: [
+        // Products define the executables and libraries a package produces, and make them visible to other packages.
+        .library(
+            name: "CwdDump",
+            targets: ["CwdDump"])
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package. A target can define a module or a test suite.
+        // Targets can depend on other targets in this package, and on products in packages this package depends on.
+        .target(name: "CwdDump")
+    ]
+)

Fixtures/Scripts/EchoCWD/cwd-dump/Sources/CwdDump/CwdDump.swift

@@ -0,0 +1,7 @@
+import Foundation
+
+public struct CwdDump {
+    public static func main() {
+        print(FileManager().currentDirectoryPath)
+    }
+}

Package.swift

@@ -152,6 +152,10 @@ let package = Package(
             /** Package model conventions and loading support */
             name: "PackageLoading",
             dependencies: ["SwiftToolsSupport-auto", "Basics", "PackageModel", "SourceControl"]),
+        .target(
+            name: "ScriptingCore",
+            /** Package models for scripting support */
+            dependencies: ["SwiftToolsSupport-auto", "Basics"]),
 
         // MARK: Package Dependency Resolution
 
@@ -213,7 +217,7 @@ let package = Package(
         .target(
             /** High-level commands */
             name: "Commands",
-            dependencies: ["SwiftToolsSupport-auto", "Basics", "Build", "PackageGraph", "SourceControl", "Xcodeproj", "Workspace", "XCBuildSupport", "ArgumentParser", "PackageCollections"]),
+            dependencies: ["SwiftToolsSupport-auto", "Basics", "Build", "PackageGraph", "SourceControl", "Xcodeproj", "Workspace", "XCBuildSupport", "ArgumentParser", "PackageCollections", "ScriptingCore"]),
         .target(
             /** The main executable provided by SwiftPM */
             name: "swift-package",
@@ -230,6 +234,10 @@ let package = Package(
             /** Runs an executable product */
             name: "swift-run",
             dependencies: ["Commands"]),
+        .target(
+            /** Manages and runs a script */
+            name: "swift-script",
+            dependencies: ["Commands"]),
         .target(
             /** Interacts with package collections */
             name: "swift-package-collection",

Sources/Basics/FileSystem+Extensions.swift

@@ -1,7 +1,7 @@
 /*
  This source file is part of the Swift.org open source project
 
- Copyright (c) 2020 Apple Inc. and the Swift project authors
+ Copyright (c) 2020 - 2021 Apple Inc. and the Swift project authors
  Licensed under Apache License v2.0 with Runtime Library Exception
 
  See http://swift.org/LICENSE.txt for license information
@@ -110,3 +110,27 @@ extension FileSystem {
         return idiomaticConfigDirectory
     }
 }
+
+// MARK: - script cache
+
+extension FileSystem {
+    /// SwiftPM cache directory under user's caches directory (if exists)
+    public var swiftScriptCacheDirectory: AbsolutePath {
+        return self.dotSwiftScriptCachesDirectory
+    }
+
+    fileprivate var dotSwiftScriptCachesDirectory: AbsolutePath {
+        return self.dotSwiftPM.appending(component: "scripts")
+    }
+}
+
+extension FileSystem {
+    public func getOrCreateSwiftScriptCacheDirectory() throws -> AbsolutePath {
+        let idiomaticCacheDirectory = self.swiftScriptCacheDirectory
+        // Create if necessary
+        if !self.exists(idiomaticCacheDirectory) {
+            try self.createDirectory(idiomaticCacheDirectory, recursive: true)
+        }
+        return idiomaticCacheDirectory
+    }
+}

Sources/CMakeLists.txt

@@ -22,9 +22,11 @@ add_subdirectory(PackagePlugin)
 add_subdirectory(SPMBuildCore)
 add_subdirectory(SPMLLBuild)
 add_subdirectory(SourceControl)
+add_subdirectory(ScriptingCore)
 add_subdirectory(swift-build)
 add_subdirectory(swift-package)
 add_subdirectory(swift-run)
+add_subdirectory(swift-script)
 add_subdirectory(swift-test)
 add_subdirectory(Workspace)
 add_subdirectory(XCBuildSupport)

Sources/Commands/CMakeLists.txt

@@ -1,6 +1,6 @@
 # This source file is part of the Swift.org open source project
 #
-# Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
+# Copyright (c) 2014 - 2021 Apple Inc. and the Swift project authors
 # Licensed under Apache License v2.0 with Runtime Library Exception
 #
 # See http://swift.org/LICENSE.txt for license information
@@ -18,6 +18,7 @@ add_library(Commands
   SwiftPackageCollectionsTool.swift
   SwiftPackageTool.swift
   SwiftRunTool.swift
+  SwiftScriptTool.swift
   SwiftTestTool.swift
   SwiftTool.swift
   SymbolGraphExtract.swift
@@ -28,6 +29,7 @@ target_link_libraries(Commands PUBLIC
   Build
   PackageCollections
   PackageGraph
+  ScriptingCore
   SourceControl
   TSCBasic
   TSCUtility

Sources/Commands/Error.swift

@@ -37,7 +37,6 @@ extension Error: CustomStringConvertible {
 
 // The name has underscore because of SR-4015.
 func handle(error: Swift.Error) {
-
     switch error {
     case Diagnostics.fatalError:
         break
@@ -55,7 +54,7 @@ func print(error: Any) {
 
 func print(diagnostic: Diagnostic, stdoutStream: OutputByteStream) {
 
-    let writer = InteractiveWriter.stderr
+    let writer = InteractiveWriter(stream: stdoutStream)
 
     if !(diagnostic.location is UnknownLocation) {
         writer.write(diagnostic.location.description)
@@ -79,6 +78,12 @@ func print(diagnostic: Diagnostic, stdoutStream: OutputByteStream) {
     writer.write("\n")
 }
 
+extension Diagnostic: ByteStreamable {
+    public func write(to stream: WritableByteStream) {
+        print(diagnostic: self, stdoutStream: stream)
+    }
+}
+
 /// This class is used to write on the underlying stream.
 ///
 /// If underlying stream is a not tty, the string will be written in without any

Sources/Commands/SwiftRunTool.swift

@@ -236,7 +236,7 @@ public struct SwiftRunTool: SwiftCommand {
 
     /// Executes the executable at the specified path.
     private func run(
-        _ excutablePath: AbsolutePath,
+        _ executablePath: AbsolutePath,
         originalWorkingDirectory: AbsolutePath,
         arguments: [String]) throws
     {
@@ -246,8 +246,8 @@ public struct SwiftRunTool: SwiftCommand {
             try ProcessEnv.chdir(originalWorkingDirectory)
         }
 
-        let pathRelativeToWorkingDirectory = excutablePath.relative(to: originalWorkingDirectory)
-        try exec(path: excutablePath.pathString, args: [pathRelativeToWorkingDirectory.pathString] + arguments)
+        let pathRelativeToWorkingDirectory = executablePath.relative(to: originalWorkingDirectory)
+        try exec(path: executablePath.pathString, args: [pathRelativeToWorkingDirectory.pathString] + arguments)
     }
 
     /// Determines if a path points to a valid swift file.