TestsTested | ✓ |
LangLanguage | SwiftSwift |
License | MIT |
ReleasedLast Release | Oct 2017 |
SwiftSwift Version | 3.0 |
SPMSupports SPM | ✓ |
Maintained by Justus Kandzi.
Just wrap the SequenceType
in your loop with the Progress SequenceType
and you’ll automatically get beautiful progress bars.
Updating the progress bar does not work in the Xcode console because it does not support the cursor movements. If you want it to look nice run it in a real terminal.
Just take a regular loop like this for i in 1...9 { ...
and wrap the 1...9
range in the Progress
type and you’ll automatically get a nice progress bar.
import Progress
for i in Progress(1...9) {
...
}
Creates this output:
$ 4 of 9 [------------- ] ETA: 0:00:05 (at 1.01 it/s)
It also works with all the other types adopting the CollectionType
protocol like dictionarys: Progress(["key": "value", "key2": "also value"])
and arrays: Progress([1, 52, 6, 26, 1])
.
You can also create the progress bar manually without a sequence type:
var bar = ProgressBar(count: 4)
for i in 0...3 {
bar.next()
sleep(1)
}
You can configure the progress bar by combining single building blocks of type ProgressElementType
.
Either by setting a default configuration:
ProgressBar.defaultConfiguration = [ProgressString(string: "Percent done:"), ProgressPercent()]
which creates the following result:
$ Percent done: 80%
or by providing a specific configuration in the Process initializer:
Progress(0...10, configuration: [ProgressPercent(), ProgressBarLine(barLength: 60)])
resulting in something like this:
$ 100% [------------------------------------------------------------]
Available ProgressElementType
elements:
ProgressBarLine
(The actual bar. E.g. “[———————- ]”).ProgressIndex
(The current index & overall count. E.g. “2 of 3”).ProgressPercent
(The progress in percent. E.g. “60%”).ProgressTimeEstimates
(Estimated time remaining & items per second. E.g. “ETA: 00:00:02 (at 1.00 it/s)”).ProgressString
(Adds an arbitrary string to the progress bar).To install with the Swift Package Manager, add the following in your Package.swift
:
import PackageDescription
let package = Package(
name: "MyProject",
dependencies: [
.Package(url: "https://github.com/jkandzi/Progress.swift", majorVersion: 0)
]
)
You can also copy the Progress.swift
file into your Xcode project.
You are welcome to fork and submit pull requests.
Justus Kandzi, [email protected]
Progress.swift is available under the MIT license. See the LICENSE file for more info.