24 | 
25 | 11 | 12 | [](./../../) 13 | 14 | ## Install 15 | 16 | ```sh 17 | npm install meow cli-meow-help 18 | ``` 19 | 20 |
21 | 22 | [](./../../) 23 | 24 | ## Usage 25 | 26 | ```js 27 | const meow = require('meow'); 28 | const meowHelp = require('cli-meow-help'); 29 | 30 | const commands = { 31 | new: {desc: `Creates a new user account`}, 32 | duplicate: {desc: `Duplicates a user account`} 33 | }; 34 | 35 | const flags = { 36 | random: { 37 | desc: `Prints random data`, 38 | type: 'boolean', 39 | default: true 40 | } 41 | }; 42 | 43 | const helpText = meowHelp({ 44 | name: `cli-command`, 45 | flags, 46 | commands 47 | }); 48 | 49 | meow(helpText, {flags}); 50 | 51 | // Now run `cli-command --help` to view the 52 | // following auto formatted & generated help info. 53 | ``` 54 | 55 | [](./../../) 56 | 57 |
58 | 59 | [](./../../) 60 | 61 | ## API 62 | 63 | ### meowHelp(options) 64 | 65 | #### ❯ options 66 | 67 | Type: `object` 68 | 69 | Default: ↓ 70 | 71 | ```js 72 | { 73 | name = `(CLI name undefined)`, 74 | desc, 75 | commands = {}, 76 | flags = {}, 77 | examples = [], 78 | defaults = true, 79 | header, 80 | footer 81 | } 82 | ``` 83 | 84 | You can specify the options below. 85 | 86 | #### ❯ name 87 | 88 | Type: `string`
89 | Default: `(CLI name undefined)` 90 | 91 | The `bin` command name of the cli that's used to run the CLI. Examples: `corona` for the [corona-cli](https://github.com/AhmadAwais/corona-cli) that's installed globally or `npx corona-cli` for if `npx` is the recommended usage. 92 | 93 | #### ❯ desc 94 | 95 | Type: `string`
96 | Default: `undefined` (optional) 97 | 98 | Optionally define a description text for the help message. 99 | 100 | #### ❯ commands 101 | 102 | Type: `string`
103 | Default: `{}` (optional) 104 | 105 | Optionally, define a JavaScript object containing info on the CLI commands (i.e. `meow` inputs). Each command has a `desc` property to define the help text. 106 | 107 | #### ❯ flags 108 | 109 | Type: `string`
110 | Default: `{}` 111 | 112 | Define CLI options (i.e. `meow` flags) just like you do with `meow` which is the `flags` JavaScript object containing each flag with an extra `desc` property to define the help text. 113 | 114 | ##### > examples 115 | 116 | Type: `Array`
117 | Default: `[]` 118 | 119 | List optional examples of how to use the CLI. 120 | 121 | > Check the [test](./test.js) file for more context. Format example: 122 | 123 | ```js 124 | const examples = [ 125 | 126 | { 127 | command: `new`, 128 | flags: [`random`] 129 | } 130 | ]; 131 | ``` 132 | 133 | 134 | #### ❯ defaults 135 | 136 | Type: `string`
137 | Default: `true` (optional) 138 | 139 | Prints out the default values of flags. Set to `false` to disable. 140 | 141 | #### ❯ header 142 | 143 | Type: `string`
144 | Default: `undefined` (optional) 145 | 146 | Optionally, add additional header information. 147 | 148 | #### ❯ footer 149 | 150 | Type: `string`
151 | Default: `undefined` (optional) 152 | 153 | Optionally, add additional footer information. 154 | 155 |
156 | 157 | [](changelog.md) 158 | 159 | ## Changelog 160 | 161 | [❯ Read the changelog here →](changelog.md) 162 | 163 |
164 | 165 | **KEY**: `📦 NEW`, `👌 IMPROVE`, `🐛 FIX`, `📖 DOC`, `🚀 RELEASE`, and `🤖 TEST` 166 | 167 | > _I use [Emoji-log](https://github.com/ahmadawais/Emoji-Log), you should try it and simplify your git commits._ 168 | 169 | 170 | 171 |
172 | 173 | [](./../../) 174 | 175 | ## License & Conduct 176 | 177 | - MIT © [Ahmad Awais](https://twitter.com/MrAhmadAwais/) 178 | - Thanks to Maarten Brakkee for initial implementation 179 | - [Code of Conduct](code-of-conduct.md) 180 | 181 |
182 | 183 | [](./../../) 184 | 185 | ## Connect 186 | 187 |
188 |
194 |
195 | 
(follow) To stay up to date on free & open-source software
(follow) To get #OneDevMinute daily hot tips & trolls
(subscribe) To tech talks & #OneDevMinute videos
(read) In-depth & long form technical articles
(connect) On the LinkedIn profile y'all
196 | 197 | [](https://github.com/AhmadAwais/sponsor) 198 | 199 | ## Sponsor 200 | 201 | Me ([Ahmad Awais](https://twitter.com/mrahmadawais/)) and my incredible wife ([Maedah Batool](https://twitter.com/MaedahBatool/)) are two engineers who fell in love with open source and then with each other. You can read more [about me here](https://ahmadawais.com/about). If you or your company use any of my projects or like what I’m doing then consider backing me. I'm in this for the long run. An open-source developer advocate. 202 | 203 | [](https://twitter.com/mrahmadawais/) 204 | 205 | ### [NodeCLI.com][n] — Learn to build Node.js CLI Automation 206 | 207 | > This repository is part of the [NodeCLI.com][n] course. 208 | 209 | After building hundreds of developer automation tools used by millions of developers, I am sharing exactly how you can do it yourself with minimum effective effort. Learn to build Node.js & JavaScript based CLI (Command Line Interface) apps. Automate the grunt work, do more in less time, impress your manager, and help the community. 210 | → I'm sharing it all in this online video course. [Node CLI Automation 211 | without wasting a 1,000 hours][n] → 212 | 213 | [][n] 214 | 215 | [][n] 216 | 217 | [n]: https://NodeCLI.com?utm_source=github&utm_medium=referral&utm_campaign=ahmadawais/cli-meow-help 218 | 219 | [](https://github.com/AhmadAwais/sponsor) 220 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import meowHelp from './index.js'; 2 | 3 | const commands = { 4 | new: {desc: `Create a new user account`}, 5 | duplicate: {desc: `Duplicates a user account`} 6 | }; 7 | 8 | const flags = { 9 | random: { 10 | desc: `Prints some random data`, 11 | type: 'boolean', 12 | alias: `r`, // Old versions of meow used `shortFlag` instead of `alias`. 13 | default: true 14 | }, 15 | more: { 16 | desc: `Prints more random data`, 17 | type: 'boolean', 18 | shortFlag: `m`, // Latest addition of meow. 19 | default: true 20 | } 21 | }; 22 | 23 | const examples = [ 24 | { 25 | command: `new` 26 | }, 27 | { 28 | command: `new`, 29 | flags: [`random`] 30 | }, 31 | { 32 | command: `new`, 33 | flags: [`random`, `more`] 34 | } 35 | ]; 36 | 37 | const helpText = meowHelp({ 38 | name: `cli-command`, 39 | flags, 40 | commands, 41 | examples 42 | }); 43 | 44 | console.log(helpText); 45 | -------------------------------------------------------------------------------- /utils/createTable.js: -------------------------------------------------------------------------------- 1 | import Table from "cli-table3"; 2 | 3 | export default () => { 4 | return new Table({ 5 | chars: { 6 | top: '', 7 | 'top-mid': '', 8 | 'top-left': '', 9 | 'top-right': '', 10 | bottom: '', 11 | 'bottom-mid': '', 12 | 'bottom-left': '', 13 | 'bottom-right': '', 14 | left: '', 15 | 'left-mid': '', 16 | mid: '', 17 | 'mid-mid': '', 18 | right: '', 19 | 'right-mid': '', 20 | middle: '' 21 | }, 22 | style: { 23 | 'padding-left': 0, 24 | 'padding-right': 2 25 | }, 26 | wordWrap: true 27 | }); 28 | }; 29 | -------------------------------------------------------------------------------- /utils/getDefaultValue.js: -------------------------------------------------------------------------------- 1 | import chalk from "chalk"; 2 | 3 | let defaultValue = ``; 4 | const defaultText = `Default:`; 5 | 6 | export default (defaults, options) => { 7 | if (defaults && options.default) { 8 | defaultValue = `${defaultText} ${chalk.yellow(`${options.default}`)}`; 9 | } else if (defaults && options.type === `boolean`) { 10 | defaultValue = `${defaultText} ${chalk.yellow(`false`)}`; 11 | } 12 | return defaultValue; 13 | }; 14 | -------------------------------------------------------------------------------- /utils/pkg-cmd.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | import returnPackageUp from './pkg-up.js'; 4 | 5 | function returnPackageCommand(pkg = returnPackageUp()) { 6 | if (typeof pkg.bin !== 'undefined') { 7 | return Object.keys(pkg.bin)[0]; 8 | } else { 9 | return 'meow-help'; 10 | } 11 | } 12 | 13 | export default returnPackageCommand; 14 | -------------------------------------------------------------------------------- /utils/pkg-up.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | import path from "path"; 4 | import readPkgUp from "read-pkg-up"; 5 | 6 | function returnPackageUp(parentModule = module.parent) { 7 | // Prevent caching of this module so module.parent is always accurate 8 | delete require.cache[__filename]; 9 | 10 | if (parentModule !== null) { 11 | return readPkgUp.sync({ 12 | cwd: path.dirname(parentModule.filename) 13 | }).package; 14 | } else { 15 | return {}; 16 | } 17 | } 18 | 19 | export default returnPackageUp; 20 | --------------------------------------------------------------------------------