terminal_table

A library that helps you create and print tables on your terminal!

terminal_table

A library that helps you create and print tables on your terminal!

Installation

  1. Add the dependency to your shard.yml:

    dependencies:
      terminal_table:
        github: kouroshalinaghi/terminal_table
    
  2. Run shards install

Usage

  1. You need an Array of Array of Int32 Or String (Array(Array(Int32 | String))) as rows.
  2. Create an instance of TerminalTable::Table with calling TerminalTable::Table.new(). Here are the supported arguments:
Key Type Default Value Required?
rows Array(Array(Int32 | String)) _ Yes
enable_separator Bool true No
header Array(String) [] of String No
corner_char String "+" No
row_char String "-" No
col_char String "|" No

Example:

h = ["Name", "Age"]
r = [
  ["Kourosh", 17],
  ["Dan", 32]
]

table = TerminalTable::Table.new(rows: r, header: h)
  1. Print the table with the TerminalTable::Table#to_s method! (returns a String)

puts table.to_s

Example:

+---------+-----+
|  Name   | Age |
+---------+-----+
| Kourosh | 17  |
+---------+-----+
| Dan     | 32  |
+---------+-----+

Important: Do not use p() method instead of puts()! it will consider "\n" as a normal string.

Contributing

  1. Fork it (https://github.com/kouroshalinaghi/terminal_table/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

terminal_table

Repository

terminal_table

Owner
Statistic
  • 0
  • 0
  • 0
  • 0
  • 0
  • over 3 years ago
  • August 31, 2020
License

MIT License

Links
Synced at

Tue, 23 Apr 2024 10:14:38 GMT

Languages