2019-02-17 20:48:13 +01:00
|
|
|
# mvn plugin
|
2016-01-10 19:26:50 +01:00
|
|
|
|
2019-02-17 20:48:13 +01:00
|
|
|
The mvn plugin provides many [useful aliases](#aliases) as well as completion for
|
|
|
|
|
the [Apache Maven](https://maven.apache.org/) command (`mvn`).
|
2016-01-10 19:26:50 +01:00
|
|
|
|
2016-05-12 13:41:29 +02:00
|
|
|
Enable it by adding `mvn` to the plugins array in your zshrc file:
|
2020-03-11 19:57:46 +01:00
|
|
|
|
2016-05-12 13:41:29 +02:00
|
|
|
```zsh
|
|
|
|
|
plugins=(... mvn)
|
|
|
|
|
```
|
2016-01-10 19:26:50 +01:00
|
|
|
|
|
|
|
|
## Aliases
|
|
|
|
|
|
2019-02-17 20:48:13 +01:00
|
|
|
The plugin aliases mvn to a function that calls `mvnw` (the [Maven Wrapper](https://github.com/takari/maven-wrapper))
|
2019-02-17 18:50:46 +01:00
|
|
|
if it's found, or the mvn command otherwise.
|
|
|
|
|
|
2016-05-12 13:41:29 +02:00
|
|
|
| Alias | Command |
|
|
|
|
|
|:---------------------|:------------------------------------------------|
|
2019-02-17 18:50:46 +01:00
|
|
|
| `mvn!` | `mvn -f <root>/pom.xml` |
|
|
|
|
|
| `mvnag` | `mvn archetype:generate` |
|
|
|
|
|
| `mvnboot` | `mvn spring-boot:run` |
|
2020-10-09 17:42:44 +02:00
|
|
|
| `mvnqdev` | `mvn quarkus:dev` |
|
2019-02-17 18:50:46 +01:00
|
|
|
| `mvnc` | `mvn clean` |
|
|
|
|
|
| `mvncd` | `mvn clean deploy` |
|
|
|
|
|
| `mvnce` | `mvn clean eclipse:clean eclipse:eclipse` |
|
2016-05-12 13:41:29 +02:00
|
|
|
| `mvnci` | `mvn clean install` |
|
2019-02-17 18:50:46 +01:00
|
|
|
| `mvncie` | `mvn clean install eclipse:eclipse` |
|
|
|
|
|
| `mvncini` | `mvn clean initialize` |
|
2016-05-12 13:41:29 +02:00
|
|
|
| `mvncist` | `mvn clean install -DskipTests` |
|
2016-06-15 05:42:48 +02:00
|
|
|
| `mvncisto` | `mvn clean install -DskipTests --offline` |
|
2016-05-12 13:41:29 +02:00
|
|
|
| `mvncom` | `mvn compile` |
|
2019-02-17 18:50:46 +01:00
|
|
|
| `mvncp` | `mvn clean package` |
|
2016-05-12 13:41:29 +02:00
|
|
|
| `mvnct` | `mvn clean test` |
|
2019-02-17 18:50:46 +01:00
|
|
|
| `mvncv` | `mvn clean verify` |
|
|
|
|
|
| `mvncvst` | `mvn clean verify -DskipTests` |
|
2023-06-16 09:52:12 +02:00
|
|
|
| `mvndp` | `mvn deploy` |
|
2019-02-17 18:50:46 +01:00
|
|
|
| `mvndocs` | `mvn dependency:resolve -Dclassifier=javadoc` |
|
2016-05-12 13:41:29 +02:00
|
|
|
| `mvndt` | `mvn dependency:tree` |
|
2019-02-17 18:50:46 +01:00
|
|
|
| `mvne` | `mvn eclipse:eclipse` |
|
2020-06-26 03:47:30 +02:00
|
|
|
| `mvnfmt` | `mvn fmt:format` |
|
2019-02-17 18:50:46 +01:00
|
|
|
| `mvnjetty` | `mvn jetty:run` |
|
|
|
|
|
| `mvnp` | `mvn package` |
|
2016-05-12 13:41:29 +02:00
|
|
|
| `mvns` | `mvn site` |
|
|
|
|
|
| `mvnsrc` | `mvn dependency:sources` |
|
2019-02-17 18:50:46 +01:00
|
|
|
| `mvnt` | `mvn test` |
|
|
|
|
|
| `mvntc` | `mvn tomcat:run` |
|
|
|
|
|
| `mvntc7` | `mvn tomcat7:run` |
|
|
|
|
|
| `mvn-updates` | `mvn versions:display-dependency-updates` |
|
|
|
|
|
|
|
|
|
|
## mvn-color
|
|
|
|
|
|
2019-02-17 20:48:13 +01:00
|
|
|
It's a function that wraps the mvn command to colorize it's output. You can use it in place
|
|
|
|
|
of the `mvn` command. For example: instead of `mvn test`, use `mvn-color test`.
|
2019-02-17 18:50:46 +01:00
|
|
|
|
2019-02-17 20:48:13 +01:00
|
|
|
Since [Maven 3.5.0](https://maven.apache.org/docs/3.5.0/release-notes.html) the mvn command
|
|
|
|
|
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
|
2019-11-21 02:26:18 +01:00
|
|
|
`archetype:generate`. See [#5052](https://github.com/ohmyzsh/ohmyzsh/issues/5052).
|
