[Pkg-javascript-commits] [node-meow] 01/03: Import Upstream version 3.7.0
Sruthi Chandran
srud-guest at moszumanska.debian.org
Thu Nov 3 06:51:32 UTC 2016
This is an automated email from the git hooks/post-receive script.
srud-guest pushed a commit to branch master
in repository node-meow.
commit f3c6d960c51ecd424157bd268b11d96ae3e814ad
Author: Sruthi <srud at disroot.org>
Date: Thu Nov 3 12:09:09 2016 +0530
Import Upstream version 3.7.0
---
.editorconfig | 15 ++++++
.gitattributes | 1 +
.gitignore | 1 +
.travis.yml | 6 +++
fixture.js | 22 ++++++++
index.js | 82 +++++++++++++++++++++++++++++
license | 21 ++++++++
meow.gif | Bin 0 -> 608785 bytes
package.json | 58 +++++++++++++++++++++
readme.md | 159 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
test.js | 71 ++++++++++++++++++++++++++
11 files changed, 436 insertions(+)
diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..8f9d77e
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = tab
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{package.json,*.yml}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..176a458
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1 @@
+* text=auto
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..3c3629e
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+node_modules
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..52ba159
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,6 @@
+sudo: false
+language: node_js
+node_js:
+ - 'stable'
+ - '0.12'
+ - '0.10'
diff --git a/fixture.js b/fixture.js
new file mode 100755
index 0000000..cf76eab
--- /dev/null
+++ b/fixture.js
@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+'use strict';
+var meow = require('./');
+
+var cli = meow({
+ description: 'Custom description',
+ help: [
+ 'Usage',
+ ' foo <input>'
+ ]
+}, {
+ alias: {u: 'unicorn'},
+ default: {meow: 'dog', camelCaseOption: 'foo'}
+});
+
+if (cli.flags.camelCaseOption === 'foo') {
+ Object.keys(cli.flags).forEach(function (el) {
+ console.log(el);
+ });
+} else {
+ console.log(cli.flags.camelCaseOption);
+}
diff --git a/index.js b/index.js
new file mode 100644
index 0000000..d7ab879
--- /dev/null
+++ b/index.js
@@ -0,0 +1,82 @@
+'use strict';
+var path = require('path');
+var minimist = require('minimist');
+var objectAssign = require('object-assign');
+var camelcaseKeys = require('camelcase-keys');
+var decamelize = require('decamelize');
+var mapObj = require('map-obj');
+var trimNewlines = require('trim-newlines');
+var redent = require('redent');
+var readPkgUp = require('read-pkg-up');
+var loudRejection = require('loud-rejection');
+var normalizePackageData = require('normalize-package-data');
+
+// get the uncached parent
+delete require.cache[__filename];
+var parentDir = path.dirname(module.parent.filename);
+
+module.exports = function (opts, minimistOpts) {
+ loudRejection();
+
+ if (Array.isArray(opts) || typeof opts === 'string') {
+ opts = {help: opts};
+ }
+
+ opts = objectAssign({
+ pkg: readPkgUp.sync({
+ cwd: parentDir,
+ normalize: false
+ }).pkg,
+ argv: process.argv.slice(2)
+ }, opts);
+
+ minimistOpts = objectAssign({}, minimistOpts);
+
+ minimistOpts.default = mapObj(minimistOpts.default || {}, function (key, value) {
+ return [decamelize(key, '-'), value];
+ });
+
+ if (Array.isArray(opts.help)) {
+ opts.help = opts.help.join('\n');
+ }
+
+ var pkg = typeof opts.pkg === 'string' ? require(path.join(parentDir, opts.pkg)) : opts.pkg;
+ var argv = minimist(opts.argv, minimistOpts);
+ var help = redent(trimNewlines(opts.help || ''), 2);
+
+ normalizePackageData(pkg);
+
+ process.title = pkg.bin ? Object.keys(pkg.bin)[0] : pkg.name;
+
+ var description = opts.description;
+ if (!description && description !== false) {
+ description = pkg.description;
+ }
+
+ help = (description ? '\n ' + description + '\n' : '') + (help ? '\n' + help : '\n');
+
+ var showHelp = function (code) {
+ console.log(help);
+ process.exit(code || 0);
+ };
+
+ if (argv.version && opts.version !== false) {
+ console.log(typeof opts.version === 'string' ? opts.version : pkg.version);
+ process.exit();
+ }
+
+ if (argv.help && opts.help !== false) {
+ showHelp();
+ }
+
+ var _ = argv._;
+ delete argv._;
+
+ return {
+ input: _,
+ flags: camelcaseKeys(argv),
+ pkg: pkg,
+ help: help,
+ showHelp: showHelp
+ };
+};
diff --git a/license b/license
new file mode 100644
index 0000000..654d0bf
--- /dev/null
+++ b/license
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Sindre Sorhus <sindresorhus at gmail.com> (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/meow.gif b/meow.gif
new file mode 100644
index 0000000..9709b51
Binary files /dev/null and b/meow.gif differ
diff --git a/package.json b/package.json
new file mode 100644
index 0000000..2750de4
--- /dev/null
+++ b/package.json
@@ -0,0 +1,58 @@
+{
+ "name": "meow",
+ "version": "3.7.0",
+ "description": "CLI app helper",
+ "license": "MIT",
+ "repository": "sindresorhus/meow",
+ "author": {
+ "name": "Sindre Sorhus",
+ "email": "sindresorhus at gmail.com",
+ "url": "sindresorhus.com"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ },
+ "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": "^2.0.0",
+ "decamelize": "^1.1.2",
+ "loud-rejection": "^1.0.0",
+ "map-obj": "^1.0.1",
+ "minimist": "^1.1.3",
+ "normalize-package-data": "^2.3.4",
+ "object-assign": "^4.0.1",
+ "read-pkg-up": "^1.0.1",
+ "redent": "^1.0.0",
+ "trim-newlines": "^1.0.0"
+ },
+ "devDependencies": {
+ "ava": "*",
+ "execa": "^0.1.1",
+ "indent-string": "^2.1.0",
+ "xo": "*"
+ }
+}
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..253380d
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,159 @@
+# meow [](https://travis-ci.org/sindresorhus/meow)
+
+> CLI app helper
+
+
+
+
+## Features
+
+- Parses arguments using [minimist](https://github.com/substack/minimist)
+- 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 --save meow
+```
+
+
+## Usage
+
+```
+$ ./foo-app.js unicorns --rainbow-cake
+```
+
+```js
+#!/usr/bin/env node
+'use strict';
+const meow = require('meow');
+const foo = require('./');
+
+const cli = meow(`
+ Usage
+ $ foo <input>
+
+ Options
+ -r, --rainbow Include a rainbow
+
+ Examples
+ $ foo unicorns --rainbow
+ 🌈 unicorns 🌈
+`, {
+ alias: {
+ r: 'rainbow'
+ }
+});
+/*
+{
+ 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` *(object)* - The help text used with `--help`
+- `showHelp([code=0])` *(function)* - Show the help text and exit with `code`
+
+#### options
+
+Type: `object`, `array`, `string`
+
+Can either be a string/array that is the `help` or an options object.
+
+##### description
+
+Type: `string`, `boolean`
+Default: The package.json `"description"` property
+
+A 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.
+
+<del>If it's an array each item will be a line.</del>
+*(Still supported, but you should use a template literal instead.)*
+
+The description will be shown above your help text automatically.
+
+Set it to `false` to disable it altogether.
+
+##### version
+
+Type: `string`, `boolean`
+Default: The package.json `"version"` property
+
+Set a custom version output.
+
+Set it to `false` to disable it altogether.
+
+##### pkg
+
+Type: `string`, `object`
+Default: Closest package.json upwards
+
+Relative path to package.json or as an object.
+
+##### argv
+
+Type: `array`
+Default: `process.argv.slice(2)`
+
+Custom arguments object.
+
+#### minimistOptions
+
+Type: `object`
+Default: `{}`
+
+Minimist [options](https://github.com/substack/minimist#var-argv--parseargsargs-opts).
+
+Keys passed to the minimist `default` option are [decamelized](https://github.com/sindresorhus/decamelize), so you can for example pass in `fooBar: 'baz'` and have it be the default for the `--foo-bar` flag.
+
+
+## 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 [`update-notifier`](https://github.com/yeoman/update-notifier) if you want update notifications.
+
+See [`configstore`](https://github.com/yeoman/configstore) if you need to persist some data.
+
+[More useful CLI utilities.](https://github.com/sindresorhus/awesome-nodejs#command-line-utilities)
+
+
+## License
+
+MIT © [Sindre Sorhus](http://sindresorhus.com)
diff --git a/test.js b/test.js
new file mode 100644
index 0000000..27fd3ce
--- /dev/null
+++ b/test.js
@@ -0,0 +1,71 @@
+import test from 'ava';
+import indentString from 'indent-string';
+import execa from 'execa';
+import pkg from './package.json';
+import fn from './';
+
+global.Promise = Promise;
+
+test('return object', t => {
+ const cli = fn({
+ argv: ['foo', '--foo-bar', '-u', 'cat'],
+ help: [
+ 'Usage',
+ ' foo <input>'
+ ]
+ }, {
+ alias: {u: 'unicorn'},
+ default: {meow: 'dog'}
+ });
+
+ t.is(cli.input[0], 'foo');
+ t.true(cli.flags.fooBar);
+ t.is(cli.flags.meow, 'dog');
+ t.is(cli.flags.unicorn, 'cat');
+ t.is(cli.pkg.name, 'meow');
+ t.is(cli.help, indentString('\nCLI app helper\n\nUsage\n foo <input>', ' '));
+});
+
+test('support help shortcut', t => {
+ const cli = fn(['unicorn', 'cat']);
+ t.is(cli.help, indentString('\nCLI app helper\n\nunicorn\ncat', ' '));
+});
+
+test('spawn cli and show version', async t => {
+ const {stdout} = await execa('./fixture.js', ['--version']);
+
+ t.is(stdout, pkg.version);
+});
+
+test('spawn cli and show help screen', async t => {
+ const {stdout} = await execa('./fixture.js', ['--help']);
+
+ t.is(stdout, indentString('\nCustom description\n\nUsage\n foo <input>', ' '));
+});
+
+test('spawn cli and test input', async t => {
+ const {stdout} = await execa('./fixture.js', ['-u', 'cat']);
+
+ t.is(stdout, 'u\nunicorn\nmeow\ncamelCaseOption');
+});
+
+test('spawn cli and test input', async t => {
+ const {stdout} = await execa('./fixture.js', ['--camel-case-option', 'bar']);
+
+ t.is(stdout, 'bar');
+});
+
+test.serial('pkg.bin as a string should work', t => {
+ fn({
+ pkg: {
+ name: 'browser-sync',
+ bin: 'bin/browser-sync.js'
+ }
+ });
+
+ t.is(process.title, 'browser-sync');
+});
+
+test('single character flag casing should be preserved', t => {
+ t.ok(fn({argv: ['-F']}).flags.F);
+});
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-meow.git
More information about the Pkg-javascript-commits
mailing list