https://github.com/scottrhoyt/SwiftyTextTable
A lightweight library for generating text tables.
https://github.com/scottrhoyt/SwiftyTextTable
carthage cocoapods command-line linux macos swift swift-package-manager tabular-data
Last synced: 3 months ago
JSON representation
A lightweight library for generating text tables.
- Host: GitHub
- URL: https://github.com/scottrhoyt/SwiftyTextTable
- Owner: scottrhoyt
- License: mit
- Created: 2016-02-04T05:42:16.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-02-25T21:18:37.000Z (over 2 years ago)
- Last Synced: 2024-10-29T20:35:01.473Z (12 months ago)
- Topics: carthage, cocoapods, command-line, linux, macos, swift, swift-package-manager, tabular-data
- Language: Swift
- Homepage:
- Size: 368 KB
- Stars: 318
- Watchers: 11
- Forks: 30
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-swift - SwiftyTextTable - A lightweight library to generate text tables. (Libs / Command Line)
- awesome-swift - SwiftyTextTable - A lightweight library to generate text tables. (Libs / Command Line)
- awesome-ios - SwiftyTextTable - A lightweight library for generating text tables. (Command Line / Linter)
- fucking-awesome-swift - SwiftyTextTable - A lightweight library to generate text tables. (Libs / Command Line)
- awesome-ios-star - SwiftyTextTable - A lightweight library for generating text tables. (Command Line / Linter)
- awesome-swift-cn - SwiftyTextTable - A lightweight library to generate text tables. (Libs / Command Line)
- awesome-swift - SwiftyTextTable - A lightweight library for generating text tables. ` 📝 2 years ago ` (Command Line [🔝](#readme))
- fucking-awesome-ios - SwiftyTextTable - A lightweight library for generating text tables. (Command Line / Linter)
README
# SwiftyTextTable
A lightweight Swift library for generating text tables.
[](https://travis-ci.org/scottrhoyt/SwiftyTextTable)
[](https://codecov.io/github/scottrhoyt/SwiftyTextTable?branch=master)
[](https://github.com/Carthage/Carthage)
[](https://github.com/apple/swift-package-manager)
[]()
[](https://swift.org)
## Swift Language Support
SwiftyTextTable is now Swift 4.0 compatible! The last release to support Swift
3.1 was [0.7.1](https://github.com/scottrhoyt/SwiftyTextTable/releases/tag/0.7.1).
The last release to support Swift 2.3 was [0.3.1](https://github.com/scottrhoyt/SwiftyTextTable/releases/tag/0.3.1).
## Installation
### Carthage (OS X)
You can use [Carthage](https://github.com/Carthage/Carthage) to install
SwiftyTextTable by adding it to your `Cartfile`:
```
github "scottrhoyt/SwiftyTextTable"
```
### Swift Package Manager (OS X + Linux)
You can use [The Swift Package Manager](https://swift.org/package-manager) to
install SwiftyTextTable by adding the proper description to your
`Package.swift` file:
```swift
import PackageDescription
let package = Package(
name: "",
dependencies: [
.package(url: "https://github.com/scottrhoyt/SwiftyTextTable.git", from: "0.5.0")
]
)
```
### CocoaPods (OS X)
You can use [CocoaPods](https://cocoapods.org) to install SwiftyTextTable by
adding it to your `Podfile`:
```ruby
pod 'SwiftyTextTable'
```
### Manual
Simply copy the `*.swift` files from the `Source/SwiftyTextTable` directory into
your project.
## Usage
```swift
import SwiftyTextTable
// First create some columns
let foo = TextTableColumn(header: "foo")
let bar = TextTableColumn(header: "bar")
let baz = TextTableColumn(header: "baz")
// Then create a table with the columns
var table = TextTable(columns: [foo, bar, baz])
// Then add some rows
table.addRow([1, 2, 3])
table.addRow([11, 22, 33])
// Then render the table and use
let tableString = table.render()
print(tableString)
/*
+-----+-----+-----+
| foo | bar | baz |
+-----+-----+-----+
| 1 | 2 | 3 |
| 11 | 22 | 33 |
+-----+-----+-----+
*/
// Put a header on the table if you'd like
table.header = "my foo table"
print(table.render())
/*
+-----------------+
| my foo table |
+-----------------+
| foo | bar | baz |
+-----+-----+-----+
| 1 | 2 | 3 |
| 11 | 22 | 33 |
+-----+-----+-----+
*/
```
Any `CustomStringConvertible` can be used for row `values`.
### Creating Tables from Arrays of Objects with `TextTableRepresentable`
Let's say you have an array of objects that looks this:
```swift
enum AnimalType: String, CustomStringConvertible {
case dog = "Dog"
case cat = "Cat"
case gorilla = "Gorilla"
var description: String {
return self.rawValue
}
}
struct Pet {
let type: AnimalType
let name: String
let canHazPizza: Bool
}
let furball = Pet(type: .cat, name: "Furball", canHazPizza: false)
let bestFriend = Pet(type: .dog, name: "Best Friend", canHazPizza: true)
let scary = Pet(type: .gorilla, name: "Scary", canHazPizza: true)
let pets = [furball, bestFriend, scary]
```
Now you want to print a table containing your `pets`. You can accomplish this
by having `Pet` conform to `TextTableRepresentable`:
```swift
extension Pet: TextTableRepresentable {
static var columnHeaders: [String] {
return ["Name", "Animal", "Can Haz Pizza?"]
}
var tableValues: [CustomStringConvertible] {
return [name, type, canHazPizza ? "yes" : "no"]
}
// Optional
static var tableHeader: String? {
return "My Pets"
}
}
```
You can now print a table of your `pets` simply:
```swift
print(pets.renderTextTable())
/*
+----------------------------------------+
| My Pets |
+----------------------------------------+
| Name | Animal | Can Haz Pizza? |
+-------------+---------+----------------+
| Furball | Cat | no |
| Best Friend | Dog | yes |
| Scary | Gorilla | yes |
+-------------+---------+----------------+
*/
```
### Fence Custimization
You can also customize the output of `TextTable.render()` by using different
values for `columnFence`, `rowFence`, and `cornerFence`.
```swift
table.columnFence = ":"
table.rowFence = "."
table.cornerFence = "."
print(table.render())
/*
...................
: foo : bar : baz :
...................
: 1 : 2 : :
: 11 : 22 : 33 :
...................
*/
```
### Row Padding/Truncation
When adding rows, `TextTable` will automatically pad the rows with empty strings
when there are fewer `values` than columns. `TextTable` will also disregard all
`values` over the column count.
```swift
let foo = TextTableColumn(header: "foo")
let bar = TextTableColumn(header: "bar")
let baz = TextTableColumn(header: "baz")
var table = TextTable(columns: [foo, bar, baz])
table.addRow([1, 2])
table.addRow([11, 22, 33])
table.addRow([111, 222, 333, 444])
let tableString = table.render()
print(tableString)
/*
+-----+-----+-----+
| foo | bar | baz |
+-----+-----+-----+
| 1 | 2 | |
| 11 | 22 | 33 |
| 111 | 222 | 333 |
+-----+-----+-----+
*/
```
### Console Formatting Support
SwiftyTextTable will recognize many console escape sequences used to format
output (e.g. [Rainbow](https://github.com/onevcat/Rainbow)) and account for them
in constructing the table.
### API Reference
Check out the full API reference [here](http://scottrhoyt.github.io/SwiftyTextTable/).
## License
SwiftyTextTable is released under the [MIT License](https://github.com/scottrhoyt/SwiftyTextTable/blob/master/LICENSE).