feat: Implement no-op extension

README.md

@@ -11,3 +11,28 @@ Mark objects imported with redundant aliases as public.
 This project is available to sponsors only, through my Insiders program.
 See Insiders [explanation](https://mkdocstrings.github.io/griffe-public-redundant-aliases/insiders/)
 and [installation instructions](https://mkdocstrings.github.io/griffe-public-redundant-aliases/insiders/installation/).
+
+## Usage
+
+[Enable](https://mkdocstrings.github.io/griffe/guide/users/extending/#using-extensions) the `griffe_public_redundant_aliases` extension. Now all objects imported with redundant aliases will be marked as public, as per the convention.
+
+```python
+# Following objects will be marked as public.
+from somewhere import Thing as Thing
+from somewhere import Other as Other
+
+# Following object won't be marked as public.
+from somewhere import Stuff
+```
+
+With MkDocs:
+
+```yaml
+plugins:
+- mkdocstrings:
+    handlers:
+      python:
+        options:
+          extensions:
+          - griffe_public_redundant_aliases
+```

docs/insiders/goals.yml

@@ -7,7 +7,10 @@ goals:
     features: []
   1500:
     name: HyperLamp Navigation Tips
-    features: []
+    features:
+    - name: "[Project] Mark objects imported with redundant aliases as public"
+      ref: /
+      since: 2024/08/18
   2000:
     name: FusionDrive Ejection Configuration
     features: []

pyproject.toml

@@ -28,7 +28,9 @@ classifiers = [
     "Topic :: Utilities",
     "Typing :: Typed",
 ]
-dependencies = []
+dependencies = [
+    "griffe>=1.1",
+]
 
 [project.urls]
 Homepage = "https://mkdocstrings.github.io/griffe-public-redundant-aliases"

src/griffe_public_redundant_aliases/__init__.py

@@ -5,4 +5,6 @@
 
 from __future__ import annotations
 
-__all__: list[str] = []
+from griffe_public_redundant_aliases._internals.extension import PublicRedundantAliasesExtension
+
+__all__: list[str] = ["PublicRedundantAliasesExtension"]

src/griffe_public_redundant_aliases/_internals/extension.py

@@ -0,0 +1,5 @@
+import griffe
+
+
+class PublicRedundantAliasesExtension(griffe.Extension):
+    """Mark objects imported with redundant aliases as public."""

tests/test_extension.py

@@ -0,0 +1,6 @@
+"""Test the extension."""
+
+
+def test_extension() -> None:
+    """Dummy test."""
+    assert True