mirror of https://github.com/TryGhost/Ghost.git synced 2025-01-01 15:29:19 +03:00

History

Hannah Wolfe a929b6a0f9 ✨ Added full suite of log functions - matches logging in ignition: https://github.com/TryGhost/Ignition/blob/master/lib/logging/PrettyStream.js#L11 - so that it's possible to add log lines to our CLI tools that have a consistent format		2019-03-10 15:08:53 +00:00
..
lib	✨ Added full suite of log functions	2019-03-10 15:08:53 +00:00
test	✨ Added full suite of log functions	2019-03-10 15:08:53 +00:00
.eslintrc.js	✨ Pretty CLI - provide a styled sywac instance	2018-09-21 13:12:12 +01:00
index.js	🎨 Update to use files array in package.json	2018-11-29 16:04:13 +00:00
LICENSE	2019	2019-01-01 14:27:50 +00:00
package.json	Published new versions	2019-03-05 17:27:33 +00:00
README.md	2019	2019-01-01 14:27:50 +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();

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