Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jangorman/table
CLI tables in Swift
https://github.com/jangorman/table
cli spm swift swift-5 swift-package-manager swift5 table
Last synced: 11 days ago
JSON representation
CLI tables in Swift
- Host: GitHub
- URL: https://github.com/jangorman/table
- Owner: JanGorman
- License: mit
- Created: 2017-05-28T15:12:44.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-12-20T09:04:16.000Z (almost 3 years ago)
- Last Synced: 2024-10-28T21:50:56.041Z (23 days ago)
- Topics: cli, spm, swift, swift-5, swift-package-manager, swift5, table
- Language: Swift
- Size: 19.5 KB
- Stars: 55
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Swift Tables
[](https://github.com/JanGorman/Table/actions?query=workflow%3ACI)
[](https://swift.org/package-manager)
[](https://codecov.io/gh/JanGorman/Table)
Working on CLI tools in Swift? Need to display tables? Continue reading.
Add the dependency to your `Package.swift` file:
```swift
import PackageDescription
let package = Package(
name: "My awesome CLI tool"
dependencies: [
.package(
url: "https://github.com/JanGorman/Table",
from: "1.0.0"
)
]
)
```
### Basic Usage
```swift
import Table
func doSomething() throws {
let data = [
["0A", "0B", "0C"],
["1A", "1B", "1C"],
["2A", "2B", "2C"],
]
let table = try Table(data: data).table()
print(table)
}
```
Results in a pretty table:
```
╔════╤════╤════╗
║ 0A │ 0B │ 0C ║
╟────┼────┼────╢
║ 1A │ 1B │ 1C ║
╟────┼────┼────╢
║ 2A │ 2B │ 2C ║
╚════╧════╧════╝
```
### Alignment
You can align your table rows by passing in a `Configuration`:
```swift
import Table
func doSomething() throws {
let data = [
["0A", "0B", "0C"],
]
// Give alignment and a minimum width
let columns = [
Column(alignment: .left, width: 10),
Column(alignment: .center, width: 10),
Column(alignment: .right, width: 10)
]
let configuration = Configuration(columns: columns)
let table = try Table(data: data).table()
print(table)
}
```
Results in:
```
╔══════════╤══════════╤══════════╗
║0A │ 0B │ 0C║
╚══════════╧══════════╧══════════╝
```
### Padding
The `Configuration` also allows for padding:
```swift
import Table
func doSomething() throws {
let data = [
["0A", "0B", "0C"],
]
let columns = [
Column(paddingLeft: 3, paddingRight: 4),
Column(paddingLeft: 8, paddingRight: 8),
Column(paddingLeft: 3, paddingRight: 4)
]
let configuration = Configuration(columns: columns)
let table = try Table(data: data).table()
print(table)
}
```
Would give you:
```
╔═════════╤══════════════════╤═════════╗
║ 0A │ 0B │ 0C ║
╚═════════╧══════════════════╧═════════╝
```
### Custom Border Style
To use a custom border for your tables simply create a `struct` conforming to the `Border` protocol and pass it as part of a custom `Configuration`. For example:
```swift
import Table
struct CustomBorder: Border {
public let topBody = "─"
public let topJoin = "┬"
public let topLeft = "┌"
public let topRight = "┐"
public let bottomBody = "─"
public let bottomJoin = "┴"
public let bottomLeft = "└"
public let bottomRight = "┘"
public let bodyLeft = "│"
public let bodyRight = "│"
public let bodyJoin = "│"
public let joinBody = "─"
public let joinLeft = "├"
public let joinRight = "┤"
public let joinJoin = "┼"
}
func doSomething() throws -> String {
…
let configuration = Configuration(border: CustomBorder(), columns: columns)
return try Table(data: data).table()
}
```
## Licence
Table is released under the MIT license. See LICENSE for details.