From 26105034da4fcce7ac883c899d781f016559310d Mon Sep 17 00:00:00 2001 From: ruki Date: Thu, 8 Nov 2018 00:38:48 +0800 Subject: switch to vuepress --- node_modules/meow/index.js | 112 +++++++++++++++++++ node_modules/meow/license | 9 ++ node_modules/meow/package.json | 62 +++++++++++ node_modules/meow/readme.md | 246 +++++++++++++++++++++++++++++++++++++++++ 4 files changed, 429 insertions(+) create mode 100644 node_modules/meow/index.js create mode 100644 node_modules/meow/license create mode 100644 node_modules/meow/package.json create mode 100644 node_modules/meow/readme.md (limited to 'node_modules/meow') diff --git a/node_modules/meow/index.js b/node_modules/meow/index.js new file mode 100644 index 00000000..24dbb461 --- /dev/null +++ b/node_modules/meow/index.js @@ -0,0 +1,112 @@ +'use strict'; +const path = require('path'); +const buildMinimistOptions = require('minimist-options'); +const yargs = require('yargs-parser'); +const camelcaseKeys = require('camelcase-keys'); +const decamelizeKeys = require('decamelize-keys'); +const trimNewlines = require('trim-newlines'); +const redent = require('redent'); +const readPkgUp = require('read-pkg-up'); +const loudRejection = require('loud-rejection'); +const normalizePackageData = require('normalize-package-data'); + +// Prevent caching of this module so module.parent is always accurate +delete require.cache[__filename]; +const parentDir = path.dirname(module.parent.filename); + +module.exports = (helpMessage, options) => { + loudRejection(); + + if (typeof helpMessage === 'object' && !Array.isArray(helpMessage)) { + options = helpMessage; + helpMessage = ''; + } + + options = Object.assign({ + pkg: readPkgUp.sync({ + cwd: parentDir, + normalize: false + }).pkg || {}, + argv: process.argv.slice(2), + inferType: false, + input: 'string', + help: helpMessage, + autoHelp: true, + autoVersion: true, + booleanDefault: false + }, options); + + const minimistFlags = options.flags && typeof options.booleanDefault !== 'undefined' ? Object.keys(options.flags).reduce( + (flags, flag) => { + if (flags[flag].type === 'boolean' && !Object.prototype.hasOwnProperty.call(flags[flag], 'default')) { + flags[flag].default = options.booleanDefault; + } + + return flags; + }, + options.flags + ) : options.flags; + + let minimistoptions = Object.assign({ + arguments: options.input + }, minimistFlags); + + minimistoptions = decamelizeKeys(minimistoptions, '-', {exclude: ['stopEarly', '--']}); + + if (options.inferType) { + delete minimistoptions.arguments; + } + + minimistoptions = buildMinimistOptions(minimistoptions); + + if (minimistoptions['--']) { + minimistoptions.configuration = Object.assign({}, minimistoptions.configuration, {'populate--': true}); + } + + const {pkg} = options; + const argv = yargs(options.argv, minimistoptions); + let help = redent(trimNewlines((options.help || '').replace(/\t+\n*$/, '')), 2); + + normalizePackageData(pkg); + + process.title = pkg.bin ? Object.keys(pkg.bin)[0] : pkg.name; + + let {description} = options; + if (!description && description !== false) { + ({description} = pkg); + } + + help = (description ? `\n ${description}\n` : '') + (help ? `\n${help}\n` : '\n'); + + const showHelp = code => { + console.log(help); + process.exit(typeof code === 'number' ? code : 2); + }; + + const showVersion = () => { + console.log(typeof options.version === 'string' ? options.version : pkg.version); + process.exit(); + }; + + if (argv.version && options.autoVersion) { + showVersion(); + } + + if (argv.help && options.autoHelp) { + showHelp(0); + } + + const input = argv._; + delete argv._; + + const flags = camelcaseKeys(argv, {exclude: ['--', /^\w$/]}); + + return { + input, + flags, + pkg, + help, + showHelp, + showVersion + }; +}; diff --git a/node_modules/meow/license b/node_modules/meow/license new file mode 100644 index 00000000..e7af2f77 --- /dev/null +++ b/node_modules/meow/license @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) Sindre Sorhus (sindresorhus.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/meow/package.json b/node_modules/meow/package.json new file mode 100644 index 00000000..7ce4d8d8 --- /dev/null +++ b/node_modules/meow/package.json @@ -0,0 +1,62 @@ +{ + "name": "meow", + "version": "5.0.0", + "description": "CLI app helper", + "license": "MIT", + "repository": "sindresorhus/meow", + "author": { + "name": "Sindre Sorhus", + "email": "sindresorhus@gmail.com", + "url": "sindresorhus.com" + }, + "engines": { + "node": ">=6" + }, + "scripts": { + "test": "xo && ava" + }, + "files": [ + "index.js" + ], + "keywords": [ + "cli", + "bin", + "util", + "utility", + "helper", + "argv", + "command", + "line", + "meow", + "cat", + "kitten", + "parser", + "option", + "flags", + "input", + "cmd", + "console" + ], + "dependencies": { + "camelcase-keys": "^4.0.0", + "decamelize-keys": "^1.0.0", + "loud-rejection": "^1.0.0", + "minimist-options": "^3.0.1", + "normalize-package-data": "^2.3.4", + "read-pkg-up": "^3.0.0", + "redent": "^2.0.0", + "trim-newlines": "^2.0.0", + "yargs-parser": "^10.0.0" + }, + "devDependencies": { + "ava": "*", + "execa": "^0.10.0", + "indent-string": "^3.0.0", + "xo": "*" + }, + "xo": { + "rules": { + "unicorn/no-process-exit": "off" + } + } +} diff --git a/node_modules/meow/readme.md b/node_modules/meow/readme.md new file mode 100644 index 00000000..43970f79 --- /dev/null +++ b/node_modules/meow/readme.md @@ -0,0 +1,246 @@ +# meow [![Build Status](https://travis-ci.org/sindresorhus/meow.svg?branch=master)](https://travis-ci.org/sindresorhus/meow) + +> CLI app helper + +![](meow.gif) + + +## Features + +- Parses arguments +- Converts flags to [camelCase](https://github.com/sindresorhus/camelcase) +- Outputs version when `--version` +- Outputs description and supplied help text when `--help` +- Makes unhandled rejected promises [fail loudly](https://github.com/sindresorhus/loud-rejection) instead of the default silent fail +- Sets the process title to the binary name defined in package.json + + +## Install + +``` +$ npm install meow +``` + + +## Usage + +``` +$ ./foo-app.js unicorns --rainbow +``` + +```js +#!/usr/bin/env node +'use strict'; +const meow = require('meow'); +const foo = require('.'); + +const cli = meow(` + Usage + $ foo + + Options + --rainbow, -r Include a rainbow + + Examples + $ foo unicorns --rainbow + 🌈 unicorns 🌈 +`, { + flags: { + rainbow: { + type: 'boolean', + alias: 'r' + } + } +}); +/* +{ + input: ['unicorns'], + flags: {rainbow: true}, + ... +} +*/ + +foo(cli.input[0], cli.flags); +``` + + +## API + +### meow(options, [minimistOptions]) + +Returns an `Object` with: + +- `input` *(Array)* - Non-flag arguments +- `flags` *(Object)* - Flags converted to camelCase +- `pkg` *(Object)* - The `package.json` object +- `help` *(string)* - The help text used with `--help` +- `showHelp([code=2])` *(Function)* - Show the help text and exit with `code` +- `showVersion()` *(Function)* - Show the version text and exit + +#### options + +Type: `Object` `Array` `string` + +Can either be a string/array that is the `help` or an options object. + +##### flags + +Type: `Object` + +Define argument flags. + +The key is the flag name and the value is an object with any of: + +- `type`: Type of value. (Possible values: `string` `boolean`) +- `alias`: Usually used to define a short flag alias. +- `default`: Default value when the flag is not specified. + +Example: + +```js +flags: { + unicorn: { + type: 'string', + alias: 'u', + default: 'rainbow' + } +} +``` + + +##### description + +Type: `string` `boolean`
+Default: The package.json `"description"` property + +Description to show above the help text. + +Set it to `false` to disable it altogether. + +##### help + +Type: `string` `boolean` + +The help text you want shown. + +The input is reindented and starting/ending newlines are trimmed which means you can use a [template literal](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/template_strings) without having to care about using the correct amount of indent. + +The description will be shown above your help text automatically. + +##### version + +Type: `string` `boolean`
+Default: The package.json `"version"` property + +Set a custom version output. + +##### autoHelp + +Type: `boolean`
+Default: `true` + +Automatically show the help text when the `--help` flag is present. Useful to set this value to `false` when a CLI manages child CLIs with their own help text. + +##### autoVersion + +Type: `boolean`
+Default: `true` + +Automatically show the version text when the `--version` flag is present. Useful to set this value to `false` when a CLI manages child CLIs with their own version text. + +##### pkg + +Type: `Object`
+Default: Closest package.json upwards + +package.json as an `Object`. + +*You most likely don't need this option.* + +##### argv + +Type: `Array`
+Default: `process.argv.slice(2)` + +Custom arguments object. + +##### inferType + +Type: `boolean`
+Default: `false` + +Infer the argument type. + +By default, the argument `5` in `$ foo 5` becomes a string. Enabling this would infer it as a number. + +##### booleanDefault + +Type: `boolean` `null` `undefined`
+Default: `false` + +Value of `boolean` flags not defined in `argv`. +If set to `undefined` the flags not defined in `argv` will be excluded from the result. +The `default` value set in `boolean` flags take precedence over `booleanDefault`. + +Example: + +```js +const cli = meow(` + Usage + $ foo + + Options + --rainbow, -r Include a rainbow + --unicorn, -r Include a unicorn + + Examples + $ foo + 🌈 unicorns 🌈 +`, { + booleanDefault: undefined, + flags: { + rainbow: { + type: 'boolean', + default: true + alias: 'r' + }, + unicorn: { + type: 'boolean', + default: false + alias: 'u' + }, + cake: { + type: 'boolean', + alias: 'c' + } + } +}); +/* +{ + flags: {rainbow: true, unicorn: false}, + … +} +*/ +``` + +## Promises + +Meow will make unhandled rejected promises [fail loudly](https://github.com/sindresorhus/loud-rejection) instead of the default silent fail. Meaning you don't have to manually `.catch()` promises used in your CLI. + + +## Tips + +See [`chalk`](https://github.com/chalk/chalk) if you want to colorize the terminal output. + +See [`get-stdin`](https://github.com/sindresorhus/get-stdin) if you want to accept input from stdin. + +See [`conf`](https://github.com/sindresorhus/conf) if you need to persist some data. + +See [`update-notifier`](https://github.com/yeoman/update-notifier) if you want update notifications. + +[More useful CLI utilities…](https://github.com/sindresorhus/awesome-nodejs#command-line-utilities) + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) -- cgit v1.2.3