Make the `set` unknown command message better (#3089)

pwndbg/dbg/lldb/pset.py

@@ -4,7 +4,6 @@ from typing import Any
 from typing import Optional
 
 import pwndbg
-import pwndbg.color.message as message
 import pwndbg.commands
 import pwndbg.lib.config as cfg
 
@@ -16,20 +15,13 @@ def pget(name: str) -> Optional[pwndbg.lib.config.Parameter]:
     return pwndbg.config.params.get(name.replace("-", "_"))
 
 
-def pset(name: str, value: str) -> bool:
+def pset(param: pwndbg.lib.config.Parameter, value: str):
     """
     Parses and sets a Pwndbg configuration value.
-    """
-    param = pget(name)
-    if param is None:
-        print(message.error(f"Unknown setting '{name}'"))
-        return False
 
-    try:
+    Raises `InvalidParse` if the value is not valid.
-        new_value = parse_value(param, value)
+    """
-    except InvalidParse as e:
+    new_value = parse_value(param, value)
-        print(message.error(f"Invalid value '{value}' for setting '{name}': {e}"))
-        return False
 
     param.value = new_value
     for trigger in pwndbg.config.triggers[param.name]:

pwndbg/dbg/lldb/repl/__init__.py

@@ -63,6 +63,7 @@ from pwndbg.dbg import EventType
 from pwndbg.dbg.lldb import LLDB
 from pwndbg.dbg.lldb import LLDBProcess
 from pwndbg.dbg.lldb import OneShotAwaitable
+from pwndbg.dbg.lldb.pset import InvalidParse
 from pwndbg.dbg.lldb.pset import pget
 from pwndbg.dbg.lldb.pset import pset
 from pwndbg.dbg.lldb.repl.io import IODriver
@@ -265,6 +266,13 @@ def print_warn(msg: str, *args):
     print(message.warn("warn:"), msg, *args)
 
 
+def print_hint(msg: str, *args):
+    """
+    Print a hint message in the style of the LLDB CLI.
+    """
+    print(message.hint("hint:"), msg, *args)
+
+
 @wrap_with_history
 def run(
     controller: Callable[[PwndbgController], Coroutine[Any, Any, None]], debug: bool = False
@@ -529,11 +537,26 @@ def exec_repl_command(
             print("Usage: set <name> <value>")
             warn = True
         else:
-            warn = not pset(bits[1], bits[2])
+            param = pget(bits[1])
+            if param is None:
+                print_error(f"unknown setting '{bits[1]}'")
+                warn = True
+            else:
+                try:
+                    pset(param, bits[2])
+                except InvalidParse as e:
+                    print_error(f"invalid value '{bits[2]}' for setting '{bits[1]}': {e}")
+                    warn = True
 
         if warn:
-            print_warn(
+            print_hint(
-                "The 'set' command is used exclusively for Pwndbg settings. If you meant to change LLDB settings, use the fully spelled-out 'settings' command, instead."
+                "Use the 'config', 'theme' and 'help set' commands to see what settings are available."
+            )
+            print_hint(
+                "Use the 'help set <name>' command to see information about a specific setting."
+            )
+            print_hint(
+                "If you meant to change LLDB settings, use the fully spelled-out 'settings' command, instead."
             )
 
         return True
@@ -559,13 +582,12 @@ def exec_repl_command(
             for scope in pwndbg.lib.config.Scope:
                 print()
                 print(f"Configuration parameters - {scope._name_}:")
-                pwndbg.commands.config.display_config(
+                pwndbg.commands.config.display_config("", scope, show_hints=False)
-                    "", pwndbg.lib.config.Scope.config, show_hints=False
-                )
         else:
             # Show information about a single parameter.
             param = pget(bits[2])
             if param is None:
+                print_error(f"unknown setting '{bits[2]}'")
                 warn = True
             else:
                 print(f"Set {param.set_show_doc}.")
@@ -576,10 +598,9 @@ def exec_repl_command(
                     print(param.help_docstring)
 
         if warn:
-            print(
+            print_hint("Use the 'help set' command to see what settings are available for Pwndbg.")
-                message.warn(
+            print_hint(
-                    "The 'set' command is used exclusively for Pwndbg settings. If you meant to see help for LLDB settings, use the fully spelled-out 'settings' command, instead."
+                "If you meant to see help for LLDB settings, see the fully spelled-out 'settings' command, instead."
-                )
             )
 
         return True