feat: add more Ruff checks, and a helper script

Signed-off-by: Henry Schreiner <[email protected]>

Author: henryiii

helpers/cog_cc.py

@@ -26,12 +26,12 @@ def yaml(self) -> str:
         result.append(f"  help: {self.prompt}")
         if self.choices:
             result.append("  choices:")
-            for choice in self.choices:
-                result.append(
-                    f'    "{choice.description}": {choice.name}'
-                    if choice.description
-                    else f"    - {choice.name}"
-                )
+            result.extend(
+                f'    "{choice.description}": {choice.name}'
+                if choice.description
+                else f"    - {choice.name}"
+                for choice in self.choices
+            )
         return "\n".join(result)
 
 

helpers/extensions.py

@@ -39,7 +39,7 @@ class CookiecutterContext(SmartDict):
 
 @CookiecutterContext.register
 def __year(_):
-    return str(datetime.datetime.today().year)
+    return str(datetime.datetime.now(tz=datetime.timezone.utc).year)
 
 
 @CookiecutterContext.register

helpers/missing_ruff.py

@@ -0,0 +1,109 @@
+#!/usr/bin/env -S uv run --script
+
+# /// script
+# dependencies = ["ruff", "rich"]
+# ///
+
+
+import argparse
+import json
+import subprocess
+from collections.abc import Iterator
+from pathlib import Path
+
+import tomllib
+from rich import print
+from rich.columns import Columns
+from rich.panel import Panel
+from ruff.__main__ import find_ruff_bin
+
+libs = {"AIR", "ASYNC", "DJ", "FAST", "INT", "NPY", "PD"}
+specialty = {
+    "CPY",  # preview only
+    "A",  # Naming related
+    "N",  # Naming related
+    "ANN",  # Not all rules good
+    "TID",  # Not all rules good
+    "C90",  # Complexity
+    "COM",  # Trailing commas inform the formatter
+    "D",  # Requires everything documented
+    "DOC",  # Style-specific
+    "ERA",  # Check for commented code
+    "FBT",  # Can't be applied to old code very well
+    "FIX",  # TODO's are okay
+    "TD",  # Picky on todo rules
+    "INP",  # Namespace packages are correct sometimes
+    "S",  # Security (can be picky)
+    "SLF",  # Very picky
+}
+
+
+def process_dir(path: Path) -> None:
+    with path.joinpath("pyproject.toml").open("rb") as f:
+        pyproject = tomllib.load(f)
+
+    match pyproject:
+        case {"tool": {"ruff": {"lint": {"extend-select": selection}}}}:
+            selected = frozenset(selection)
+        case _:
+            raise SystemExit(1)
+
+    linter_txt = subprocess.run(
+        [find_ruff_bin(), "linter", "--output-format=json"],
+        check=True,
+        capture_output=True,
+        text=True,
+        cwd=path,
+    ).stdout
+    linter = json.loads(linter_txt)
+
+    lint_info = {r["prefix"]: r["name"] for r in linter if r["prefix"] not in {"", "F"}}
+
+    selected_items = {k: v for k, v in lint_info.items() if k in selected}
+    all_uns_items = {k: v for k, v in lint_info.items() if k not in selected}
+    unselected_items = {
+        k: v for k, v in all_uns_items.items() if k not in libs | specialty
+    }
+    libs_items = {k: v for k, v in all_uns_items.items() if k in libs}
+    spec_items = {k: v for k, v in all_uns_items.items() if k in specialty}
+
+    def print_each(items: dict[str, str]) -> Iterator[str]:
+        for k, v in items.items():
+            kk = f'[green]"{k}"[/green],'
+            yield f"  {kk:23} [dim]# {v}[/dim]"
+
+    panel_sel = Panel(
+        "\n".join(print_each(selected_items)), title="Selected", border_style="green"
+    )
+    panel_lib = Panel(
+        "\n".join(print_each(libs_items)),
+        title="Library specific",
+        border_style="yellow",
+    )
+    panel_spec = Panel(
+        "\n".join(print_each(spec_items)), title="Specialized", border_style="yellow"
+    )
+    uns = "\n".join(print_each(unselected_items))
+
+    if uns:
+        print(Columns([panel_sel, panel_lib, panel_spec]))
+        print("[red]Unselected [dim](copy and paste ready)")
+        print(uns)
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(description="Look up Ruff rules in a directory")
+    parser.add_argument(
+        "path",
+        nargs="?",
+        type=Path,
+        default=Path.cwd(),
+        help="Directory to process (default: current working directory)",
+    )
+    args = parser.parse_args()
+
+    process_dir(args.path)
+
+
+if __name__ == "__main__":
+    main()

