linux/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-19 21:41:07 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

mvn: update documentation

Browse source
This commit is contained in:
Marc Cornellà 2019-02-17 20:48:13 +01:00
parent f4b2e460c7
commit 0e647904ff
1 changed files with 13 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
plugins/mvn/README.md
View file

@ -1,7 +1,7 @@
## Introduction # mvn plugin
The [mvn plugin](https://github.com/robbyrussell/oh-my-zsh/tree/master/plugins/mvn) provides many The mvn plugin provides many [useful aliases](#aliases) as well as completion for
[useful aliases](#aliases) as well as completion for the `mvn` command. the [Apache Maven](https://maven.apache.org/) command (`mvn`).
Enable it by adding `mvn` to the plugins array in your zshrc file: Enable it by adding `mvn` to the plugins array in your zshrc file:
```zsh ```zsh
@ -10,7 +10,7 @@ plugins=(... mvn)
## Aliases ## Aliases
The plugin aliases mvn to a either calls `mvnw` ([Maven Wrapper](https://github.com/takari/maven-wrapper)) The plugin aliases mvn to a function that calls `mvnw` (the [Maven Wrapper](https://github.com/takari/maven-wrapper))
if it's found, or the mvn command otherwise. if it's found, or the mvn command otherwise.
| Alias | Command | | Alias | Command |
@ -46,9 +46,13 @@ if it's found, or the mvn command otherwise.
## mvn-color ## mvn-color
It's a function that wraps the mvn command to colorize it's output. Since Maven 3.5.0 It's a function that wraps the mvn command to colorize it's output. You can use it in place
the mvn command adds colored output, so this function will be soon removed from the of the `mvn` command. For example: instead of `mvn test`, use `mvn-color test`.
plugin.
It also has a bug where it won't print when mvn prompts for user input, _e.g._ when Since [Maven 3.5.0](https://maven.apache.org/docs/3.5.0/release-notes.html) the mvn command
using `archetype:generate`. See [#5052](https://github.com/robbyrussell/oh-my-zsh/issues/5052). has colored output, so this function will be soon removed from the plugin.
### Known bugs
It has a bug where it will swallow mvn prompts for user input, _e.g._ when using
`archetype:generate`. See [#5052](https://github.com/robbyrussell/oh-my-zsh/issues/5052).