Skip to content

Commit

Permalink
chore: add docs note about option.name version (#1301)
Browse files Browse the repository at this point in the history
Added a note about `options.name` reserved word `--version`, commanderjs doesn't work as expected with this specific flag
  • Loading branch information
Grohden authored Oct 24, 2020
1 parent 68a5e02 commit 12315f2
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,9 @@ For example, a `--reset-cache` option will result in a `resetCache: true` or `re

Just like with a [command name](#name), your option can require a value (e.g. `--port <port>`) or accept an optional one (e.g. `--host [host]`). In this case, you may find [`default`](#optionsdefault) value useful.

> Note: Almost all names are accepted, but **there's an exception** for `--version`, we consider it a reserved word and do not guarantee that it will
work as expected, so avoid using it. (see [this](https://github.com/react-native-community/cli/issues/1300) for further details)

##### `options.description`

Optional description of your option. When provided, will be used to output a better help information.
Expand Down

0 comments on commit 12315f2

Please sign in to comment.