https://github.com/miqueas/ink
Colorize your Lua script output with a easy to use markup
https://github.com/miqueas/ink
cli colors lua terminal
Last synced: 7 months ago
JSON representation
Colorize your Lua script output with a easy to use markup
- Host: GitHub
- URL: https://github.com/miqueas/ink
- Owner: Miqueas
- License: zlib
- Created: 2020-09-10T22:40:16.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-05T00:53:48.000Z (about 2 years ago)
- Last Synced: 2024-02-05T01:43:31.699Z (about 2 years ago)
- Topics: cli, colors, lua, terminal
- Language: Lua
- Homepage:
- Size: 58.6 KB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![License][LicenseBadge]][licenseURL]
¡Lee la versión en español [aquí](README_es.md)!
# Ink
Colorize the output of your Lua scripts with Ink like:
```lua
local ink = require("Ink")
local my_string = "Hello, #{FG(Green)}world!#{None}"
ink:print(my_string)
```
And the output looks like this:
You can form more complex outputs like this:
```lua
local ink = require("Ink")
local my_string = "#{Bold}This#{None} #{Blink; Italic}is#{None} #{Reverse; FG(RGB(167, 110, 78))}a#{None} #{DobleU; Strike}more#{None} #{BG(146)}complex#{None} %s."
local my_format = "example"
ink:print(my_string, my_format)
```
Output:
The word "is" has the "Blink" effect, so you can't see in the capture.
### Usage
Using Ink is really simple, you only need put the output properties inside of `#{}`, separating each one using a semicolon (;) and Ink make the rest. Ink allow the following properties:
- "Effects":
* None (reset all properties)
* Bold
* Dim
* Italic
* Underline
* Blink
* Reverse
* Hidden
* Strike
* DobleU ("Doble Underline")
- Colors: you can use colors only with `FG()` (Foreground) and `BG()` (Background) functions.
* Black
* Red
* Green
* Yellow
* Blue
* Magenta
* Cyan
* White
`FG()` and `BG()` functions take 3 types of arguments and only 1 of each it:
1. A predefined color (one of you see in the above list). [Read this][1]
2. A number from 0 to 255. [Read this][2]
3. A RGB value using the `RGB()` function. [Read this][3]
Ink is case-sensitive. Ink know that `FG` is a function for foreground colors, but `fg` is another thing. Also, Ink provide 2 functions/methods:
1. `compile()`: takes an string, convert all `#{}` groups into a ANSI escape code and returns the result string.
2. `print(...)`: takes an string, formats it with the rest of arguments, passes it to `compile()` and prints it directly.
Of course, if you want to use manually ANSI codes, Ink provide:
- `Ink.Cache`: For internal purposes, contains the cached strings.
- `Ink.DisableCache`: Disables the caching if `true`, `false` by default.
- `Ink.ESC`: The character for colored output (`0x1b`).
- `Ink.Attr`: Maybe the name is not correct, but basically contains the number code for output "effects".
- `Ink.FG`: Contains predefined colors (see the first list). You can use it like:
```lua
local ink = require("Ink")
local my_string = ink.ESC .. "[" .. ink.FG.Green .. "mTesting!" .. ink.ESC .. "[" .. ink.Attr.None
print(my_string)
```
- `Ink.BG`: same as `FG` but for background colors.
__Is very important to separate properties with a semicolon (please read "Limitations" below).__
### Limitations
If you don't use semicolons properly, the output maybe wrong because the code behinds Ink is actually simple and don't check this details. The same case if for when you put various semicolons with no properties between each one. Maybe there's others limitations, but I only know these.
Of course, this things are in "TODO" and I want to improve this library.
### Sources
I made this using the info provide by Wikipedia in [this article][4]
[1]: https://en.wikipedia.org/wiki/ANSI_escape_code#3/4_bit
[2]: https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit
[3]: https://en.wikipedia.org/wiki/ANSI_escape_code#24-bit
[4]: https://en.wikipedia.org/wiki/ANSI_escape_code
[LicenseBadge]: https://img.shields.io/badge/License-Zlib-brightgreen?style=for-the-badge
[LicenseURL]: https://opensource.org/licenses/Zlib