dominicegginton / spinner Goto Github PK

Currently .stopAndClear()clears both the spinner frame and text and returns to a new line. It would be nice to have the option for a better .clear() functionality where a new line isn’t created and the cursor is reset to the start of the line.

It would be nice to display the progress of mutli step jobs with an output somthing similar to: [3/4]

Spinner length can cause issues when changing from larger to smaller.

let spinner = Spinner(.dots, message, format: "{S} {T} ⏱️ {D}")
spinner.start()

//example of command more then 1s:
shell.run("bundle exec pod install")
spinner.stop()

//Output:

✔ 🫛 Pods install ⏱️ 0s

I checked your code and it looks correct, you calculate the value between the start and the current time each time. However, the value does not change

func render() {
        var spinner = self.format.replacingOccurrences(of: "{S}", with: self.frame()).replacingOccurrences(of: "{T}", with: self.message)
        if let timestamp = self.timestamp {
            let duration = Now() - timestamp
            spinner = spinner.replacingOccurrences(of: "{D}", with: duration.timeString)
        }
        stream.write(string: "\r", terminator: "")
        stream.write(string: spinner, terminator: "")
    }

Thank you for good project!

Steps to reproduce

If a spinner has a custom completion type with the animated pattern rendering after the text and a completion function is used to stop the spinner, a render error can occur if the passed text is shorter than the original. I am assuming this will occur when updating the text too.

let mySpinner = Spinner(.dots, "My Spinner", format: "{T} {S}")
mySpinner.start()
sleep(2)
mySpinner.failure("Fail")

Expected behavior

This should render final completion frame next to the text

Actual behavior

This renders the final completion frame with space between the text and the spinner

Environment

• Swift version: 5.1
• OS version: 10.15 Beta (19A558d)

Current spinner object prints the pattern frames before the text object. It would be nice to implement support for formatting this output. For example:

Spinner Text .
Spinner Text ..
Spinner Text ...
Spinner Text ....
Spinner Text ✔

This could be implemented with a string that is passed to the Spinner object. For example, “[p] [t]”.

Demo gifs should have a transparent background enabling both light and dark modes for GitHub to display the demos without a jarring background color

When calling a completion hander the if the spinner has a custom color set it will override the completion spinners color and display the currently set color.

Steps to reproduce

let spinner = Spinner(.dots, "example", color: .red)
spinner.start()
spinner.succeed()

Expected behavior

.succeed() should display a green tick

Actual behavior

.succeed() displays a red tick. this is the custom color that the spinner was set up with

Environment

• Swift version: 5.0.1
• OS version: macOS 10.14.6 Beta (18G29g)

Steps to reproduce

Set your terminal to a different color by default, then create a default Spinner object.

import Spinner

let mySpinner = Spinner(.dots, "My Spinner")
mySpinner.start()
sleep(2)
mySpinner.stop()

Expected behavior

The spinner pattern should render as the default color of the terminal not white

Actual behavior

The spinner pattern renders as white

Environment

• Swift version: 5.1
• OS version: 10.15 Beta (19A558d)

Adding color to the spinner objects would be nice. This would be helpful when calling for errors, warnings and fails.

Implementation

Could be implemented using the Rainbow Package

Add this repository to dependabot, enabling automated dependency updates.

Waiting on dependabot/dependabot-core#1379 to be merged.

Steps to reproduce

import Spinner
import Foundation

let spinner = Spinner(.dots, "Spinner Text")
spinner.start()
sleep(3)
spinner.clear()
print("Not at start of line")

Expected behavior

Text should be printed at start of line

Actual behavior

Text is printed behind padding

Environment

• Swift version: Apple Swift version 4.2.1
• OS version: macOS 10.14.2

Steps to reproduce

let spinner = Spinner(.dots, "Loading Unicorns")
spinner.start()
sleep(2)
spinner.stop(finalFrame: "🦄")

Expected behavior

The spinner should display a space between the final frame and the text

Actual behavior

The spinner does not display a space between the final frame and the text

Environment

• Swift version: 5.0.1
• OS version: 0.14.6 Beta (18G29g)

Update swift-tools-version here to latest version:
https://github.com/dominicegginton/Spinner/blob/8d1e008264c5c0c93a8c779028b7c8c20173d7ca/Package.swift#L1

Spinner currently hides the terminal cursor when started and unhides the cursor when stopped. If the process is interrupted (For Example Ctrl + C)

I tried changing: https://github.com/mattyoung/spinner

but I don't know why I get:

/Users/matty/Devel/ArgumentParser/Projects/WebGrep/Sources/WebGrep.swift:93:19 Value of type 'Spinner' has no member 'updateText'