danielgtaylor / danielgtaylor/nesh

Access to `optimist` used to generate help documentation correctly

Open
#9 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
CoffeeScript
Stars
284
Forks
23
PR merge metrics
No merged PRs in 30d

Description

I've written a plugin for nesh and it takes a command line option (`-f` or `--fibrous`). I'd like to use `optimist.describe()` to document what the option does so that users who run:
`nesh --help`
will see it listed there, but since when I `require('optimist')` within my plugin, I don't get the same optimist object, so when I call `.describe()` on it, it doesn't have any effect.

If you could expose that as `nesh.optimist` or something, that would make it easy to add help documentation.

If you're open to it, I can write a patch and submit a pull request when I have time.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.