Update: classname.

Author: ya7010

cmdcomp/completion.py

@@ -7,7 +7,7 @@
     Candidates,
     Command,
     Completions,
-    StrOptionsCommand,
+    SubCommandsCommand,
     get_candidates,
     get_targets,
 )
@@ -49,7 +49,7 @@ def _update_completions_list(
     if keys is None:
         keys = []
 
-    if not isinstance(command, StrOptionsCommand):
+    if not isinstance(command, SubCommandsCommand):
         return
 
     for name, subcommand in command.subcommands.items():

cmdcomp/config/command/command.py

@@ -23,7 +23,9 @@
 Completions = Candidates | dict[str, "Completions"]  # type: ignore
 
 
-class StrOptionsCommand(Model):
+class SubCommandsCommand(Model):
+    """A command that can specify a subcommand."""
+
     model_config = ConfigDict(arbitrary_types_allowed=True)
 
     alias: Annotated[
@@ -56,6 +58,8 @@ def aliases(self) -> list[str]:
 
 
 class SpecificOptionsCommand(Model):
+    """A command that can specify options."""
+
     model_config = ConfigDict(arbitrary_types_allowed=True)
 
     alias: Annotated[
@@ -81,7 +85,7 @@ def aliases(self) -> list[str]:
             return self.alias
 
 
-Command = StrOptionsCommand | SpecificOptionsCommand
+Command = SubCommandsCommand | SpecificOptionsCommand
 
 Subcommands = OrderedDict[SubcommandName, Command]
 
@@ -92,7 +96,7 @@ def get_targets(name: SubcommandName, subcommand: Command) -> list[str]:
 
 def get_candidates(command: Command) -> Candidates:
     match command:
-        case StrOptionsCommand():
+        case SubCommandsCommand():
             return (
                 [command.options]
                 if isinstance(command.options, str)

docs/config.schema.json

@@ -72,6 +72,7 @@
         },
         "SpecificOptionsCommand": {
             "additionalProperties": false,
+            "description": "A command that can specify options.",
             "properties": {
                 "alias": {
                     "anyOf": [
@@ -105,8 +106,9 @@
             "title": "SpecificOptionsCommand",
             "type": "object"
         },
-        "StrOptionsCommand": {
+        "SubCommandsCommand": {
             "additionalProperties": false,
+            "description": "A command that can specify a subcommand.",
             "properties": {
                 "alias": {
                     "anyOf": [
@@ -140,7 +142,7 @@
                     "additionalProperties": {
                         "anyOf": [
                             {
-                                "$ref": "#/$defs/StrOptionsCommand"
+                                "$ref": "#/$defs/SubCommandsCommand"
                             },
                             {
                                 "$ref": "#/$defs/SpecificOptionsCommand"
@@ -151,7 +153,7 @@
                     "type": "object"
                 }
             },
-            "title": "StrOptionsCommand",
+            "title": "SubCommandsCommand",
             "type": "object"
         }
     },
@@ -167,7 +169,7 @@
         "root": {
             "anyOf": [
                 {
-                    "$ref": "#/$defs/StrOptionsCommand"
+                    "$ref": "#/$defs/SubCommandsCommand"
                 },
                 {
                     "$ref": "#/$defs/SpecificOptionsCommand"