Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.72 KB

README.md

File metadata and controls

47 lines (31 loc) · 1.72 KB

sywac-style-basic

Basic color styling for your sywac CLI

Build Status Coverage Status JavaScript Style Guide Dependabot Badge

Default Help Screenshot Error Message Screenshot

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

// 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:

$ npm i -P sywac sywac-style-basic

See code snippet above for usage.

Related

  • sywac - The CLI library you should be using with this package
  • chalk - The library used by this package to make pretty colors
  • @tryghost/pretty-cli - Wraps/exposes a sywac instance preconfigured with its own opinionated styling
  • cies - Example of a CLI that uses this package

License

MIT © Andrew Goode