pyproject.toml

@@ -161,23 +161,40 @@ extend-select = [
   "ARG",         # flake8-unused-arguments
   "B",           # flake8-bugbear
   "C4",          # flake8-comprehensions
+  "DTZ",         # flake8-datetimez
   "EM",          # flake8-errmsg
+  "EXE",         # flake8-executable
   "FA",          # flake8-future-annotations
+  "FURB",        # refurb
+  "G",           # flake8-logging-format
   "I",           # isort
   "ICN",         # flake8-import-conventions
+  "NPY",         # NumPy specific rules
+  "PD",          # pandas-vet
+  "PERF",        # perflint
   "PGH",         # pygrep-hooks
   "PIE",         # flake8-pie
   "PL",          # pylint
   "PT",          # flake8-pytest-style
   "PTH",         # flake8-use-pathlib
+  "PYI",         # flake8-pyi
   "RET",         # flake8-return
   "RUF",         # Ruff-specific
   "SIM",         # flake8-simplify
+  "SLOT",        # flake8-slots
   "T20",         # flake8-print
-  "TC",          # flake8-type-check
+  "TC",          # flake8-type-checking
   "TID251",      # flake8-tidy-imports.banned-api
   "UP",          # pyupgrade
   "YTT",         # flake8-2020
+  "BLE",         # flake8-blind-except
+  "T10",         # flake8-debugger
+  "ISC",         # flake8-implicit-str-concat
+  "LOG",         # flake8-logging
+  "Q",           # flake8-quotes
+  "RSE",         # flake8-raise
+  "FLY",         # flynt
+  "TRY",         # tryceratops
 ]
 ignore = [
   "PLR",    # Design related pylint codes

src/sp_repo_review/families.py

@@ -48,15 +48,19 @@ def ruff_description(ruff: dict[str, Any]) -> str:
     common = {
         "ARG",
         "B",
+        "BLE",
         "C4",
         "DTZ",
         "EM",
         "EXE",
         "FA",
+        "FLY",
         "FURB",
         "G",
         "I",
         "ICN",
+        "ISC",
+        "LOG",
         "NPY",
         "PD",
         "PERF",
@@ -66,12 +70,16 @@ def ruff_description(ruff: dict[str, Any]) -> str:
         "PT",
         "PTH",
         "PYI",
+        "Q",
         "RET",
+        "RSE",
         "RUF",
         "SIM",
         "SLOT",
+        "T10",
         "T20",
         "TC",
+        "TRY",
         "UP",
         "YTT",
     }

tests/test_families.py

@@ -60,15 +60,19 @@ def test_python_requires():
 ALL_RULES = [
     "ARG",
     "B",
+    "BLE",
     "C4",
     "DTZ",
     "EM",
     "EXE",
     "FA",
+    "FLY",
     "FURB",
     "G",
     "I",
     "ICN",
+    "ISC",
+    "LOG",
     "NPY",
     "PD",
     "PERF",
@@ -78,12 +82,16 @@ def test_python_requires():
     "PT",
     "PTH",
     "PYI",
+    "Q",
     "RET",
+    "RSE",
     "RUF",
     "SIM",
     "SLOT",
+    "T10",
     "T20",
     "TC",
+    "TRY",
     "UP",
     "YTT",
 ]