c52b095955
- Getting used to developing in the monorepo structure - Add more instructions that are relevant, push people to the top level repo - Make READMEs as consistent as possible - PROFIT! |
||
|---|---|---|
| .. | ||
| test | ||
| .eslintrc.js | ||
| index.js | ||
| LICENSE | ||
| package.json | ||
| pretty-cli.js | ||
| README.md | ||
| styles.js | ||
Pretty CLI
A mini-module to style a sywac instance in a standard way
Install
Either: npm i @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 lintrun just eslintyarn testrun lint && tests
Copyright & License
Copyright (c) 2018 Ghost Foundation - Released under the MIT license.