• Stars
    star
    1,839
  • Rank 25,243 (Top 0.5 %)
  • Language
    Swift
  • License
    MIT License
  • Created almost 9 years ago
  • Updated 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Delightful console output for Swift developers.

Rainbow

Rainbow adds text color, background color and style for console and command line output in Swift. It is born for cross-platform software logging in terminals, working in both Apple's platforms and Linux.

Basic Usage

Nifty way, using the String extension, and print the colorized string.

Named Color & Style

import Rainbow

print("Red text".red)
print("Blue background".onBlue)
print("Light green text on white background".lightGreen.onWhite)

print("Underline".underline)
print("Cyan with bold and blinking".cyan.bold.blink)

print("Plain text".red.onYellow.bold.clearColor.clearBackgroundColor.clearStyles)

It gives you something like this:

Installation

Swift Package Manager

If you are developing a cross platform software in Swift, Swift Package Manager might be your choice for package management. Just add the url of this repo to your Package.swift file as a dependency:

import PackageDescription

let package = Package(
    name: "YourAwesomeSoftware",
    dependencies: [
        .package(url: "https://github.com/onevcat/Rainbow", .upToNextMajor(from: "4.0.0"))
    ],
    targets: [
        .target(
            name: "MyApp",
            dependencies: ["Rainbow"]
        )
    ]
)

Then run swift build whenever you get prepared.

You could know more information on how to use Swift Package Manager in Apple's official page.

Other Usage

String Interpolation & Nested

Swift string interpolation is supported. Define the color for part of the string. Or even create nested colorful strings. The inner color style will be kept:

print("ๆŽฅๅคฉ่Žฒๅถ\("ๆ— ็ฉท็ขง".green)๏ผŒๆ˜ ๆ—ฅ่ท่Šฑ\("ๅˆซๆ ท็บข".red)")
print("\("ไธคๅช้ป„้น‚".yellow)้ธฃ็ฟ ๆŸณ๏ผŒไธ€่กŒ็™ฝ้นญ\("ไธŠ้’ๅคฉ".lightBlue)ใ€‚".lightGreen.underline)

ANSI 256-Color Mode

8-bit color is fully supported, for both text color and background color:

print("ๅœ่ฝฆๅ็ˆฑ\("ๆžซๆž—ๆ™š".bit8(31))๏ผŒ\("้œœๅถ".bit8(160))็บขไบŽ\("ไบŒๆœˆ่Šฑ".bit8(198))ใ€‚")
print("\("ไธ€้“ๆฎ‹้˜ณ".bit8(202))้“บๆฐดไธญ๏ผŒ\("ๅŠๆฑŸ็‘Ÿ็‘Ÿ".bit8(30).onBit8(226))ๅŠๆฑŸ็บขใ€‚")

Hex Colors (approximated)

It also accepts a Hex color. Rainbow tries to convert it to a most approximate .bit8 color:

