# sywac-style-basic

> Basic color styling for your sywac CLI

Latest version **2.0.0** (published 2020-05-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install sywac-style-basic
pnpm add sywac-style-basic
yarn add sywac-style-basic
bun add sywac-style-basic
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2020-05-16 |
| First published | 2018-12-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 1 |
| Unpacked size | 5.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | nexdrew |
| Maintainers | nexdrew |
| Keywords | sywac, cli, color, chalk, basic, style, ansi |

## Links

- npm: https://www.npmjs.com/package/sywac-style-basic
- Repository: https://github.com/sywac/sywac-style-basic
- Homepage: https://sywac.io/docs/sync-config.html#style
- Issues: https://github.com/sywac/sywac-style-basic/issues
- npm.io page: https://npm.io/package/sywac-style-basic

## Dependencies (1)

- [chalk](https://npm.io/package/chalk.md) ^4.0.0

## Alternatives

- [postcss-color-hex-alpha](https://npm.io/package/postcss-color-hex-alpha.md) — 6.4M weekly downloads
- [randomcolor](https://npm.io/package/randomcolor.md) — 348.0K weekly downloads
- [bows](https://npm.io/package/bows.md) — 1.3K weekly downloads
- [ep_prefer_color_scheme](https://npm.io/package/ep_prefer_color_scheme.md) — 260 weekly downloads
- [coc-yank](https://npm.io/package/coc-yank.md) — 61 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2020-05-16
- 1.0.2 — 2019-08-20
- 1.0.1 — 2018-12-29
- 1.0.0 — 2018-12-21

## README

# sywac-style-basic

> Basic color styling for your sywac CLI

[![Build Status](https://travis-ci.com/sywac/sywac-style-basic.svg?branch=master)](https://travis-ci.com/sywac/sywac-style-basic)
[![Coverage Status](https://coveralls.io/repos/github/sywac/sywac-style-basic/badge.svg?branch=master)](https://coveralls.io/github/sywac/sywac-style-basic?branch=master)
[![JavaScript Style Guide](https://badgen.net/badge/code%20style/standard/green)](https://standardjs.com)
![Dependabot Badge](https://badgen.net/dependabot/sywac/sywac-style-basic?icon=dependabot)

![Default Help Screenshot](screenshot1.png)
![Error Message Screenshot](screenshot2.png)

Easily add "basic" color styling to your sywac CLI:

```js
// cli.js
const cli = require('sywac')
const basicStyle = require('sywac-style-basic')
cli.style(basicStyle)
```

This will add style hooks to make your CLI help text colorful/pretty.

Note that this package DOES NOT wrap/include/come with sywac - you should have sywac as a sibling dependency.

Visit https://sywac.io/docs/sync-config.html#style for detailed documentation.

## Install

Install sywac and this package together, saving them as production dependencies in your package.json file:

```console
$ npm i -P sywac sywac-style-basic
```

See code snippet above for usage.

## Related

- [sywac](https://sywac.io/) - The CLI library you should be using with this package
- [chalk](https://github.com/chalk/chalk) - The library used by this package to make pretty colors
- [@tryghost/pretty-cli](https://www.npmjs.com/package/@tryghost/pretty-cli) - Wraps/exposes a sywac instance preconfigured with its own opinionated styling
- [cies](https://github.com/nexdrew/cies) - Example of a CLI that uses this package

## License

MIT © Andrew Goode

---
_Source: https://npm.io/package/sywac-style-basic · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._