Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RxSwiftCommunity/RxTask
An RxSwift implementation of a command line runner.
https://github.com/RxSwiftCommunity/RxTask
command-line macos runner rxswift rxswift-extensions swift
Last synced: about 2 months ago
JSON representation
An RxSwift implementation of a command line runner.
- Host: GitHub
- URL: https://github.com/RxSwiftCommunity/RxTask
- Owner: RxSwiftCommunity
- License: mit
- Created: 2017-02-16T00:59:08.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-02-28T16:37:47.000Z (over 7 years ago)
- Last Synced: 2024-05-09T08:04:45.354Z (5 months ago)
- Topics: command-line, macos, runner, rxswift, rxswift-extensions, swift
- Language: Swift
- Size: 554 KB
- Stars: 15
- Watchers: 34
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rxswift - RxTask
README
# RxTask
An [RxSwift](https://github.com/ReactiveX/RxSwift) implementation of a command line task runner.
[]()
[](https://travis-ci.org/RxSwiftCommunity/RxTask)
[](https://codecov.io/gh/RxSwiftCommunity/RxTask)
[](https://RxSwiftCommunity.github.io/RxTask/)
[](https://github.com/Carthage/Carthage)
[](https://github.com/apple/swift-package-manager)
[](https://swift.org)
## Linux Compatibility
Currently, RxTask does not support Linux. RxTask relies on some functionality
in `Foundation` that is currently not available in the Linux port. This will be
re-evaluated after the Swift 3.1 release. PRs in this area are quite welcome! 👍
## Installation
### Carthage
```shell
github "RxSwiftCommunity/RxTask"
```
### SPM
```swift
import PackageDescription
let package = Package(
name: "YOUR_PROJECT_NAME",
targets: [],
dependencies: [
.Package(url: "https://github.com/RxSwiftCommunity/RxSwift.git", majorVersion: 0)
]
)
```
## Usage
### Create A Task
Creating a task is as simple as providing a `launchPath` to the executable.
```swift
let task = Task(launchPath: "/bin/ls")
```
Optionally, you can provide `arguments`, a `workingDirectory`, and an
`environment`.
```swift
let task = Task(launchPath: "/bin/echo", arguments: ["$MESSAGE"], environment: ["MESSAGE": "Hello World!"])
```
### Launch A Task
`Task`s can be launched with the `launch()` method. This produces a
self-contained process. This means the same task can be `launch()`ed multiple
times producing separate processes.
#### TaskEvent
The output of `launch()` is a `Observable`. `TaskEvent` is an `enum`
that is used to report significant events in the task lifetime. The possible
events are:
* `launch(command: String)`
* `stdOut(Data)`
* `stdErr(Data)`
* `exit(statusCode: Int)`
**Note:** Currently an event is only considered successful if it exits with a
`statusCode` of 0. Other exit statuses will be considered a `TaskError`.
#### StdIn
If you create a task that expects input, you can provide an `Observable`
for `stdin` when you are `launch()`ing the `Task`. Data will be written to
`stdin` as soon as it is emitted by the `Observable`.
#### Filtering TaskEvents
If you are only concerned with whether a `Task` has completed successfully, you
can use the built-in operator `justExitStatus()`.
```swift
Task(launchPath: "/bin/ls").launch()
.justExitStatus()
.subscribe(onNext: { exitStatus in /* ... */ })
.disposed(by: disposeBag)
```
Alternatively, if you are only interested in the output of a `Task`, you can use
the operator `justOutput()`. *This will send the output of both `stdout` and
`stderr`*.
```swift
Task(launchPath: "/bin/ls").launch()
.justOutput()
.subscribe(onNext: { output in /* ... */ })
.disposed(by: disposeBag)
```
#### TaskError
`TaskError` is an `Error` that will be emitted under the following situations:
* `uncaughtSignal`: The `Task` terminated with an uncaught signal (e.g. `SIGINT`).
* `exit(statusCode: Int)`: The `Task` exited with a non-zero exit code.
## API Reference
Full docs can be found [here](https://RxSwiftCommunity.github.io/RxTask/).