History

Naz c5b8d073d7 Published new versions - @tryghost/adapter-manager@0.2.31 - @tryghost/api-version-compatibility-service@0.3.0 - @tryghost/bootstrap-socket@0.2.20 - @tryghost/config-url-helpers@0.1.8 - @tryghost/constants@1.0.5 - @tryghost/database-info@0.3.5 - @tryghost/email-content-generator@0.1.2 - @tryghost/image-transform@1.0.32 - @tryghost/job-manager@0.8.24 - @tryghost/limit-service@1.1.3 - @tryghost/minifier@0.1.15 - @tryghost/moleculer-service-from-class@0.2.26 - @tryghost/mw-api-version-mismatch@0.1.4 - @tryghost/mw-error-handler@1.0.1 - @tryghost/mw-session-from-token@0.1.32 - @tryghost/mw-update-user-last-seen@0.1.6 - @tryghost/package-json@1.0.21 - @tryghost/pretty-cli@1.2.27 - @tryghost/promise@0.1.18 - @tryghost/release-utils@0.7.15 - @tryghost/security@0.3.1 - @tryghost/session-service@0.1.42 - @tryghost/settings-path-manager@0.1.7 - @tryghost/update-check-service@0.3.4 - @tryghost/version-notifications-data-service@0.1.2 - @tryghost/zip@1.1.25		2022-05-09 18:25:48 +08:00
..
lib
test
.eslintrc.js
index.js
LICENSE	2022	2022-01-06 09:52:35 +00:00
package.json	Published new versions	2022-05-09 18:25:48 +08:00
README.md	2022	2022-01-06 09:52:35 +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