TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-12-27 12:53:13 +03:00
Code Issues Projects Releases Wiki Activity
f6d5480c4f
Ghost/ghost/pretty-cli
History
Daniel Lockyer f6d5480c4f Renamed TryGhost/Ghost-Utils links to TryGhost/Utils 
no issue

- this repository has been renamed so this commit just brings all the
  links inline with this change
2021-01-12 16:40:16 +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 🎨 Update to use files array in package.json 2018-11-29 16:04:13 +00:00
LICENSE 2020 2020-01-07 19:06:08 +00:00
package.json Renamed TryGhost/Ghost-Utils links to TryGhost/Utils 2021-01-12 16:40:16 +00:00
README.md 2020 2020-01-07 19:06:08 +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

Copyright & License

Copyright (c) 2013-2020 Ghost Foundation - Released under the MIT license.