https://github.com/akxcv/krasivo
Communicate prettily.
https://github.com/akxcv/krasivo
ascii emoji pretty-print productivity-2018 slack
Last synced: 24 days ago
JSON representation
Communicate prettily.
- Host: GitHub
- URL: https://github.com/akxcv/krasivo
- Owner: akxcv
- License: mit
- Created: 2018-01-19T00:02:08.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T19:14:35.000Z (almost 3 years ago)
- Last Synced: 2025-03-18T05:34:45.013Z (8 months ago)
- Topics: ascii, emoji, pretty-print, productivity-2018, slack
- Language: JavaScript
- Homepage: http://akxcv.com/krasivo
- Size: 4.54 MB
- Stars: 16
- Watchers: 1
- Forks: 4
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# krasivo
> Russian for: prettily
## Installation
You can use krasivo without installing it with npm like this:
```sh
npx krasivo [your text] [foreground string] [background string]
```
Install with [yarn](https://yarnpkg.com):
```sh
yarn global add krasivo
```
Or, with npm:
```sh
npm i -g krasivo
```
## Usage
To use via command line:
```sh
krasivo [your text] [foreground string] [background string]
```
To use in JS code:
```js
import krasivo from 'krasivo'
console.log(krasivo('hello', 'x', ' '))
```
## API
To get help with the API, run:
```sh
krasivo --help
```
### Available options:
#### - `shortEmoji` (default: `true`)
When true, emoji names like `:no_good:` are converted to Unicode emoji symbols.
**CLI usage**:
```sh
krasivo hello :no_good: :no_entry: --short-emoji
# or:
krasivo hello :no_good: :no_entry: -e
# To disable:
krasivo hello :no_good: :no_entry: --no-short-emoji
```
**JS usage**:
```js
krasivo('hello', ':no_good:', ':no_entry:', { shortEmoji: true })
// To disable:
krasivo('hello', ':no_good:', ':no_entry:', { shortEmoji: false })
```
> Slack limits message length, and after the limit is broken, the only way to send the
message is to
send a "code snippet". The problem is, every symbol in an emoji name is counted as a
separate character. `shortEmoji` feature allows you to use any emoji in your message by
converting emoji names to actual Unicode emoji symbols, which are all 1 character long in
Slack.
#### - `skinTone` (default: `undefined`)
When given a number (typically from 2 to 6), adds a skin tone to emoji that support skin tone
variations. You can always specify a skin tone yourself (`:no_good::skin-tone-6:`), this will
override the value specified in `skinTone`. It's best to configure this option in a [local
config file](#local-config-file).
**CLI usage**:
```sh
krasivo hello :no_good: :no_entry: --skin-tone=2
# or:
krasivo hello :no_good: :no_entry: -s 2
```
**JS usage**:
```js
krasivo('hello', ':no_good:', :no_entry:, { skinTone: 2 })
```
### Skin colours
Skin colours are supported in Slack style:
`":no_good:"` => 🙅
`":no_good::skin-tone-2:"` => 🙅🏻
`":no_good::skin-tone-3:"` => 🙅🏼
`":no_good::skin-tone-4:"` => 🙅🏽
`":no_good::skin-tone-5:"` => 🙅🏾
`":no_good::skin-tone-6:"` => 🙅🏿
## Local config file
Krasivo CLI looks for a `.krasivorc` YAML file in your home directory. For example, to configure
a default skin tone, and to disable emoji replacement, create the following file:
```yaml
# ~/.krasivorc
options:
skinTone: 2
shortEmoji: false
```
## License
MIT