Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/artemy/zsh-mvn-contexts

zsh plugin for quickly switching between maven configuration files
https://github.com/artemy/zsh-mvn-contexts

maven mvn plugin settings zsh zsh-plugin

Last synced: 16 days ago
JSON representation

zsh plugin for quickly switching between maven configuration files

Awesome Lists containing this project

README

        

# zsh-mvn-contexts

zsh-mvn-contexts is a zsh plugin for fast switching between your maven configurations

## Installation

### I'm using Antigen

1. Add the following to your .zshrc:

```bash
antigen bundle artemy/zsh-mvn-contexts
```

2. Restart zsh.

### I'm using oh-my-zsh

1. Clone this repository into oh-my-zsh's plugin directory:

```bash
git clone [email protected]:artemy/zsh-mvn-contexts.git ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/_mvnctx
```

2. Enable the plugin in `~/.zshrc`:

```bash
plugins=( [other plugins...] _mvnctx)
```

(mind the underscore)
3. Restart zsh.

## Prerequisites

1. Create `~/.m2/contexts` directory
2. Save your custom maven settings as `~/.m2/contexts/.xml`
3. (Optional) save your custom maven security file as `~/.m2/contexts/-security.xml`

## How it works

Plugin will symlink one of the specified "context" files from your `~/.m2/contexts` directory into `~/.m2` directory together with respective security file (if exists).

## Usage

```bash
mvnctx
```

Plugin is also aware of existing configurations so it supports autocompletion.

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## Notes

Thanks to [Robin Trietsch](https://github.com/trietsch) for the idea and contributions.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.