🚸 Improve shell completions

Author: Freed-Wu

.pre-commit-config.yaml

@@ -1,5 +1,5 @@
 ---
-exclude: (^templates/.*|.*\.json$)
+exclude: ^templates/.*|.*\.json$
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
@@ -23,7 +23,7 @@ repos:
       - id: check-toml
       - id: check-json
   - repo: https://github.com/Lucas-C/pre-commit-hooks
-    rev: v1.5.4
+    rev: v1.5.5
     hooks:
       - id: remove-crlf
   - repo: https://github.com/codespell-project/codespell
@@ -46,6 +46,7 @@ repos:
     rev: 3.0.0
     hooks:
       - id: check-mailmap
+      # https://github.com/koalaman/shellcheck/issues/2909
       - id: shellcheck
         exclude_types:
           - zsh

src/termux_language_server/__main__.py

@@ -3,12 +3,16 @@
 """
 
 from argparse import ArgumentParser, RawDescriptionHelpFormatter
-from contextlib import suppress
 from datetime import datetime
 
 from . import FILETYPE, __version__
 from . import __name__ as NAME
 
+try:
+    import shtab
+except ImportError:
+    import _shtab as shtab
+
 NAME = NAME.replace("_", "-")
 VERSION = rf"""{NAME} {__version__}
 Copyright (C) {datetime.now().year}
@@ -25,52 +29,49 @@ def get_parser():
         epilog=EPILOG,
         formatter_class=RawDescriptionHelpFormatter,
     )
-    with suppress(ImportError):
-        import shtab
-
-        shtab.add_argument_to(parser)
+    shtab.add_argument_to(parser)
     parser.add_argument("--version", version=VERSION, action="version")
     parser.add_argument(
         "--generate-schema",
         choices=FILETYPE.__args__,  # type: ignore
         help="generate schema in an output format",
     )
+    parser.add_argument(
+        "--output-format",
+        choices=["json", "yaml", "toml"],
+        default="json",
+        help="output format: %(default)s",
+    )
     parser.add_argument(
         "--indent",
         type=int,
         default=2,
-        help="generated json's indent",
+        help="generated json, yaml's indent, ignored by toml: %(default)s",
+    )
+    parser.add_argument(
+        "--color",
+        choices=["auto", "always", "never"],
+        default="auto",
+        help="when to display color, default: %(default)s",
     )
     parser.add_argument(
         "--check",
         nargs="*",
         default={},
         help="check file's errors and warnings",
-    )
+    ).complete = shtab.FILE  # type: ignore
     parser.add_argument(
         "--format",
         nargs="*",
         default={},
         help="format files",
-    )
-    parser.add_argument(
-        "--color",
-        choices=["auto", "always", "never"],
-        default="auto",
-        help="when to display color, default: %(default)s",
-    )
+    ).complete = shtab.FILE  # type: ignore
     parser.add_argument(
         "--convert",
         nargs="*",
         default={},
         help="convert files to output format",
-    )
-    parser.add_argument(
-        "--output-format",
-        choices=["json", "yaml", "toml"],
-        default="json",
-        help="output format: %(default)s",
-    )
+    ).complete = shtab.FILE  # type: ignore
     return parser
 
 
@@ -92,10 +93,13 @@ def main():
         if args.generate_schema:
             from .misc import get_schema
 
+            kwargs = (
+                {"indent": args.indent} if args.output_format != "toml" else {}
+            )
             pprint(
                 get_schema(args.generate_schema),
                 filetype=args.output_format,
-                indent=args.indent,
+                **kwargs,
             )
         for file in args.convert:
             pprint(

src/termux_language_server/_shtab.py

@@ -0,0 +1,16 @@
+r"""Fake shtab
+==============
+"""
+
+from argparse import ArgumentParser
+from typing import Any
+
+FILE = None
+DIRECTORY = DIR = None
+
+
+def add_argument_to(parser: ArgumentParser, *args: Any, **kwargs: Any):
+    from argparse import Action
+
+    Action.complete = None  # type: ignore
+    return parser