summaryrefslogtreecommitdiff
path: root/plugins/mix
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/mix')
-rw-r--r--plugins/mix/README.md19
-rw-r--r--plugins/mix/_mix8
2 files changed, 27 insertions, 0 deletions
diff --git a/plugins/mix/README.md b/plugins/mix/README.md
new file mode 100644
index 000000000..878f370f2
--- /dev/null
+++ b/plugins/mix/README.md
@@ -0,0 +1,19 @@
+# Mix plugin
+
+This plugin adds completions for the [Elixir's Mix build tool](https://hexdocs.pm/mix/Mix.html).
+
+To use it, add `mix` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... mix)
+```
+## Supported Task Types
+
+| Task Type | Documentation |
+|-------------------------|----------------------------------------------------------|
+| Elixir | [Elixir Lang](https://elixir-lang.org/) |
+| Phoenix v1.2.1 and below| [Phoenix](https://hexdocs.pm/phoenix/1.2.1/Phoenix.html) |
+| Phoenix v1.3.0 and above| [Phoenix](https://hexdocs.pm/phoenix/Phoenix.html) |
+| Ecto | [Ecto](https://hexdocs.pm/ecto/Ecto.html) |
+| Hex | [Hex](https://hex.pm/) |
+| Nerves | [Nerves](https://nerves-project.org/) |
diff --git a/plugins/mix/_mix b/plugins/mix/_mix
index ecbe7e2d3..61fa1cf25 100644
--- a/plugins/mix/_mix
+++ b/plugins/mix/_mix
@@ -31,6 +31,9 @@ _1st_arguments=(
'ecto.migrations:Displays the up / down migration status'
'ecto.rollback:Reverts applied migrations'
'escript.build:Builds an escript for the project'
+ 'firmware:Nerves - Build a firmware image for the selected target platform'
+ 'firmware.burn:Nerves - Writes the generated firmware image to an attached SDCard or file'
+ 'firmware.image:Nerves - Create a firmware image file that can be copied byte-for-byte'
'help:Print help information for tasks'
'hex:Print hex help information'
'hex.config:Read or update hex config'
@@ -48,6 +51,11 @@ _1st_arguments=(
'local.phoenix:Updates Phoenix locally'
'local.phx:Updates the Phoenix project generator locally'
'local.rebar:Install rebar locally'
+ 'nerves.artifact:Create an artifact for a specified Nerves package'
+ 'nerves.artifact.get:Nerves get artifacts'
+ 'nerves.info:Prints Nerves system information'
+ 'nerves.new:Create a new Nerves application'
+ 'nerves.release.init:Prepare a new Nerves project for use with releases'
'new:Create a new Elixir project'
'phoenix.digest:Digests and compress static files'
'phoenix.gen.channel:Generates a Phoenix channel'