chore: add test coverage and github actions test workflow

Author: BrutalSimplicity

.coveragerc

@@ -0,0 +1,6 @@
+[run]
+branch = True
+include =
+    src/**
+omit =
+    __main__.py

.github/workflows/pytest.yml

@@ -0,0 +1,22 @@
+name: Test Coverage
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.7.13"
+
+      - name: Install Dependencies
+        run: pip install '.[dev]'
+
+      - name: Run Tests
+        run: pytest --cov --cov-report xml

.vscode/settings.json

@@ -1,7 +1,7 @@
 {
-  "python.defaultInterpreterPath": ".venv/bin/python",
-  "python.testing.pytestPath": ".venv/bin/pytest",
-  "python.linting.flake8Path": ".venv/bin/flake8",
+  "python.defaultInterpreterPath": "venv/bin/python",
+  "python.testing.pytestPath": "venv/bin/pytest",
+  "python.linting.flake8Path": "venv/bin/flake8",
   "python.linting.flake8Enabled": true,
   "python.testing.pytestEnabled": true
 }

setup.py

@@ -8,6 +8,6 @@
         "typing_extensions",
     ],
     extras_require={
-        "dev": ["pre-commit", "pytest", "flake8", "flake8-docstrings"],
+        "dev": ["pre-commit", "pytest", "flake8", "flake8-docstrings", "pytest-cov"],
     },
 )

src/rich_click/__init__.py

@@ -7,7 +7,7 @@
 
 __version__ = "1.6.0.dev0"
 
-from typing import Optional, TYPE_CHECKING
+from typing import Any, Callable, cast, Optional, overload, TYPE_CHECKING, Union
 
 from click import *  # noqa: F401, F403
 from click import command as click_command
@@ -19,6 +19,7 @@
 from . import rich_click  # noqa: F401
 
 from rich_click.rich_command import RichCommand
+from rich_click.rich_context import RichContext
 from rich_click.rich_group import RichGroup
 from rich_click.rich_help_configuration import RichHelpConfiguration
 
@@ -36,10 +37,13 @@
         "version_option",
         "group",
         "command",
+        "rich_config",
+        "RichContext",
+        "RichHelpConfiguration",
     ]
 
 
-def group(*args, cls=RichGroup, **kwargs):
+def group(*args, cls=RichGroup, **kwargs) -> Callable[..., RichGroup]:
     """
     Group decorator function.
 
@@ -55,13 +59,13 @@ def wrapper(fn):
             context_settings.update(rich_console=console, rich_help_config=help_config)
             kwargs.update(context_settings=context_settings)
             del fn.__rich_context_settings__
-        cmd = click_group(*args, cls=cls, **kwargs)(fn)
+        cmd = cast(RichGroup, click_group(*args, cls=cls, **kwargs)(fn))
         return cmd
 
     return wrapper
 
 
-def command(*args, cls=RichCommand, **kwargs):
+def command(*args, cls=RichCommand, **kwargs) -> Callable[..., RichCommand]:
     """
     Command decorator function.
 
@@ -77,7 +81,7 @@ def wrapper(fn):
             context_settings.update(rich_console=console, rich_help_config=help_config)
             kwargs.update(context_settings=context_settings)
             del fn.__rich_context_settings__
-        cmd = click_command(*args, cls=cls, **kwargs)(fn)
+        cmd = cast(RichCommand, click_command(*args, cls=cls, **kwargs)(fn))
         return cmd
 
     return wrapper
@@ -99,6 +103,14 @@ def rich_config(console: Optional[Console] = None, help_config: Optional[RichHel
             Defaults to None.
     """
 
+    @overload
+    def decorator(obj: Union[RichCommand, RichGroup]) -> Union[RichCommand, RichGroup]:
+        ...
+
+    @overload
+    def decorator(obj: Callable[..., Any]) -> Callable[..., Any]:
+        ...
+
     def decorator(obj):
         if isinstance(obj, (RichCommand, RichGroup)):
             obj.context_settings.update({"rich_console": console, "rich_help_config": help_config})

tests/test_help.py

@@ -1,12 +1,13 @@
 from typing import Optional, Type
 
+import click
 import pytest
 from click import UsageError
 from conftest import AssertRichFormat, AssertStr, InvokeCli
 from rich.console import Console
 
-from rich_click import command, rich_config
-from rich_click.rich_help_configuration import RichHelpConfiguration
+from rich_click import command, rich_config, RichContext, RichHelpConfiguration
+from rich_click.rich_command import RichCommand
 
 
 @pytest.mark.parametrize(
@@ -182,6 +183,7 @@ def cli():
         pass
 
     assert hasattr(cli, "__rich_context_settings__") is False
+    assert cli.console is not None
     assert cli.__doc__ is not None
     assert_str(
         cli.__doc__,
@@ -207,3 +209,18 @@ def cli():
 ╰──────────────────────────────────────────────────────────────────────────────╯
     """,
     )
+
+
+def test_rich_config_context_settings(invoke: InvokeCli):
+    @click.command(
+        cls=RichCommand, context_settings={"rich_console": Console(), "rich_help_config": RichHelpConfiguration()}
+    )
+    @click.pass_context
+    def cli(ctx: RichContext):
+        assert isinstance(ctx, RichContext)
+        assert ctx.console is not None
+        assert ctx.help_config is not None
+
+    result = invoke(cli)
+    assert result.exit_code == 0
+    assert result.exception is None