feat: add mix completion spec (withfig#501)

* feat: add mix completion spec

* fix: remove unneccessary replace

* feat: reduce cache time and hide options by default

* fix: remove
Usage: mix [task]

Examples:

    mix             - Invokes the default task (mix run) in a project
    mix new PATH    - Creates a new Elixir project at the given path
    mix help        - Lists all available tasks
    mix help TASK   - Prints documentation for a given task

The --help and --version options can be given instead of a task for usage and versioning information. from suggestions

* chore: revert package-lock.json

* add generators

* revert unintended changes

Author: benvp

.all-contributorsrc

@@ -237,6 +237,15 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "benvp",
+      "name": "Benjamin von Polheim",
+      "avatar_url": "https://avatars.githubusercontent.com/u/981344?v=4",
+      "profile": "https://github.com/benvp",
+      "contributions": [
+        "code"
+      ]
     }
   ]
-}
+}

dev/mix.ts

@@ -47,12 +47,18 @@ const completionSpec: Fig.Spec = {
       ],
     },
     {
-      name: "pp",
+      name: "help",
       description:
         "Prints documentation for a given task (Lists all the tasks if no task is specified)",
       args: {
-        isOptional: true,
         name: "task",
+        isOptional: true,
+        description: "Prints documentation for a given task",
+        generators: {
+          cache: { ttl: 10000 },
+          script: "mix help",
+          postProcess: makeTaskSuggestions,
+        },
       },
       options: [
         {
@@ -70,6 +76,17 @@ const completionSpec: Fig.Spec = {
       ],
     },
   ],
+  args: {
+    name: "task",
+    description: "Invokes the task (mix run) in a project",
+    isOptional: true,
+    generators: {
+      cache: { ttl: 10000 },
+      script: "mix help",
+      postProcess: makeTaskSuggestions,
+    },
+  },
+
   options: [
     {
       name: ["-h", "--help"],
@@ -82,4 +99,18 @@ const completionSpec: Fig.Spec = {
   ],
 };
 
+function makeTaskSuggestions(out: string) {
+  return out
+    .split("\n")
+    .map((task) => {
+      const [name, description] = task.split("#").map((x) => x.trim());
+
+      return {
+        name: name.replace(/^mix /, ""),
+        description,
+      };
+    }) // filter out commands which do not make sense here
+    .filter((x) => !["mix", "help", "new", "iex -S mix"].includes(x.name));
+}
+
 export default completionSpec;