Skip to content

Commit

Permalink
chore: make it clear that invoke can pass options
Browse files Browse the repository at this point in the history
  • Loading branch information
yyx990803 committed Jan 30, 2018
1 parent b626ef1 commit 0ce0055
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,14 @@ yarn add @vue/cli-plugin-eslint
Then you can invoke the plugin's generator so it generates files into your project:

``` sh
vue invoke eslint # the prefix can be omitted
# the @vue/cli-plugin- prefix can be omitted
vue invoke eslint
```

In addition, you can pass options to the plugin:

``` sh
vue invoke eslint --config airbnb --lintOn save
```

It is recommended to commit your project's current state before running `vue invoke`, so that after file generation you can review the changes and revert if needed.
Expand Down
2 changes: 1 addition & 1 deletion packages/@vue/cli/bin/vue.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ program
})

program
.command('invoke <plugin>')
.command('invoke <plugin> [pluginOptions]')
.allowUnknownOption()
.description('invoke the generator of a plugin in an already created project')
.action((plugin) => {
Expand Down

0 comments on commit 0ce0055

Please sign in to comment.