stow/oh-my-zsh/.oh-my-zsh/plugins/mvn/README.md

   1 # mvn plugin
   2
   3 The mvn plugin provides many [useful aliases](#aliases) as well as completion for
   4 the [Apache Maven](https://maven.apache.org/) command (`mvn`).
   5
   6 Enable it by adding `mvn` to the plugins array in your zshrc file:
   7
   8 ```zsh
   9 plugins=(... mvn)
  10 ```
  11
  12 ## Aliases
  13
  14 The plugin aliases mvn to a function that calls `mvnw` (the [Maven Wrapper](https://github.com/takari/maven-wrapper))
  15 if it's found, or the mvn command otherwise.
  16
  17 | Alias                | Command                                         |
  18 |:---------------------|:------------------------------------------------|
  19 | `mvn!`               | `mvn -f <root>/pom.xml`                         |
  20 | `mvnag`              | `mvn archetype:generate`                        |
  21 | `mvnboot`            | `mvn spring-boot:run`                           |
  22 | `mvnqdev`            | `mvn quarkus:dev`                               |
  23 | `mvnc`               | `mvn clean`                                     |
  24 | `mvncd`              | `mvn clean deploy`                              |
  25 | `mvnce`              | `mvn clean eclipse:clean eclipse:eclipse`       |
  26 | `mvnci`              | `mvn clean install`                             |
  27 | `mvncie`             | `mvn clean install eclipse:eclipse`             |
  28 | `mvncini`            | `mvn clean initialize`                          |
  29 | `mvncist`            | `mvn clean install -DskipTests`                 |
  30 | `mvncisto`           | `mvn clean install -DskipTests --offline`       |
  31 | `mvncom`             | `mvn compile`                                   |
  32 | `mvncp`              | `mvn clean package`                             |
  33 | `mvnct`              | `mvn clean test`                                |
  34 | `mvncv`              | `mvn clean verify`                              |
  35 | `mvncvst`            | `mvn clean verify -DskipTests`                  |
  36 | `mvnd`               | `mvn deploy`                                    |
  37 | `mvndocs`            | `mvn dependency:resolve -Dclassifier=javadoc`   |
  38 | `mvndt`              | `mvn dependency:tree`                           |
  39 | `mvne`               | `mvn eclipse:eclipse`                           |
  40 | `mvnfmt`             | `mvn fmt:format`                                |
  41 | `mvnjetty`           | `mvn jetty:run`                                 |
  42 | `mvnp`               | `mvn package`                                   |
  43 | `mvns`               | `mvn site`                                      |
  44 | `mvnsrc`             | `mvn dependency:sources`                        |
  45 | `mvnt`               | `mvn test`                                      |
  46 | `mvntc`              | `mvn tomcat:run`                                |
  47 | `mvntc7`             | `mvn tomcat7:run`                               |
  48 | `mvn-updates`        | `mvn versions:display-dependency-updates`       |
  49
  50 ## mvn-color
  51
  52 It's a function that wraps the mvn command to colorize it's output. You can use it in place
  53 of the `mvn` command. For example: instead of `mvn test`, use `mvn-color test`.
  54
  55 Since [Maven 3.5.0](https://maven.apache.org/docs/3.5.0/release-notes.html) the mvn command
  56 has colored output, so this function will be soon removed from the plugin.
  57
  58 ### Known bugs
  59
  60 It has a bug where it will swallow mvn prompts for user input, _e.g._ when using
  61 `archetype:generate`. See [#5052](https://github.com/ohmyzsh/ohmyzsh/issues/5052).