https://github.com/kiliankoe/clispinner

Swifty Terminal Spinner
https://github.com/kiliankoe/clispinner

cli loading-animations spinner

Last synced: 14 days ago
JSON representation

Swifty Terminal Spinner

• Host: GitHub
• URL: https://github.com/kiliankoe/clispinner
• Owner: kiliankoe
• License: mit
• Created: 2017-08-01T16:03:33.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2021-01-24T21:46:43.000Z (almost 4 years ago)
• Last Synced: 2024-10-22T10:17:14.481Z (23 days ago)
• Topics: cli, loading-animations, spinner
• Language: Swift
• Size: 68.4 KB
• Stars: 217
• Watchers: 5
• Forks: 14
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# CLISpinner

[![Travis](https://img.shields.io/travis/kiliankoe/CLISpinner.svg?style=flat-square)](https://travis-ci.org/kiliankoe/CLISpinner/)

> 60+ spinners for use in the terminal

![](https://github.com/sindresorhus/cli-spinners/raw/master/screenshot.gif)

Shamelessly ripped off from [sindresorhus/cli-spinners](https://github.com/sindresorhus/cli-spinners).

## Install

```swift

.package(url: "https://github.com/kiliankoe/CLISpinner", from: "see latest release")

```

## Usage

Just want to display a simple spinner for two seconds? 

```swift

let s = Spinner(pattern: .dots)

s.start()

sleep(2)

s.stop()

```

Want some changing text and patterns?

```swift

let s = Spinner(pattern: .dots, text: "Foobar...", color: .lightCyan)

s.start()

sleep(2)

s.succeed(text: "Barfoo")

// will change the displayed text to '✔ Barfoo'

```

Made your own custom pattern?

```swift

let pattern = try Pattern.load(from: "/path/to/your/pattern.json")

let s = spinner(pattern: pattern)

s.start()

sleep(2)

s.stop()

```

Want all the patterns from [sindresorhus/cli-spinners](https://github.com/sindresorhus/cli-spinners/blob/master/spinners.json)?

```swift

let patterns = try Patterns(from: "/path/to/spinners.json")

let s = spinner(pattern: patterns["christmas"]!)

s.start()

sleep(2)

s.stop()

```

That's basically it 👌

## Creating your own Pattern

The `Pattern` type can read in patterns from a JSON file using the following format:

```json

{

    "frames": [

        "1",

        "2",

        "3",

        "4",

        "5"

    ],

    "speed": 0.08

}

```

To keep multiple patterns in a single file:

```json

{

    "pattern-name1": {

        "frames": [

            "<(**<)",

            "<(**)>",

            "(>**)>"

        ],

        "speed": 0.01

    },

    "pattern-name2": {

        "frames": [

            "1",

            "2",

            "3",

            "2"

        ],

        "speed": 0.12

    }

}

```

## Caveat

To look *nice* the spinner hides the user's cursor as long as it's running and displays it again when stopped. The issue with this is that the cursor will still be hidden if the user interrupts the process (by sending a SIGINT through ctrl+c for example). The best way to handle this is by setting up a signal handler in your code and calling `spinner.unhideCursor()` on exiting. This library purposefully does not do that for you so as not to interfere with any possible signal handlers you might already have set up.

See [IBM-Swift/BlueSignals](https://github.com/IBM-Swift/BlueSignals) for a clean and safe way of handling signals. The appropriate signal handler for your project could look something like this.

```swift

import Signals

let spinner = Spinner(pattern: .dots)

// ...

Signals.trap(signal: .int) { _ in

    spinner.unhideCursor()

    exit(0)

}

```

## Used by

- [kiliankoe/apodidae](https://github.com/kiliankoe/apodidae) - CLI to search for Swift packages

- [Swift-Watch/Watcher](https://github.com/Swift-Watch/Watcher) - file watcher and test runner for Swift projects

- Your project? 😊