https://github.com/mukel/mx-honey

:honey_pot: sweet (zsh) completions for mx
https://github.com/mukel/mx-honey

graal graalvm mx plugin zsh

Last synced: 10 days ago
JSON representation

:honey_pot: sweet (zsh) completions for mx

• Host: GitHub
• URL: https://github.com/mukel/mx-honey
• Owner: mukel
• License: apache-2.0
• Created: 2018-05-08T15:32:09.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-03-03T16:03:43.000Z (over 4 years ago)
• Last Synced: 2024-10-11T18:14:51.544Z (26 days ago)
• Topics: graal, graalvm, mx, plugin, zsh
• Language: Shell
• Homepage: https://github.com/graalvm/mx
• Size: 44.9 KB
• Stars: 9
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



# mx plugin

Provides handy completions for [mx](https://github.com/graalvm/mx) as well as some aliases for common `mx` commands.  

`mx` is (more than just) the build tool used by the [GraalVM project](https://github.com/oracle/graal).

# Install

```zsh

git clone --depth 1 https://github.com/mukel/mx-honey.git ${ZSH_CUSTOM:=$HOME/.oh-my-zsh/custom}/plugins/mx

```

To use it, add `mx` to the plugins in your `~/.zshrc` file:

```zsh

plugins(... mx)

```

## Aliases

| Alias | Command                                   | Description                                                 |

|-------|-------------------------------------------|-------------------------------------------------------------|

| mxb   | `mx build`                                | Build the artifacts of one or more dependencies.            |

| mxbe  | `mx benchmark`                            | Run a benchmark suite.                                      |

| mxcl  | `mx clean`                                | Remove all .class files, images, and executables.           |

| mxcs  | `mx checkstyle`                           | Run Checkstyle on the Java sources.                         |

| mxf   | `mx eclipseformat`                        | Run the Eclipse Code Formatter on the Java sources.         |

| mxu   | `mx unittest`                             | Run JUnit tests.                                            |

| mxdu  | `mx -d unittest`                          | Run JUnit tests in debug mode.                              |

| mxupd | `mx update`                               | Update `mx` to the latest version.                          |

# Features 

  - [X] [mx aliases](./mx.plugin.zsh)

  - [X] mx global-options

  - [X] Common sub-command completion

  - [X] `mx benchmark` completion with support for dynamic imports (--dy)