https://github.com/diversen/minimist-mini
Mini minimist with auto generation of help using README.md (converted to text) as help - and simple parsing of option given to the CLI program
https://github.com/diversen/minimist-mini
Last synced: over 1 year ago
JSON representation
Mini minimist with auto generation of help using README.md (converted to text) as help - and simple parsing of option given to the CLI program
- Host: GitHub
- URL: https://github.com/diversen/minimist-mini
- Owner: diversen
- Created: 2016-12-03T14:58:24.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-02-07T21:15:24.000Z (over 2 years ago)
- Last Synced: 2025-03-09T08:05:25.097Z (over 1 year ago)
- Language: JavaScript
- Size: 21.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# minimist-mini
A wrapper around minimist that has some more logical methods for getting options and arguments.
It can also automatically generate documentation from
a module's `README.md` or `readme.md` file. It reads the .md file and parses it for display in
your console application.
## Install:
npm install --save minimist-mini
## Usage:
```.js
// Options are exactly as in minimist
const opts = [];
opts.boolean = ['help'];
opts.string = ['option1'];
opts.string = ['option2'];
opts.default = { option1: 'default value' };
opts.alias = { h: 'help' };
const minimistMini = require('minimist-mini')(opts);
// Check if help is defined, and log the value.
var help = minimistMini.getOption('h');
if (help){
// Default help is generated from README.md or readme.md
// Or you may specify a file in from your package
console.log(minimistMini.helpMessage())
process.exit(0);
}
// Get single option
console.log("value of option 'option1':");
console.log(minimistMini.getOption('option1'));
// Get all options
console.log("all options:");
console.log(minimistMini.getOptions());
// Get single argument
console.log("value of argument 0:");
console.log(minimistMini.getArgument(0));
// Get all arguments
console.log("all arguments:");
console.log(minimistMini.getArguments());
```
## License:
MIT © [Dennis Iversen](https://github.com/diversen)