Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
67 lines
1.1 KiB
Plaintext
67 lines
1.1 KiB
Plaintext
help-me
|
|
=======
|
|
|
|
Help command for node, to use with [minimist](http://npm.im/minimist) and [commist](http://npm.im/commist).
|
|
|
|
Example
|
|
-------
|
|
|
|
```js
|
|
'use strict'
|
|
|
|
var helpMe = require('help-me')
|
|
var path = require('path')
|
|
var help = helpMe({
|
|
dir: path.join(__dirname, 'doc'),
|
|
// the default
|
|
ext: '.txt'
|
|
})
|
|
|
|
help
|
|
.createStream(['hello']) // can support also strings
|
|
.pipe(process.stdout)
|
|
|
|
// little helper to do the same
|
|
help.toStdout(['hello'])
|
|
```
|
|
|
|
Using ESM and top-level await::
|
|
|
|
```js
|
|
import { help } from 'help-me'
|
|
import { join } from 'desm'
|
|
|
|
await help({
|
|
dir: join(import.meta.url, 'doc'),
|
|
// the default
|
|
ext: '.txt'
|
|
}, ['hello'])
|
|
```
|
|
|
|
Usage with commist
|
|
------------------
|
|
|
|
[Commist](http://npm.im/commist) provide a command system for node.
|
|
|
|
```js
|
|
var commist = require('commist')()
|
|
var path = require('path')
|
|
var help = require('help-me')({
|
|
dir: path.join(__dirname, 'doc')
|
|
})
|
|
|
|
commist.register('help', help.toStdout)
|
|
|
|
commist.parse(process.argv.splice(2))
|
|
```
|
|
|
|
Acknowledgements
|
|
----------------
|
|
|
|
This project was kindly sponsored by [nearForm](http://nearform.com).
|
|
|
|
License
|
|
-------
|
|
|
|
MIT
|