Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thecodrr/crayon
🖍️ Paint your terminal output like Picasso 🎨
https://github.com/thecodrr/crayon
chalk color console terminal terminal-colors terminal-style v vlang
Last synced: 3 months ago
JSON representation
🖍️ Paint your terminal output like Picasso 🎨
- Host: GitHub
- URL: https://github.com/thecodrr/crayon
- Owner: thecodrr
- License: mit
- Created: 2019-11-11T21:40:37.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-02T12:48:59.000Z (9 months ago)
- Last Synced: 2024-05-06T10:35:22.225Z (6 months ago)
- Topics: chalk, color, console, terminal, terminal-colors, terminal-style, v, vlang
- Language: V
- Homepage:
- Size: 26.4 KB
- Stars: 54
- Watchers: 5
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-v - crayon - Paint your terminal output like Picasso. 🖍️🎨 (Libraries / Text processing)
README
🖍️ Crayon
An extremely simple way to turn your bland terminal output into beautifully styled text.
## Installation:
Install using `vpkg`
```bash
vpkg get https://github.com/thecodrr/crayon
```
Install using v's builtin vpm (you will need to import the module with: `import thecodrr.crayon` with this method of installation):
```bash
v install thecodrr.crayon
```
Install using `git`:
```bash
cd path/to/your/project
git clone https://github.com/thecodrr/crayon
# Or add it as a submodule
git submodule add https://github.com/thecodrr/crayon crayon && git submodule update --init --recursive
```
Then in the wherever you want to use it:
```javascript
import crayon
```
And that's it!
## Usage
### crayon.new(texts ...`string`)
Initializes a new `Crayon` for the specified text. You can pass multiple strings in the `texts` argument. Nesting `Crayon`s is supported (see example below).
`crayon.new` returns a `Chalk` by default. Turn it into a styled `string` using the `.str()` function
```javascript
crayon.new("Hello", crayon.new("world").bold().str()).cyan().underline().str()
```
### crayon.color(text `string`)
Use this to style the text using the template API.
```javascript
crayon.color("{bold.underline I am bold and underlined} and I am not")
```
Each `template` starts with `{` and ends with `}`. All styles must come at the beginning **without any spaces**. This function returns a `string` by default. You can use `rgb` function as `rgb(92,92,92)` to use custom colors.
**Nested templates** are currently not supported (WIP) so keep in mind that.
### crayon.strip_text(text `string`)
Strip a styled `string` of all the styles returning a pure & clean `string`
### The Crayon `struct`
The `template` API uses these same names just without the `()` except for the `rgb` usage.
**Styles:**
`bold()`
`italic()`
`reverse()`
`underline()`
`strikethrough()`
`dim()`
`slow_blink()`
`rapid_blink()`
**Colors:**
*For background colors just put `bg_` before each method*
`black()`
`white()`
`red()`
`green()`
`yellow()`
`blue()`
`magenta()`
`cyan()`
`light_gray()`
`dark_gray()`
`light_red()`
`light_green()`
`light_yellow()`
`light_blue()`
`light_magenta()`
`light_cyan()`
**RGB Support**
`rbg(int,int,int)`
**Other Methods:**
`strip()` Strip the `Crayon` of all styles. Returns a `string`
`len()` Get the actual length of the styled `string`. Same as doing `strip().len()`
`print()`Print the styled `string`to`terminal`.
`print_with(...string)`Print the styled `string` to terminal with some additional `strings`
### Projects Using Crayon:
1. [thecodrr.boxx](https://github.com/thecodrr/boxx)
### Find this library useful? :heart:
Support it by joining **[stargazers](https://github.com/thecodrr/crayon/stargazers)** for this repository. :star: or [buy me a cup of coffee](https://ko-fi.com/thecodrr)
And **[follow](https://github.com/thecodrr)** me for my next creations! 🤩
# License
```xml
Copyright (c) 2019 Abdullah Atta
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.
```