Add description to command registry (fixes jline#1119)

gnodet · Dec 7, 2024 · 20b3ecf · 20b3ecf
1 parent 9fb7e27
commit 20b3ecf
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 4 deletions.
diff --git a/console/src/main/java/org/jline/console/CommandRegistry.java b/console/src/main/java/org/jline/console/CommandRegistry.java
@@ -11,6 +11,7 @@
 import java.io.InputStream;
 import java.io.PrintStream;
 import java.util.*;
+import java.util.stream.Stream;
 
 import org.jline.reader.impl.completer.SystemCompleter;
 import org.jline.terminal.Terminal;
@@ -42,10 +43,17 @@ static SystemCompleter aggregateCompleters(CommandRegistry... commandRegistries)
      */
     static SystemCompleter compileCompleters(CommandRegistry... commandRegistries) {
         SystemCompleter out = aggregateCompleters(commandRegistries);
-        out.compile();
+        out.compile(s -> getDescription(commandRegistries, s));
         return out;
     }
 
+    static String getDescription(CommandRegistry[] commandRegistries, String s) {
+        return Stream.of(commandRegistries)
+                .flatMap(r -> r.hasCommand(s) ? r.commandInfo(s).stream() : Stream.empty())
+                .findFirst()
+                .orElse(null);
+    }
+
     /**
      * Returns the name of this registry.
      * @return the name of the registry

diff --git a/console/src/main/java/org/jline/console/impl/SystemRegistryImpl.java b/console/src/main/java/org/jline/console/impl/SystemRegistryImpl.java
@@ -306,7 +306,7 @@ private SystemCompleter _compileCompleters() {
         }
         local.add(customSystemCompleter);
         out.add(local);
-        out.compile();
+        out.compile(s -> CommandRegistry.getDescription(commandRegistries, s));
         return out;
     }
 

diff --git a/reader/src/main/java/org/jline/reader/impl/completer/SystemCompleter.java b/reader/src/main/java/org/jline/reader/impl/completer/SystemCompleter.java
@@ -9,6 +9,8 @@
 package org.jline.reader.impl.completer;
 
 import java.util.*;
+import java.util.function.Function;
+import java.util.stream.Collectors;
 
 import org.jline.reader.Candidate;
 import org.jline.reader.Completer;
@@ -24,6 +26,7 @@
 public class SystemCompleter implements Completer {
     private Map<String, List<Completer>> completers = new HashMap<>();
     private Map<String, String> aliasCommand = new HashMap<>();
+    private Map<String, String> descriptions = new HashMap<>();
     private StringsCompleter commands;
     private boolean compiled = false;
 
@@ -123,7 +126,7 @@ private Map<String, String> getAliases() {
         return aliasCommand;
     }
 
-    public void compile() {
+    public void compile(Function<String, String> descriptionProvider) {
         if (compiled) {
             return;
         }
@@ -139,7 +142,9 @@ public void compile() {
         completers = compiledCompleters;
         Set<String> cmds = new HashSet<>(completers.keySet());
         cmds.addAll(aliasCommand.keySet());
-        commands = new StringsCompleter(cmds);
+        commands = new StringsCompleter(cmds.stream()
+                .map(s -> new Candidate(s, s, null, descriptionProvider.apply(s), null, null, true, 0))
+                .collect(Collectors.toList()));
         compiled = true;
     }