.gitignore added
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / minimist-options / readme.md
diff --git a/.config/coc/extensions/node_modules/coc-prettier/node_modules/minimist-options/readme.md b/.config/coc/extensions/node_modules/coc-prettier/node_modules/minimist-options/readme.md
new file mode 100644 (file)
index 0000000..08ce220
--- /dev/null
@@ -0,0 +1,63 @@
+# minimist-options [![Build Status](https://travis-ci.org/vadimdemedes/minimist-options.svg?branch=master)](https://travis-ci.org/vadimdemedes/minimist-options)
+
+> Write options for [minimist](https://npmjs.org/package/minimist) in a comfortable way.
+
+## Installation
+
+```
+$ npm install --save minimist-options
+```
+
+## Usage
+
+```js
+const buildOptions = require('minimist-options');
+const minimist = require('minimist');
+
+const options = buildOptions({
+       name: {
+               type: 'string',
+               alias: 'n',
+               default: 'john'
+       },
+
+       force: {
+               type: 'boolean',
+               alias: ['f', 'o'],
+               default: false
+       },
+
+       published: 'boolean',
+
+       // special option for positional arguments (`_` in minimist)
+       arguments: 'string'
+});
+
+const args = minimist(options);
+```
+
+instead of:
+
+```js
+const minimist = require('minimist');
+
+const options = {
+       string: ['name', '_'],
+       boolean: ['force', 'published'],
+       alias: {
+               n: 'name',
+               f: 'force',
+               o: 'force'
+       },
+       default: {
+               name: 'john',
+               f: false
+       }
+};
+
+const args = minimist(options);
+```
+
+## License
+
+MIT © [Vadim Demedes](https://vadimdemedes.com)