Skip to content

Commit

Permalink
Update thirdparty plugin section with shell completions (#1964)
Browse files Browse the repository at this point in the history
Pull request: #1964
  • Loading branch information
lefou committed Jul 20, 2022
1 parent 19653ac commit 25274e4
Showing 1 changed file with 30 additions and 2 deletions.
32 changes: 30 additions & 2 deletions docs/antora/modules/ROOT/pages/Thirdparty_Plugins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@

The Plugins in this section are developed/maintained outside the mill git tree.
This list is most likely not complete.
If you're missing an external plugin or developed one which is not listed here, please open a https://github.com/com-lihaoyi/mill/pulls[pull request] and add that plugin with a short description.
If you wrote a Mill plugin or find that one is missing in this list, please open a {mill-github-url}/pulls[pull request] and add that plugin with a short description (in alphabetical order).

For details about including plugins in your `build.sc` read xref:Extending_Mill.adoc#_using_mill_plugins_import_ivy[Using Mill Plugins].

CAUTION: Besides the documentation provided here, we urge you to consult the respective linked plugin documentation pages.
The usage examples given here are most probably incomplete and sometimes outdated!

Additional to this list, you can also search the https://github.com/topics/mill-plugin[`mill-plugin` topic on GitHub] for more plugins.


== Antlr

Expand Down Expand Up @@ -69,6 +71,7 @@ Limited bash completion support.

Project home: https://github.com/lefou/mill-bash-completion


== DGraph

Show transitive dependencies of your build in your browser.
Expand Down Expand Up @@ -162,6 +165,14 @@ Found unimported dependencies: (remove these from ivyDeps)
main.checkExplicitDeps Found 1 undeclared dependencies, 1 unimported dependencies
----

== Fish Completion

Limited fish completion support.

Project home: https://github.com/ckipp01/mill-fish-completions



== Git

A git version plugin for mill.
Expand Down Expand Up @@ -456,7 +467,7 @@ Scala MDoc simply compiles properly marked Scala snippets in plain md files and

Project home: https://github.com/atooni/mill-mdoc

== Mill Wrapper Scripts
== `millw` / `millw.bat` - Mill Wrapper Scripts

Small script to automatically fetch and execute mill build tool.

Expand Down Expand Up @@ -682,6 +693,14 @@ object project extends ScalaModule with ScalafixModule {
project.fix A Scalafix linter error was reported
----

== Shell Completions

As Mill is a tool often used from the CLI (Command line interface), you may be also interested in installing some completion support for your preferred shell:

* <<_bash_completion>>
* <<_fish_completion>>
* <<_zsh_completion>>

== VCS Version

Mill plugin to derive a version from (last) git tag and edit state. It may support other VCS as well.
Expand All @@ -706,3 +725,12 @@ object main extends JavaModule with PublishModule {
override def publishVersion: T[String] = VcsVersion.vcsState().format()
}
----

== Zsh Completion

Limited zsh completion support.

This script is part of a collection of configuration files and comes without documentation, but might be useful nonetheless, if you are a zsh user.


Project home: https://github.com/carlosedp/dotfiles/blob/master/completion/_mill

0 comments on commit 25274e4

Please sign in to comment.