mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-24 19:33:02 +03:00
9abbe60e10
- @tryghost/adapter-manager@0.2.0 - @tryghost/bootstrap-socket@0.2.3 - @tryghost/constants@0.1.2 - @tryghost/errors@0.2.5 - @tryghost/image-transform@1.0.5 - @tryghost/job-manager@0.1.2 - @tryghost/moleculer-service-from-class@0.2.7 - @tryghost/mw-session-from-token@0.1.9 - @tryghost/pretty-cli@1.2.11 - @tryghost/promise@0.1.2 - @tryghost/release-utils@0.6.8 - @tryghost/security@0.2.1 - @tryghost/session-service@0.1.10 - @tryghost/vhost-middleware@1.0.10 - @tryghost/zip@1.1.5 |
||
|---|---|---|
| .. | ||
| lib | ||
| test | ||
| .eslintrc.js | ||
| index.js | ||
| LICENSE | ||
| package.json | ||
| 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 lintrun just eslintyarn testrun lint && tests
Copyright & License
Copyright (c) 2013-2020 Ghost Foundation - Released under the MIT license.