print("้ป‘ไบ‘ๅŽ‹ๅŸŽ\("ๅŸŽๆฌฒๆ‘ง".hex("#666"))๏ผŒ็”ฒๅ…‰ๅ‘ๆ—ฅ\("้‡‘้ณžๅผ€".hex("000000").onHex("#E6B422"))ใ€‚")
print("ๆ—ฅๅ‡บๆฑŸ่Šฑ\("็บข่ƒœ็ซ".hex(0xd11a2d))๏ผŒๆ˜ฅๆฅๆฑŸๆฐด\("็ปฟๅฆ‚่“".hex(0x10aec2))")

Valid format: "FFF", "#FFF", "FFFFFF", "#FFFFFF", 0xFFFFFF

True color

A few terminal emulators supports 24-bit true color. If you are sure the 24-bit colors can be displayed in your user's terminal, Rainbow has no reason to refuse them!

print("็–ๅฝฑๆจชๆ–œ\("ๆฐดๆธ…ๆต…".bit24(36,116,181))๏ผŒๆš—้ฆ™ๆตฎๅŠจ\("ๆœˆ้ป„ๆ˜".bit24(254,215,26))")
print("\("ๆ˜ฅ่‰ฒๆปกๅ›ญ".hex("#ea517f", to: .bit24))ๅ…ณไธไฝ๏ผŒ\("ไธ€ๆž็บขๆ".hex("#f43e06", to: .bit24))ๅ‡บๅข™ๆฅใ€‚")

Output Target

By default, Rainbow should be smart enough to detect the output target, to determine if it is a tty. For example, it automatically output plain text if written to a file:

// main.swift
print("Hello Rainbow".red)

$ .build/debug/RainbowDemo > output.txt

// output.txt
Hello Rainbow

This is useful for sharing the same code for logging to console and to a log file.

You can manually change this behavior by either:

  • Set the Rainbow.outputTarget yourself.
  • Pass a "NO_COLOR" environment value when executing your app.
  • Or set the Rainbow.enabled to false.

Verbose Way

You can also use the more verbose way if you want:

import Rainbow
let output = "The quick brown fox jumps over the lazy dog"
                .applyingCodes(Color.red, BackgroundColor.yellow, Style.bold)
print(output) // Red text on yellow, bold of course :)

Or even construct everything from scratch:

let entry = Rainbow.Entry(
    segments: [
        .init(text: "Hello ", color: .named(.magenta)),
        .init(text: "Rainbow", color: .bit8(214), backgroundColor: .named(.lightBlue), styles: [.underline]),
    ]
)
print(Rainbow.generateString(for: entry))

Please remember, the string extensions (such as "Hello".red) is O(n). So if you are handling a huge string or very complex nesting, there might be a performance issue or hard to make things in stream. The manual way is a rescue for these cases.

Motivation and Compatibility

Thanks to the open source of Swift, developers now could write cross platform programs with the same language. And I believe the command line software would be the next great platform for Swift. Colorful and well-organized output always helps us to understand what happens. It is really a necessary utility to create wonderful software.

Rainbow should work well in both OS X and Linux terminals. It is smart enough to check whether the output is connected to a valid text terminal or not, to decide the log should be modified or not. This could be useful when you want to send your log to a file instead to console.

Contact

Follow and contact me on Twitter or Sina Weibo. If you find an issue, just open a ticket on it. Pull requests are warmly welcome as well.

Backers & Sponsors

Open-source projects cannot live long without your help. If you find Kingfisher is useful, please consider supporting this project by becoming a sponsor. Your user icon or company logo shows up on my blog with a link to your home page.

Become a sponsor through GitHub Sponsors. โค๏ธ

License

Rainbow is released under the MIT license. See LICENSE for details.

More Repositories

1

Kingfisher

A lightweight, pure-Swift library for downloading and caching images from the web.
Swift
23,065
star
2

VVDocumenter-Xcode

Xcode plug-in which helps you write documentation comment easier, for both Objective-C and Swift.
Objective-C
8,329
star
3

FengNiao

A command line tool for cleaning unused resources in Xcode.
Swift
3,382
star
4

APNGKit

High performance and delightful way to play with APNG format in iOS.
Swift
2,206
star
5

Hedwig

Send email to any SMTP server like a boss, in Swift and cross-platform
Swift
1,117
star
6

VVBlurPresentation

A simple way to present a view controller with keeping the blurred previous one.
Objective-C
894
star
7

RandomColorSwift

An attractive color generator for Swift. Ported from randomColor.js.
Swift
628
star
8

XUPorter

Add files and frameworks to your Xcode project after it is generated by Unity 3D.
C#
587
star
9

VVSpringCollectionViewFlowLayout

A spring-like collection view layout. The same effect like iOS7's Message.app
Objective-C
576
star
10

vno-jekyll

Another ported theme for Jekyll
SCSS
544
star
11

vno

Vno, just another ghost theme
CSS
518
star
12

Easy-Cal-Swift

Overload +-*/ operator for Swift, make it easier to use (and not so strict)
Swift
273
star
13

OneV-s-Den

Blog
SCSS
212
star
14

VVImageTint

UIImage category for image tint. For my blog post http://onevcat.com/2013/04/using-blending-in-ios/
Objective-C
193
star
15

UniWebView-Docs

Documentation of UniWebView Project
JavaScript
192
star
16

VCTransitionDemo

A simple demo indicates how to make a custom view controller transition in iOS 7
Objective-C
189
star
17

UserNotificationDemo

Demo project to show how to use UserNotifications framework in iOS 10
Swift
152
star
18

iOSWeekly

iOS Weekly issue for InfoQ CN
133
star
19

ToDoDemo

State-based View Controller demo
Swift
125
star
20

ObservationBP

Proof of concept for back-porting Observation framework to earlier iOS versions
Swift
113
star
21

DebuggableContext

Provides an easy to use action sheet for debugging purpose when shaking your iOS device.
Swift
97
star
22

resume

JavaScript
87
star
23

ComponentNetworking

Swift
83
star
24

swift-ui-book-issue

76
star
25

AddressParser

Email address parser.
Swift
70
star
26

Delegate

A meta library to provide a better `Delegate` pattern.
Swift
67
star
27

SpriteKitSimpleGame

A demo for starting using SpriteKit. Port famous Cocos2DSimpleGame to SpriteKit.
Objective-C
60
star
28

WatchWeather

Swift
47
star
29

MimeType

Get MIME type string from the extension of a file name
Swift
42
star
30

TimerExtensionDemo

A demo to show how to write a today extension.
Swift
41
star
31

ClockFaceView

A demo project for my blog post
Swift
31
star
32

UITestDemo

UITestDemo
Swift
21
star
33

VVStack

Just a TDD demo with XCTest and Kiwi
Objective-C
20
star
34

Noti

Swift
19
star
35

JekyllScroll

JekyllScroll is a theme for Jekyll.
CSS
19
star
36

DispatchMemoryLeakDemo

A demo that reproduce memory leak in iOS 9.2
Swift
19
star
37

VVBorderTimer

An easy border timer with configurable time, corner radius, line width and colors.
Objective-C
17
star
38

Notes

My Notes: http://notes.onevcat.com
17
star
39

lgtm-images

LGTM images collection
Swift
16
star
40

UniWebView-Deprecated

A universal webview plugin for Unity3D. Work with iOS, Android and Mac, using javascript to interact with Unity3D.
Objective-C
14
star
41

UnpauseMe

Script for Unity3D, unpause Unity3D animations or particles when set Time.timeScale = 0.
C#
14
star
42

PhotoData_Kiwi

Use Kiwi to replace objc.io's first issue. Just a demo for Kiwi and my post.
Objective-C
13
star
43

Swift-CI

Swift CI script. Stolen from vapor.
Shell
13
star
44

CounterDemo

A demo app for studying of TCA
Swift
12
star
45

check-lfs

A command-line tool to check binary file committed to a repo.
Swift
11
star
46

Kingfisher-Crash

Crash sample of Kingfisher SwiftUI with SPM on Xcode 11.2 beta
Swift
10
star
47

TexasPoker

A client of Texas Poker
Objective-C
9
star
48

NeuralNetworkLearning

Swift
9
star
49

XcodeScheme

9
star
50

YYTextSample

Sample project for a layout issue in iOS 10
Swift
9
star
51

pokemaster-images

Images for PokeMaster
8
star
52

KeyboardScrollingIssue

Swift
7
star
53

apple-versions

Astro
7
star
54

VVPluginDemo

A demo for how to make a simple Xcode 4 plug-in.
Objective-C
7
star
55

LineSDK-Integration

Integration Test Cases for LINE SDK Swift
Ruby
7
star
56

onevcat

6
star
57

VVPerlBBS

BBS with Perl. Powered by OneV's Den.
Perl
5
star
58

submail-provider

Submail email provider for Vapor
Swift
4
star
59

MwfTableViewController

Extension to UITableViewController in attempt to provide additional features that are reusable in most scenarios.
Objective-C
4
star
60

Flower-Data-Set

Python
4
star
61

GitHubActionPlayground

4
star
62

elm-2048

Practice my elm understanding
Elm
3
star
63

ChatBot

JavaScript
3
star
64

Math.swift

Math
Swift
3
star
65

onevcat.github.com

It's a user page
3
star
66

beginning-elm

JavaScript
3
star
67

LandscapeViewControllerDemo

Just a demo
Objective-C
3
star
68

LearningPerl

It's a repo for Perl learning to get prepared for future working in Kayac.
Objective-C
3
star
69

advent2021

For fun
Swift
2
star
70

qixia.wang

2
star
71

GoogleInteractiveMediaAds-Carthage

2
star
72

LazyContainerBug

State of cells in "lazy" container is lost, if the cell is embedded in a stack
Swift
2
star
73

objc-image-packer

Book build image for ObjCCN
HCL
2
star
74

cool-lang

COOL Lang
Java
2
star
75

JBAlertView

JBAlertView is the new AlertView for showing different alerts type (default, connection, error, ...)
Objective-C
2
star
76

github-battle

Typescript version of GitHub Battle
TypeScript
2
star
77

KF-issue-1931

Swift
1
star
78

VVAlertBanner

A alert banner view which could queue the alert and shou them each by each.
Objective-C
1
star
79

Kingfisher-TestImages

Test images for Swift image downloading framework - Kingfisher.
1
star
80

SPMConfigDemo

Swift
1
star
81

Kingfisher-Review-Sample

Swift
1
star