https://github.com/carlosedp/mill-zsh-completions

Zsh plugin adding Scala Mill build tool completions and prompt display
https://github.com/carlosedp/mill-zsh-completions

mill p10k scala zsh

Last synced: 11 days ago
JSON representation

Zsh plugin adding Scala Mill build tool completions and prompt display

• Host: GitHub
• URL: https://github.com/carlosedp/mill-zsh-completions
• Owner: carlosedp
• License: mit
• Created: 2023-10-05T13:31:36.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-14T12:26:45.000Z (11 months ago)
• Last Synced: 2024-04-16T16:22:36.365Z (7 months ago)
• Topics: mill, p10k, scala, zsh
• Language: Shell
• Homepage:
• Size: 81.1 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Scala Mill Build Tool Completion script for ZSH

This plugin adds Scala [Mill build tool](http://mill-build.com/mill/Intro_to_Mill.html) completion capabilities to zsh shell.

It can be used as `./mill ` that lists all modules, root level tasks and flags or

`./mill mymodule.` showing tasks for specific module. It works with deeper tasks as well like `./mill mymodule.test `.

The dots between modules and tasks are smartly added. The mill build data is cached for faster execution after the initial run. The cache is invalidated if `build.sc` or `build.mill` is changed. For aliases, check my  plugin.

[![asciicast](https://asciinema.org/a/AxkSqsYvz0god8sZWzfD4Dmva.svg)](https://asciinema.org/a/AxkSqsYvz0god8sZWzfD4Dmva)

It also adds to [P10K](https://github.com/romkatv/powerlevel10k) Zsh theme the current Mill version for the project dir and if there are updates to Mill.

![prompt sample](./img/prompt-sample.png)

There is also a convenience function `millupd` to allow updating the current project Mill version. It updates `.mill-version` with latest stable version or if called with `-s` argument it updates to latest snapshot version.

## Installation

### For Oh-My-Zsh

```sh

cd "$HOME/.oh-my-zsh/custom/plugins" && git clone https://github.com/carlosedp/mill-zsh-completions.git

```

Add mill-zsh-completions to plugins array in ~/.zshrc

```txt

plugins=(

    aliases

    autojump

    mill-zsh-completions

    ...

```

### For Zinit

    ~/.zshrc

source "$HOME/.zinit/bin/zinit.zsh"

zinit ice lucid nocompile

zinit load carlosedp/mill-zsh-completions

### Installing without a framework

```sh

git clone https://github.com/carlosedp/mill-zsh-completions.git

```

And source mill-zsh-completions.plugin.zsh or add code to zshrc or any startup script

## Using P10k theme prompt element

To use the P10K prompt element, add `mill_version` to the `p10k.zsh` file as in:

```shell

  #       typeset -g POWERLEVEL9K_RIGHT_PROMPT_ELEMENTS=(

  #       status # already exists

  #       ...

  #       mill_version

  #       ...

```