picocli fish completion

remkop · Jan 16, 2023 · 1af8274 · 1af8274
1 parent 9c4e8a2
commit 1af8274
Show file tree

Hide file tree

Showing 2 changed files with 93 additions and 33 deletions.
diff --git a/src/main/java/picocli/AutoComplete.java b/src/main/java/picocli/AutoComplete.java
@@ -305,17 +305,6 @@ private static class CommandDescriptor {
             this.commandName = commandName;
             this.commandLine = commandLine;
         }
-
-        @Override
-        public String toString() {
-            return "CommandDescriptor{" +
-                    "functionName='" + functionName + '\'' +
-                    ", parentFunctionName='" + parentFunctionName + '\'' +
-                    ", parentWithoutTopLevelCommand='" + parentWithoutTopLevelCommand + '\'' +
-                    ", commandName='" + commandName + '\'' +
-                    ", commandLine=" + commandLine +
-                    '}';
-        }
     }
 
     private static final String SCRIPT_HEADER = "" +
@@ -551,18 +540,105 @@ public static String fish(String scriptName, CommandLine commandLine) {
         if (commandLine == null) { throw new NullPointerException("commandLine"); }
         List<CommandDescriptor> hierarchy = createHierarchy(scriptName, commandLine);
         //print hierarchy
+        StringBuilder result = new StringBuilder();
+        //result.append("complete --command ").append(scriptName).append(" --no-files").append("\n");
+
+        String parentFunction = "";
+        List<CommandDescriptor> currentLevel = new ArrayList<CommandDescriptor>();
+        List<String> currentLevelCommands = new ArrayList<String>();
+
+        CommandDescriptor rootDescriptor = null;
         for (CommandDescriptor descriptor : hierarchy) {
-            System.out.println(descriptor.functionName + " " + descriptor.commandName);
-        }
+            if (descriptor.parentFunctionName.equals("")) {
+                rootDescriptor = descriptor;
+                continue;
+            }
+            if (!descriptor.parentFunctionName.equals(parentFunction)) {
+                if (!currentLevelCommands.isEmpty()) {
+                    processLevel(scriptName, result, currentLevel, currentLevelCommands, parentFunction, rootDescriptor);
+                    rootDescriptor = null;
 
-        StringBuilder result = new StringBuilder();
-        result.append("Hello from fish!").append("\n");
-        for (CommandDescriptor commandDescriptor : hierarchy) {
-            result.append(commandDescriptor.toString()).append("\n");
+                    currentLevel.clear();
+                    currentLevelCommands.clear();
+                }
+                parentFunction = descriptor.parentFunctionName;
+            }
+
+            currentLevel.add(descriptor);
+            currentLevelCommands.add(descriptor.commandName);
         }
+        if (!currentLevelCommands.isEmpty()) {
+            processLevel(scriptName, result, currentLevel, currentLevelCommands, parentFunction, rootDescriptor);
+        }
+
+
         return result.toString();
     }
 
