Shell 2.2.0

Shell 2.2.0

Peñdo Piñнера维护。



Shell 2.2.0

🧪 Shell

Shell 是一个用 Swift 编写的 µ-library,用于执行 shell 任务。

CircleCI Swift Package Manager Release Code Coverage Slack License

安装🛠

Swift 包管理器

在您的 Package.swift 文件中添加依赖项

let package = Package(
    name: "myproject",
    dependencies: [
        .package(url: "https://github.com/tuist/shell.git", .upToNextMajor(from: "2.2.0")),
        ],
    targets: [
        .target(
            name: "myproject",
            dependencies: ["Shell"]),
        ]
)

CocoaPods

在您的项目 Podfile 中添加以下行

pod "Shell", "2.2.0"
pod "ShellTesting", "2.2.0"
pod "RxShell", "2.2.0"

Carthage

在您的项目 Cartfile 中添加以下行

github "tuist/shell" "2.2.0"

Marathon

如果你想在 Marathon 脚本中使用 Shell,可以将其添加到你的 Marathonfile(有关如何操作的说明,请参阅 Marathon 仓库),或者使用内联依赖语法将 Marathon 指向 Shell。

import Shell // https://github.com/tuist/shell.git

使用方法🚀

要在系统中运行命令,你需要创建一个 Shell 实例。

let shell = Shell()

Shell 提供了同步、异步运行命令以及捕获输出的方法。

// Synchronous running
let result = shell.sync(["xcodebuild", "-project", "Shell", "-scheme", "Shell"])

// Asynchronous running
shell.async(["xcodebuild", "-project", "Shell", "-scheme", "Shell"]) { result in
  // Process the result
})

// Capturing output
let result = shell.capture(["xcode-select", "-p"])

测试

我们理解在 Swift 中测试可能的不便,因此我们设计了 Shell 的 API,避免了许多语法糖和静态接口,以方便测试。该库附带了一个名为 ShellTesting 的库,可以在测试目标中导入它以模拟 Shell 接口并存根命令运行的结果。

import ShellTesting

let mock = Shell.mock()
let xcodebuild = XcodeBuild(shell: mock)

shell.succeed(["xcodebuild", "-project", "Shell.xcodeproj", "-scheme", "Shell"])

XCTAssertNoThrow(try xcodebuild.build(project: "Shell.xcodeproj", scheme: "Shell"))

RxShell💃

Shell 提供了一个名为 RxShell 的包,它通过使用 RxSwift 向 Shell 的接口添加了响应式扩展。

subject.run(["xcodebuild", "-project", "Shell", "-scheme", "Shell"]).subscribe {
  print("Compilation completed")
}

开发前的设置👩‍💻

  1. Git 克隆: [email protected]:tuist/shell.git
  2. 使用 swift package generate-xcodeproj 生成 Xcode 项目。
  3. 打开 Shell.xcodeproj
  4. 享受编程的乐趣🤖

开源

Tuist 是自由软件联盟(Software Freedom Conservancy)的骄傲支持者。

Become a Conservancy Supporter!