https://github.com/vitiral/termstyle

create and test the style and formatting of text in your terminal applications
https://github.com/vitiral/termstyle

Last synced: 7 days ago
JSON representation

create and test the style and formatting of text in your terminal applications

• Host: GitHub
• URL: https://github.com/vitiral/termstyle
• Owner: vitiral
• License: other
• Created: 2018-01-09T14:34:54.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-02-12T22:43:23.000Z (over 6 years ago)
• Last Synced: 2024-10-18T21:53:47.943Z (16 days ago)
• Language: Rust
• Homepage: https://docs.rs/termstyle
• Size: 43.9 KB
• Stars: 18
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

• awesome-rust-cn - vitiral/termstyle
• awesome-rust - vitiral/termstyle
• awesome-rust-zh - vitiral/termstyle - 构建（和测试）格式化和样式化的命令行应用程序 (库 / 命令行)
• awesome-rust - vitiral/termstyle

README

        
- **description**: create and test the style and formatting of text in your

  terminal applications

- **docs**: https://docs.rs/termstyle

**termstyle** is a library that aims to make it easy to build (and test)

**formatted** and **styled** command line applications. It supports the following "elements":

- **styled-text**

    - italic

    - bold

    - colors

- **tables**: composed of styled text with identical width columns

Text can be constructed programatically by pushing tokens onto a vector and

then `paint()`ing them, or by parsing a `yaml` file. This allows you to easily

write unit tests for your command line applications.

## Example

Given the following config (written in yaml):

```yaml

- {t: "-- EXAMPLE --\n", b: true}

- "This is a regular string with a newline\n"

- "This does not have a newline, but "

- {t: "this is red", c: red}

- ", but this is NOT red!\n"

- "Bold is easy like this: "

- {t: "see I'm bold!!\n", b: true}

- And so is multiple settings

- # long-form

  t: |

      bold AND green!

      and even multiple lines :) :)

  b: true

  c: green

- ["\nyou can group multiple text items ", {t: "on one line!", b: true}]

- "\nGrouping things in one line is necessary for tables\n"

- "Notice that some cells are grouped and some are not.\n\n"

- [{t: "# Table", b: true}, "\n"]

-

  table:

  - [["header ", {t: "col1", b: true}] ,"| header col2"]

  - ["row col1", ["| ", {t: "row col2", c: green}]]

```

Use the following to render it:

```rust

let els = termstyle::from_str(serde_yaml::from_str, example).unwrap();

termstyle::paint(&mut ::std::io::stdout(), &els).unwrap();

```

Which gets rendered as:

![rendered](img/example.png)

You can also create the "stream of elements" using the types provided by the

library.  For more information, see the

[library docs](https://docs.rs/termstyle).

# LICENSE

The source code is Licensed under either of

* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or

  http://www.apache.org/licenses/LICENSE-2.0)

* MIT license ([LICENSE-MIT](LICENSE-MIT) or

  http://opensource.org/licenses/MIT)

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted

for inclusion in the work by you, as defined in the Apache-2.0 license, shall

be dual licensed as above, without any additional terms or conditions.