+    private static void processLevel(String scriptName, StringBuilder result, List<CommandDescriptor> currentLevel,
+                                     List<String> currentLevelCommands, String levelName,
+                                     CommandDescriptor rootDescriptor) {
+        result.append("\n# ").append(levelName).append(" completion \n");
+        result.append("set -l ").append(levelName).append(" ").append(String.join(" ", currentLevelCommands)).append(
+                "\n");
+        if (rootDescriptor != null) {
+            for (OptionSpec optionSpec : rootDescriptor.commandLine.getCommandSpec().options()) {
+                result.append("complete -c ").append(scriptName);
+                result.append(" -n \"not __fish_seen_subcommand_from $").append(levelName).append("\"");
+                result.append(" -l ").append(optionSpec.longestName().replace("--", ""));
+                String optionDescription =  sanitizeDescription(optionSpec.description().length > 0 ? optionSpec.description()[0] : "");
+                result.append(" -d '").append(optionDescription).append("'\n");
+
+                if (!optionSpec.shortestName().equals(optionSpec.longestName())) {
+                    result.append("complete -c ").append(scriptName);
+                    result.append(" -n \"not __fish_seen_subcommand_from $").append(levelName).append("\"");
+                    result.append(" -s ").append(optionSpec.shortestName().replace("-", ""));
+                    result.append(" -d '").append(optionDescription).append("'\n");
+                }
+            }
+        }
+        for (CommandDescriptor commandDescriptor : currentLevel) {
+            String[] descriptions = commandDescriptor.commandLine.getCommandSpec().usageMessage().description();
+            String description = descriptions.length > 0 ? descriptions[0] : "";
+            result.append("complete -c ").append(scriptName);
+            result.append(" -f"); // do not show files
+            result.append(" -n \"not __fish_seen_subcommand_from $").append(levelName).append("\"");
+            if (!commandDescriptor.parentWithoutTopLevelCommand.equals("")) {
+                result.append(" -n '__fish_seen_subcommand_from ").append(
+                        commandDescriptor.parentWithoutTopLevelCommand).append("'");
+            }
+            result.append(" -a ").append(commandDescriptor.commandName).append(" -d '").append(description).append("'\n");
+
+            for (OptionSpec optionSpec : commandDescriptor.commandLine.getCommandSpec().options()) {
+                result.append("complete -c ").append(scriptName);
+                result.append(" -n \"__fish_seen_subcommand_from ").append(commandDescriptor.commandName).append("\"");
+                if (!commandDescriptor.parentWithoutTopLevelCommand.equals("")) {
+                    result.append(" -n '__fish_seen_subcommand_from ").append(
+                            commandDescriptor.parentWithoutTopLevelCommand).append("'");
+                }
+                result.append(" -l ").append(optionSpec.longestName().replace("--", ""));
+                String optionDescription =  sanitizeDescription(optionSpec.description().length > 0 ? optionSpec.description()[0] : "");
+                result.append(" -d '").append(optionDescription).append("'\n");
+
+                if (!optionSpec.shortestName().equals(optionSpec.longestName())) {
+                    result.append("complete -c ").append(scriptName);
+                    result.append(" -n \"__fish_seen_subcommand_from ").append(commandDescriptor.commandName).append("\"");
+                    if (!commandDescriptor.parentWithoutTopLevelCommand.equals("")) {
+                        result.append(" -n '__fish_seen_subcommand_from ").append(
+                                commandDescriptor.parentWithoutTopLevelCommand).append("'");
+                    }
+                    result.append(" -s ").append(optionSpec.shortestName().replace("-", ""));
+                    result.append(" -d '").append(optionDescription).append("'\n");
+                }
+            }
+        }
+
+    }
+
+    private static String sanitizeDescription(String description) {
+        return description.replace("'", "\\'");
+    }
+
     private static List<CommandDescriptor> createHierarchy(String scriptName, CommandLine commandLine) {
         List<CommandDescriptor> result = new ArrayList<CommandDescriptor>();
         result.add(new CommandDescriptor("_picocli_" + scriptName, "", "", scriptName, commandLine));

diff --git a/src/test/java/picocli/AutoCompleteTest.java b/src/test/java/picocli/AutoCompleteTest.java
@@ -2117,20 +2117,4 @@ public void testIssue1388_AliasesCommand() throws FileNotFoundException {
             existingScript.delete();
         }
     }
-
-    @Test
-    public void testFish() {
-        String expected = String.format("hello from fish%n");
-
-        assertEquals(
-                expected,
-                AutoComplete.fish("myapp", new CommandLine(new Issue1352CommandWithResourceBundle()))
-        );
-
-        assertEquals(
-                expected,
-                AutoComplete.fish("myapp", new CommandLine(new Issue1352ParentCommand()))
-        );
-
-    }
 }