Skip to content

Feature-rich ASCII table generator for the terminal

License

Notifications You must be signed in to change notification settings

drkameleon/tabular.art

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Feature-rich ASCII table generator
for Arturo




What does this package do?

This package includes a simple - but powerful - ASCII table generator, with all the (tabular) bells and whistles, bundled in an easy-to-use package for Arturo.

How do I use it?

Simply import it and use any of the provided helper functions; mainly, one: tabular.

Tip

The code below generates the exact same tables you may see in the screenshot above^ 😉

import "tabular"!

; A simple table
print tabular [
    [1 2 3]
    [4 5 6]
]

; A table with header
print tabular.header:["Item" "Qty" "Price"][
    ["Apples"    5   2.99]
    ["Oranges"   10  3.49]
    ["Bananas"   8   1.99]
]

; A table with header and custom-aligned columns
print tabular
    .header:["Item" "Qty" "Price"] 
    .align:['left 'right 'right]
[
    ["Apples"  5  2.99]
    ["Oranges" 10 3.49]
    ["Bananas" 8  1.99]
]

; A Unicode-based table with custom-aligned columns
; and variable, user-defined paddings
print tabular.unicode
    .padding:[1 4 2]
    .align:['left 'center 'right] 
[
    ["narrow" "widest" "mid"]
    ["col1"   "col2"   "col3"]
]

Function reference

tabular

Description

Create a new ASCII table with given rows

Usage
tabular rows :block
Attributes
Option Type(s) Description
header :block set table header columns
align :literal, :block set column alignments (single value or array)
unicode :logical use Unicode characters
padding :integer, :block set custom padding per column (single value or array)
Returns
  • :string

License

MIT License

Copyright (c) 2024 Yanis Zafirópulos

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.