Merge pull request #721 from BrianPugh/bugfix/bool-alias-negative

Bugfix/bool alias negative

Author: BrianPugh

cyclopts/help/formatters/html.py

@@ -113,43 +113,28 @@ def _format_command_panel(self, entries: list["HelpEntry"], console: Optional["C
         self._output.write('<ul class="commands-list">\n')
 
         for entry in entries:
-            # Get command name(s)
-            names = []
-            if entry.names:
-                names.extend(entry.names)
-            if entry.shorts:
-                names.extend(entry.shorts)
-
-            # Generate anchor link if we have app context
-            if self.app_name and names:
-                # Build the anchor ID for this command
-                primary_name = names[0]
-                aliases = names[1:]
+            names = entry.all_options
+            if not names:
+                name_html = ""
+            elif self.app_name:
+                # Generate anchor link
+                primary_name, aliases = names[0], names[1:]
                 if self.command_chain:
-                    # We're in a subcommand, build full chain
                     full_chain = self.command_chain + [primary_name]
                     anchor_id = f"{self.app_name}-{'-'.join(full_chain[1:])}".lower()
                 else:
-                    # Top-level command
                     anchor_id = f"{self.app_name}-{primary_name}".lower()
-
-                # Create linked command name with aliases in parentheses
                 name_html = f'<a href="#{anchor_id}"><code>{escape_html(primary_name)}</code></a>'
                 if aliases:
-                    # Add aliases in parentheses
                     aliases_str = ", ".join(escape_html(n) for n in aliases)
                     name_html = f"{name_html} ({aliases_str})"
             else:
-                # Fallback to non-linked format with aliases in parentheses
-                if names:
-                    primary_name = names[0]
-                    aliases = names[1:]
-                    name_html = f"<code>{escape_html(primary_name)}</code>"
-                    if aliases:
-                        aliases_str = ", ".join(escape_html(n) for n in aliases)
-                        name_html = f"{name_html} ({aliases_str})"
-                else:
-                    name_html = ""
+                # Non-linked format with aliases in parentheses
+                primary_name, aliases = names[0], names[1:]
+                name_html = f"<code>{escape_html(primary_name)}</code>"
+                if aliases:
+                    aliases_str = ", ".join(escape_html(n) for n in aliases)
+                    name_html = f"{name_html} ({aliases_str})"
 
             desc_html = escape_html(extract_text(entry.description, console))
 
@@ -177,15 +162,8 @@ def _format_parameter_panel(self, entries: list["HelpEntry"], console: Optional[
         self._output.write('<ul class="parameters-list">\n')
 
         for entry in entries:
-            # Build parameter names
-            names = []
-            if entry.names:
-                names.extend(entry.names)
-            if entry.shorts:
-                names.extend(entry.shorts)
-
             # Format name with code tags
-            if names:
+            if names := entry.all_options:
                 name_html = ", ".join(f"<code>{escape_html(n)}</code>" for n in names)
             else:
                 name_html = ""

cyclopts/help/formatters/markdown.py

@@ -102,17 +102,9 @@ def _format_command_panel(self, entries: list["HelpEntry"], console: Optional["C
         """
         # Always use list style for Typer-like output
         for entry in entries:
-            # Get command name(s)
-            names = []
-            if entry.names:
-                names.extend(entry.names)
-            if entry.shorts:
-                names.extend(entry.shorts)
-
-            if names:
+            if names := entry.all_options:
                 # Use first name as primary, show aliases in parentheses
-                primary_name = names[0]
-                aliases = names[1:]
+                primary_name, aliases = names[0], names[1:]
                 if aliases:
                     name_display = f"{primary_name} ({', '.join(aliases)})"
                 else:
@@ -138,14 +130,7 @@ def _format_parameter_panel(self, entries: list["HelpEntry"], console: Optional[
         """
         # Always use list style for Typer-like output
         for entry in entries:
-            # Build parameter names
-            names = []
-            if entry.names:
-                names.extend(entry.names)
-            if entry.shorts:
-                names.extend(entry.shorts)
-
-            if names:
+            if names := entry.all_options:
                 # Separate positional names from option names
                 positional_names = [n for n in names if not n.startswith("-")]
                 short_opts = [n for n in names if n.startswith("-") and not n.startswith("--")]

cyclopts/help/formatters/plain.py

@@ -109,20 +109,15 @@ def __call__(
 
         # Print each entry in the panel
         for entry in panel.entries:
-            # Extract the components
-            # Join names and shorts if they are tuples
-            names_text = " ".join(entry.names) if entry.names else ""
-            shorts_text = " ".join(entry.shorts) if entry.shorts else ""
             desc = _to_plain_text(entry.description, console)
 
             # Format the entry line
-            if names_text or shorts_text:
-                # Handle parameters section specially
+            if entry.all_options:
                 if panel.format == "parameter":
-                    self._format_parameter_entry(entry.names, entry.shorts, desc, console, entry)
+                    self._format_parameter_entry(entry.all_options, desc, console, entry)
                 else:
-                    # For commands or other panels
-                    self._format_command_entry(entry.names, entry.shorts, desc, console)
+                    # Command formatter needs separate longs/shorts for its specific layout
+                    self._format_command_entry(entry.positive_names, entry.positive_shorts, desc, console)
 
         # Add trailing newline for visual separation between panels
         console.print()
@@ -179,8 +174,7 @@ def render_description(
 
     def _format_parameter_entry(
         self,
-        names: tuple[str, ...],
-        shorts: tuple[str, ...],
+        options: tuple[str, ...],
         desc: str,
         console: "Console",
         entry: "HelpEntry",
@@ -189,21 +183,16 @@ def _format_parameter_entry(
 
         Parameters
         ----------
-        names : tuple[str, ...]
-            Parameter long names.
-        shorts : tuple[str, ...]
-            Short forms of the parameter.
+        options : tuple[str, ...]
+            All parameter options in display order.
         desc : str
             Parameter description.
         console : ~rich.console.Console
             Console to print to.
         entry : HelpEntry
             The full help entry with metadata fields.
         """
-        # Combine all names and shorts
-        all_options = list(names) + list(shorts)
-
-        if not all_options:
+        if not options:
             return
 
         # Build the description with metadata
@@ -228,22 +217,13 @@ def _format_parameter_entry(
 
         full_desc = " ".join(desc_parts)
 
-        # Format output based on number of options
-        if len(all_options) > 1:
-            # Multiple options - show them all on first line with description
-            options_str = ", ".join(all_options)
-            if full_desc:
-                text = f"{options_str}: {full_desc}"
-            else:
-                text = options_str
-            self._print_plain(console, textwrap.indent(text, self.indent))
+        # Format: "option1, option2, ...: description"
+        options_str = ", ".join(options)
+        if full_desc:
+            text = f"{options_str}: {full_desc}"
         else:
-            # Single option
-            if full_desc:
-                text = f"{all_options[0]}: {full_desc}"
-            else:
-                text = all_options[0]
-            self._print_plain(console, textwrap.indent(text, self.indent))
+            text = options_str
+        self._print_plain(console, textwrap.indent(text, self.indent))
 
     def _format_command_entry(
         self,

cyclopts/help/formatters/rst.py

@@ -97,17 +97,9 @@ def _format_command_panel(self, entries: list["HelpEntry"], console: Optional["C
             Console for text extraction.
         """
         for entry in entries:
-            # Get command name(s)
-            names = []
-            if entry.names:
-                names.extend(entry.names)
-            if entry.shorts:
-                names.extend(entry.shorts)
-
-            if names:
+            if names := entry.all_options:
                 # Use first name as primary, show aliases in parentheses
-                primary_name = names[0]
-                aliases = names[1:]
+                primary_name, aliases = names[0], names[1:]
                 if aliases:
                     name_display = f"{primary_name} ({', '.join(aliases)})"
                 else:
@@ -140,14 +132,7 @@ def _format_parameter_panel(self, entries: list["HelpEntry"], console: Optional[
             Console for text extraction.
         """
         for entry in entries:
-            # Build parameter names
-            names = []
-            if entry.names:
-                names.extend(entry.names)
-            if entry.shorts:
-                names.extend(entry.shorts)
-
-            if names:
+            if names := entry.all_options:
                 # Determine if we should display as positional based on requirement and default
                 is_positional = entry.required and entry.default is None and not any(n.startswith("-") for n in names)
 

cyclopts/help/help.py

@@ -61,11 +61,32 @@ def _text_factory():
 class HelpEntry:
     """Container for help table entry data."""
 
-    names: tuple[str, ...] = ()
-    """Long option names (e.g., "--verbose", "--help")."""
+    positive_names: tuple[str, ...] = ()
+    """Positive long option names (e.g., "--verbose", "--dry-run")."""
 
-    shorts: tuple[str, ...] = ()
-    """Short option names (e.g., "-v", "-h")."""
+    positive_shorts: tuple[str, ...] = ()
+    """Positive short option names (e.g., "-v", "-n")."""
+
+    negative_names: tuple[str, ...] = ()
+    """Negative long option names (e.g., "--no-verbose", "--no-dry-run")."""
+
+    negative_shorts: tuple[str, ...] = ()
+    """Negative short option names (e.g., "-N"). Rarely used."""
+
+    @property
+    def names(self) -> tuple[str, ...]:
+        """All long option names (positive + negative). For backward compatibility."""
+        return self.positive_names + self.negative_names
+
+    @property
+    def shorts(self) -> tuple[str, ...]:
+        """All short option names (positive + negative). For backward compatibility."""
+        return self.positive_shorts + self.negative_shorts
+
+    @property
+    def all_options(self) -> tuple[str, ...]:
+        """All options in display order: positive longs, positive shorts, negative longs, negative shorts."""
+        return self.positive_names + self.positive_shorts + self.negative_names + self.negative_shorts
 
     description: Any = None
     """Help text description for this entry.
@@ -373,12 +394,12 @@ def help_append(text, style):
             if arg_name != options[0]:
                 options = [arg_name, *options]
 
-        short_options, long_options = [], []
-        for option in options:
-            if _is_short(option):
-                short_options.append(option)
-            else:
-                long_options.append(option)
+        # Split options into positive/negative and long/short categories.
+        negatives = set(argument.negatives)
+        positive_names = [o for o in options if o not in negatives and not _is_short(o)]
+        positive_shorts = [o for o in options if o not in negatives and _is_short(o)]
+        negative_names = [o for o in options if o in negatives and not _is_short(o)]
+        negative_shorts = [o for o in options if o in negatives and _is_short(o)]
 
         help_description = InlineText.from_format(argument.parameter.help, format=format)
 
@@ -428,9 +449,11 @@ def help_append(text, style):
 
         # populate row
         entry = HelpEntry(
-            names=tuple(long_options),
+            positive_names=tuple(positive_names),
+            positive_shorts=tuple(positive_shorts),
+            negative_names=tuple(negative_names),
+            negative_shorts=tuple(negative_shorts),
             description=help_description,
-            shorts=tuple(short_options),
             required=argument.required,
             type=resolve_annotated(argument.field_info.annotation),
             choices=choices,
@@ -470,13 +493,14 @@ def format_command_entries(apps_with_names: Iterable, format: str) -> list[HelpE
         app = registered_command.app
         if not app.show:
             continue
+        # Commands don't have negative variants, so all names are "positive"
         short_names, long_names = [], []
         for name in names:
             short_names.append(name) if _is_short(name) else long_names.append(name)
 
         entry = HelpEntry(
-            names=tuple(long_names),
-            shorts=tuple(short_names),
+            positive_names=tuple(long_names),
+            positive_shorts=tuple(short_names),
             description=InlineText.from_format(docstring_parse(app.help, format).short_description, format=format),
             sort_key=resolve_callables(app.sort_key, app),
         )

cyclopts/help/specs.py

@@ -51,14 +51,9 @@ def __call__(self, entry: "HelpEntry") -> "RenderableType":
         -------
         ~rich.console.RenderableType
             Combined names and shorts, optionally wrapped.
+            Order: positive_names, positive_shorts, negative_names, negative_shorts
         """
-        names_str = " ".join(entry.names) if entry.names else ""
-        shorts_str = " ".join(entry.shorts) if entry.shorts else ""
-
-        if names_str and shorts_str:
-            text = names_str + " " + shorts_str
-        else:
-            text = names_str or shorts_str
+        text = " ".join(entry.all_options)
 
         if self.max_width is None:
             return text
@@ -108,8 +103,8 @@ def __call__(self, entry: "HelpEntry") -> "RenderableType":
         ~rich.console.RenderableType
             Primary command name with aliases in parentheses.
         """
-        primary = entry.names[0]
-        aliases = list(entry.names[1:]) + list(entry.shorts)
+        primary = entry.all_options[0] if entry.all_options else ""
+        aliases = list(entry.all_options[1:])
 
         if aliases:
             text = f"{primary} ({', '.join(aliases)})"

tests/__snapshots__/test_docs_snapshots/TestRstSnapshots.test_admin_commands_rst.rst

@@ -18,7 +18,7 @@ Complex CLI application for comprehensive documentation testing.
 ``--verbose, -v``
     Verbosity level (-v, -vv, -vvv). [Default: ``0``]
 
-``--quiet, --no-quiet, -q``
+``--quiet, -q, --no-quiet``
     Suppress non-essential output. [Default: ``False``]
 
 ``--log-level``
@@ -209,7 +209,7 @@ Delete a user.
 
 **Parameters:**
 
-``--force, --no-force, -f``
+``--force, -f, --no-force``
     Skip confirmation prompt. [Default: ``False``]
 
 ``--backup, --no-backup``

tests/__snapshots__/test_docs_snapshots/TestRstSnapshots.test_data_commands_rst.rst

@@ -18,7 +18,7 @@ Complex CLI application for comprehensive documentation testing.
 ``--verbose, -v``
     Verbosity level (-v, -vv, -vvv). [Default: ``0``]
 
-``--quiet, --no-quiet, -q``
+``--quiet, -q, --no-quiet``
     Suppress non-essential output. [Default: ``False``]
 
 ``--log-level``

tests/__snapshots__/test_docs_snapshots/TestRstSnapshots.test_flattened_commands_rst.rst

@@ -18,7 +18,7 @@ Complex CLI application for comprehensive documentation testing.
 ``--verbose, -v``
     Verbosity level (-v, -vv, -vvv). [Default: ``0``]
 
-``--quiet, --no-quiet, -q``
+``--quiet, -q, --no-quiet``
     Suppress non-essential output. [Default: ``False``]
 
 ``--log-level``
@@ -150,7 +150,7 @@ Delete a user.
 
 **Parameters:**
 
-``--force, --no-force, -f``
+``--force, -f, --no-force``
     Skip confirmation prompt. [Default: ``False``]
 
 ``--backup, --no-backup``