Simple help and sanity checks for Node CLI bin scripts
npm install simple-bin-help> Simple help and sanity checks for Node CLI bin scripts
[![NPM][simple-bin-help-icon] ][simple-bin-help-url]
[![Build status][simple-bin-help-ci-image] ][simple-bin-help-ci-url]
[![semantic-release][semantic-image] ][semantic-url]
[![renovate-app badge][renovate-badge]][renovate-app]
npm install --save simple-bin-help
Imagine for example that your bin script needs at least a single string argument, like
this my-tool "foo". Then we can output simple help like this
``js
#!/usr/bin/env node
require('simple-bin-help')({
minArguments: 3,
packagePath: __dirname + '/../package.json',
help: 'use: my-tool '
});
`
Single options object, with the following properties
`js`
var options = {
noExit: true | false, // simple-bin-help by default calls process.exit
help: 'help string', // to display if invalid arguments
minArguments: n, // min number of arguments to check
pkg: packageObject, // package (or pkg) object or path for better message
packagePath: 'path/to/package.json',
onFail: fn // user-supplied function to be called after help has been shown
};
require('simple-bin-help')(options);
If noExit is true, the call simply shows the error message if number of arguments is
invalid and returns a boolean result.
For more examples, see examples/basic.js file that calls the method
with several permutations.
You might do your own argument pre-processing before calling this module. In this
case pass the list of arguments as the second argument
`js`
var args = process.argv.filter(myFilter);
require('simple-bin-help')(options, args);
* Includes and calls the [update-notifier][update-notifier] module by default.
* If passed -h or --help option, shows the help message.-v
* If passed or --version option, shows the package version.
[update-notifier]: https://github.com/yeoman/update-notifier#readme
Run code with DEBUG=simple-bin-help ...` environment variable
Author: Gleb Bahmutov © 2015
* @bahmutov
* glebbahmutov.com
* blog
* videos
* presentations
* cypress.tips
License: MIT - do anything with the code, but don't blame me if it does not work.
Spread the word: tweet, star on github, etc.
Support: if you find any problems with this module, email / tweet /
open issue on Github
Copyright (c) 2015 Gleb Bahmutov
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.
[simple-bin-help-icon]: https://nodei.co/npm/simple-bin-help.svg?downloads=true
[simple-bin-help-url]: https://npmjs.org/package/simple-bin-help
[simple-bin-help-ci-image]: https://github.com/bahmutov/simple-bin-help/actions/workflows/ci.yml/badge.svg?branch=master&event=push
[simple-bin-help-ci-url]: https://github.com/bahmutov/simple-bin-help/actions/workflows/ci.yml
[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-url]: https://github.com/semantic-release/semantic-release
[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg
[renovate-app]: https://renovateapp.com/