History

Daniel Lockyer d8f529ef78 Published new versions - @tryghost/adapter-manager@0.2.8 - @tryghost/bootstrap-socket@0.2.6 - @tryghost/constants@0.1.5 - @tryghost/errors@0.2.8 - @tryghost/image-transform@1.0.8 - @tryghost/job-manager@0.7.2 - @tryghost/moleculer-service-from-class@0.2.11 - @tryghost/mw-session-from-token@0.1.15 - @tryghost/pretty-cli@1.2.14 - @tryghost/promise@0.1.5 - @tryghost/release-utils@0.6.11 - @tryghost/security@0.2.5 - @tryghost/session-service@0.1.16 - @tryghost/vhost-middleware@1.0.12 - @tryghost/zip@1.1.9		2021-02-09 11:54:13 +00:00
..
lib	Fixed line prefix for warning level log	2020-10-21 11:01:52 +01:00
test	Remove trailing commas from .eslintrc.js files	2020-08-04 14:48:07 +01:00
.eslintrc.js	Remove trailing commas from .eslintrc.js files	2020-08-04 14:48:07 +01:00
index.js
LICENSE	2021	2021-01-25 16:20:43 +00:00
package.json	Published new versions	2021-02-09 11:54:13 +00:00
README.md	2021	2021-01-25 16:20:43 +00:00

README.md

Pretty CLI

A mini-module to style a sywac instance in a standard way

Install

Either: npm install @tryghost/pretty-cli --save

Or: yarn add @tryghost/pretty-cli

Usage

E.g. const prettyCLI = require('@tryghost/pretty-cli');

prettyCLI is a pre-styled instance of the sywac API.

See the sywac quickstart and config guide for full usage.

Example:

#!/usr/bin/env node
const prettyCLI = require('@tryghost/pretty-cli');


prettyCLI
  .command({
    flags: 'myTask [option]',
    desc: 'Run myTask',
    run: (argv) =>  { ... do something here }
  })
  .parseAndExit();

Pretty CLI also provides a common UI interface, providing log functions to output coloured messages to the UI:

const ui = require('@tryghost/pretty-cli/ui');`

ui.log.info('Done');
ui.log.warn('Uh Oh', 'Something went wrong');

You can also grab a fresh instance of the api with prettyCLI.Api.get().

The style rules used are available at prettyCLI.styles.

Test

yarn lint run just eslint
yarn test run lint && tests

README.md

Pretty CLI

Install

Usage

Test

Copyright & License