tabular
A MoonBit library for pretty-printing tables in terminal. Ported from Rust tabled.
table
tui
terminal
cli
format
grid
pretty-print
moon add hustcer/tabular@0.5.2
Download zipAuthor
Version
0.5.2
License
Apache-2.0
Repository
Last updated
4 months ago
Downloads
126
README#Tabular
A MoonBit library for pretty-printing tables in the terminal. Inspired by the Rust tabled project.
#Features
- 11 built-in style presets
- Customizable borders and horizontal lines
- Alignment, padding, width, height, and formatting controls
- Row, column, cell, and segment based table editing
- Column span and row span
- Panel, merge, highlight, shadow, split, extract, remove, and border correction
- Builder helpers with index and transpose support
#Installation
moon add hustcer/tabular#Quick Start
let table = @tabular.Table::from_rows([
["Name", "Language", "Stars"],
["Deno", "Rust/TS", "101k"],
["Bun", "Zig/C++", "76k"],
["Node.js", "C++/JS", "110k"],
])
table.apply(@tabular.Style::modern()) |> ignore
println(table.to_string())Output:
┌─────────┬──────────┬───────┐
│ Name │ Language │ Stars │
├─────────┼──────────┼───────┤
│ Deno │ Rust/TS │ 101k │
├─────────┼──────────┼───────┤
│ Bun │ Zig/C++ │ 76k │
├─────────┼──────────┼───────┤
│ Node.js │ C++/JS │ 110k │
└─────────┴──────────┴───────┘#Style Presets
table.apply(@tabular.Style::ascii()) |> ignore
table.apply(@tabular.Style::modern()) |> ignore
table.apply(@tabular.Style::rounded()) |> ignore
table.apply(@tabular.Style::extended()) |> ignore
table.apply(@tabular.Style::dots()) |> ignore
table.apply(@tabular.Style::empty()) |> ignore
table.apply(@tabular.Style::blank()) |> ignore
table.apply(@tabular.Style::re_structured_text()) |> ignore
table.apply(@tabular.Style::ascii_rounded()) |> ignore
table.apply(@tabular.Style::markdown()) |> ignore
table.apply(@tabular.Style::psql()) |> ignore#Gallery
ascii
+----------+------+
| language | year |
+----------+------+
| Rust | 2010 |
+----------+------+
| MoonBit | 2022 |
+----------+------+modern
┌──────────┬──────┐
│ language │ year │
├──────────┼──────┤
│ Rust │ 2010 │
├──────────┼──────┤
│ MoonBit │ 2022 │
└──────────┴──────┘rounded
╭──────────┬──────╮
│ language │ year │
├──────────┼──────┤
│ Rust │ 2010 │
├──────────┼──────┤
│ MoonBit │ 2022 │
╰──────────┴──────╯markdown
| language | year |
|----------|------|
| Rust | 2010 |
| MoonBit | 2022 |psql
language | year
----------+------
Rust | 2010
MoonBit | 2022dots
:.................:
: language : year :
:..........:......:
: Rust : 2010 :
:..........:......:
: MoonBit : 2022 :
:.................:extended
╔══════════╦══════╗
║ language ║ year ║
╠══════════╬══════╣
║ Rust ║ 2010 ║
╠══════════╬══════╣
║ MoonBit ║ 2022 ║
╚══════════╩══════╝empty / blank
language year
Rust 2010
MoonBit 2022re_structured_text
========== ======
language year
========== ======
Rust 2010
MoonBit 2022
========== ======ascii_rounded
.-----------------.
| language | year |
| Rust | 2010 |
| MoonBit | 2022 |
'-----------------'#Custom Style
let style = @tabular.Style::ascii()
.top('─')
.bottom('─')
.left('│')
.right('│')
.horizontal('─')
.vertical('│')
.corner_top_left('┌')
.corner_top_right('┐')
.corner_bottom_left('└')
.corner_bottom_right('┘')
table.apply(style) |> ignorelet style = @tabular.Style::ascii()
.remove_horizontal()
.horizontals([
(1, @tabular.HorizontalLine::full('-', '+', '+', '+')),
])
table.apply(style) |> ignore#Builder
let builder = @tabular.Builder::default()
builder.push_record(["Name", "Age", "City"])
builder.push_record(["Alice", "30", "NYC"])
builder.push_record(["Bob", "25", "LA"])
let table = builder.build()
println(table.to_string())///|
let builder = @tabular.Builder::from_rows([
["Name", "Age"],
["Alice", "30"],
["Bob", "25"],
])
///|
let table1 = builder.index().build()
///|
let table2 = builder.index().transpose().build()
///|
let table3 = builder.index().hide().build()#Common Edits
table.set_align(@tabular.Align::right()) |> ignore
table.set_padding(@tabular.Padding::new(1, 1, 0, 0)) |> ignore
table.set_width(@tabular.Width::wrap(10)) |> ignore
table.set_height(@tabular.Height::increase(2)) |> ignoretable.modify_rows(
@tabular.Rows::first(),
@tabular.Setting::align(@tabular.Align::center()),
) |> ignore
table.modify_cols(
@tabular.Cols::one(1),
@tabular.Setting::width(@tabular.Width::wrap(8)),
) |> ignore
table.modify_cell(
@tabular.Cell::new(1, 2),
@tabular.Setting::format(@tabular.Format::surround("[", "]")),
) |> ignore#Spans
let table = @tabular.Table::from_rows([
["Team", "Q1", "Q2", "Q3"],
["A", "12", "18", "22"],
["B", "10", "16", "21"],
])
table.apply(@tabular.Style::modern()) |> ignore
table.modify_cell(@tabular.Cell::new(0, 0), @tabular.Span::col(2)) |> ignore
table.correct_borders() |> ignore
println(table.to_string())Possible output:
┌─────────────┬────┬────┐
│ Team │ Q2 │ Q3 │
├──────┬──────┼────┼────┤
│ A │ 12 │ 18 │ 22 │
├──────┼──────┼────┼────┤
│ B │ 10 │ 16 │ 21 │
└──────┴──────┴────┴────┘#Panels And Merge
let table = @tabular.Table::from_rows([
["0", "1", "2"],
["0", "1", "1"],
["1", "1", "2"],
["1", "1", "1"],
])
table.panel(@tabular.Panel::header("Runtime Comparison")) |> ignore
table.merge(@tabular.Merge::horizontal()) |> ignore
println(table.to_string())#Highlight And Shadow
table.highlight(
@tabular.Highlight::outline_cell(@tabular.Cell::new(1, 1), '*'),
) |> ignore
table.shadow(@tabular.Shadow::new(1)) |> ignore#Split, Extract, Remove
table.extract_rows(@tabular.Rows::new(0, 2)) |> ignore
table.remove_cols(@tabular.Cols::one(0)) |> ignore
table.split(@tabular.Split::col(2).concat()) |> ignore#Validation
The current repository test suite passes:
moon test#License
Apache-2.0
#Align
pub enum Align {
Left
Right
Center
}#Builder
#Builder::index
Create an IndexBuilder from this Builder for index/transpose operations.
#Builder::insert_col
#Builder::insert_record
#ByColName
pub struct ByColName {
name : String
}#Cell
pub struct Cell {
row : Int
col : Int
}#Cols
#Format
pub enum Format {
Surround(String, String, Bool)
Value(String, Bool)
Content((String) -> String, Bool)
Positioned((String, Int, Int) -> String, Bool)
}#Height
pub enum Height {
Increase(Int)
Limit(Int)
}#Highlight
#Highlight::outline_segment
#Highlight::with_border
#HighlightTarget
#HorizontalLine
#HorizontalLine::full
fn HorizontalLine::full(main : Char, left? : Char, intersection? : Char, right? : Char) -> HorizontalLine#HorizontalLine::intersection
#HorizontalLine::left
#HorizontalLine::right
#IndexBuilder
#IndexBuilder::build
Build the final Table from the IndexBuilder.
#IndexBuilder::col
Use the specified col as the index col (0-based).
#IndexBuilder::hide
Hide the index col.
#IndexBuilder::name
Set the name for the index col. None removes the name row.
#IndexBuilder::transpose
Transpose the table (swap rows and cols).
#Merge
pub enum Merge {
Horizontal
Vertical
}#Padding
pub struct Padding {
left : Int
right : Int
top : Int
bottom : Int
}#Panel
pub enum Panel {
}#Panel::footer
Insert a footer panel after the last row.
#Panel::horizontal
Insert a horizontal panel at the given row index.
The panel text spans all cols.
#Panel::vertical
Insert a vertical panel at the given col index.
The panel text spans all rows.
#Panel::vertical_with_width
Insert a vertical panel with text split to fit a certain width.
#Rows
#Segment
#Segment::new
#SegmentKind
#Setting
#Shadow
pub struct Shadow {
size : Int
offset : Int
fill : Char
top : Bool
bottom : Bool
left : Bool
right : Bool
}#Shadow::new
Create a shadow with default direction (bottom-right) and default fill '▒'.
#Span
pub enum Span {
}#Split
pub struct Split {
// private fields
}#Style
pub struct Style {
borders : Borders
horizontal_lines : HorizontalLines
custom_horizontal_lines : Array[(Int, HorizontalLine)]
}#Style::custom_horizontal_lines
#Style::horizontals
#Table
#Table::correct_borders
Correct border junctions at span boundaries so merged cells display proper corners.
#Table::extract_segment
#Table::merge
Apply merge to the table, combining adjacent duplicate cells using spans.
#Table::modify_by_col_name
#Table::modify_cell
#Table::modify_cols
#Table::modify_rows
#Table::modify_segment
#Table::panel
Apply a horizontal or vertical panel to the table.
#Table::remove_by_col_name
#Table::split
Apply a Split setting to reshape the table.
This resets config (spans, borders) since Split fundamentally changes the table shape.
#VAlign
pub enum VAlign {
Top
Bottom
Center
}A MoonBit library for pretty-printing tables in terminal. Ported from Rust tabled.
tabletuiterminalcliformatgridpretty-print
0.5.2
Apache-2.0
Updated 4 months ago
126 downloads