mirror of
https://github.com/JasonYANG170/IOTConnect-Web.git
synced 2024-11-23 20:26:28 +00:00
67 lines
1.1 KiB
Markdown
67 lines
1.1 KiB
Markdown
|
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
|