✨ add automated linting and formatting functions using ruff

Author: Paillat-dev

scripts/sync_guild_features/__main__.py

@@ -6,8 +6,8 @@
 from github import Auth
 import re
 
-from .utils import get_features_blob, format_path, lint_path, GUILD_FEATURES_GIST_URL
-from ..utils import create_update_pr
+from .utils import get_features_blob, GUILD_FEATURES_GIST_URL
+from ..utils import create_update_pr, format_path, lint_path
 
 CI = os.environ.get("CI", "false").lower() in ("true", "1", "yes")
 

scripts/sync_guild_features/utils.py

@@ -1,9 +1,4 @@
 import requests
-import subprocess
-from pathlib import Path
-from ruff.__main__ import (  # type: ignore[import-untyped]
-    find_ruff_bin,
-)
 
 # https://gist.github.com/advaith1/a82065c4049345b38f526146d6ecab96
 GUILD_FEATURES_GIST_URL = (
@@ -27,42 +22,4 @@ def get_features_blob() -> list[str]:
     return response.json()
 
 
-def format_path(path: Path) -> str:
-    """
-    Formats the given path with ruff.
-
-    Parameters
-    ----------
-        path (Path): The path to format.
-    """
-    result = subprocess.run(
-        [find_ruff_bin(), "format", str(path.absolute())],
-        text=True,
-        capture_output=True,
-        check=True,
-        cwd=Path.cwd(),
-    )
-    result.check_returncode()
-    return result.stdout
-
-
-def lint_path(path: Path) -> str:
-    """
-    Lints the given path with ruff.
-
-    Parameters
-    ----------
-        path (Path): The path to format.
-    """
-    result = subprocess.run(
-        [find_ruff_bin(), "check", "--fix", str(path.absolute())],
-        text=True,
-        capture_output=True,
-        check=True,
-        cwd=Path.cwd(),
-    )
-    result.check_returncode()
-    return result.stdout
-
-
-__all__ = ("get_features_blob", "format_path", "lint_path", "GUILD_FEATURES_GIST_URL")
+__all__ = ("get_features_blob", "GUILD_FEATURES_GIST_URL")

scripts/utils/__init__.py

@@ -1,3 +1,4 @@
 from .pr import create_update_pr
+from .automated_ruff import lint_path, format_path
 
-__all__ = ("create_update_pr",)
+__all__ = ("create_update_pr", "lint_path", "format_path")

scripts/utils/automated_ruff.py

@@ -0,0 +1,46 @@
+import subprocess
+from pathlib import Path
+from ruff.__main__ import (  # type: ignore[import-untyped]
+    find_ruff_bin,
+)
+
+
+def format_path(path: Path) -> str:
+    """
+    Formats the given path with ruff.
+
+    Parameters
+    ----------
+        path (Path): The path to format.
+    """
+    result = subprocess.run(
+        [find_ruff_bin(), "format", str(path.absolute())],
+        text=True,
+        capture_output=True,
+        check=True,
+        cwd=Path.cwd(),
+    )
+    result.check_returncode()
+    return result.stdout
+
+
+def lint_path(path: Path) -> str:
+    """
+    Lints the given path with ruff.
+
+    Parameters
+    ----------
+        path (Path): The path to format.
+    """
+    result = subprocess.run(
+        [find_ruff_bin(), "check", "--fix", str(path.absolute())],
+        text=True,
+        capture_output=True,
+        check=True,
+        cwd=Path.cwd(),
+    )
+    result.check_returncode()
+    return result.stdout
+
+
+__all__ = ("format_path", "lint_path")

scripts/utils/pr.py

@@ -26,10 +26,11 @@ def create_update_pr(commit_message: str, branch_prefix: str, title: str, body:
 
     Parameters
     ----------
-        title (str): The title of the pull request.
-        branch_prefix (str): The prefix for the branch name.
-        body (str): The body of the pull request.
-        base_branch (str): The base branch to create the PR against. Defaults to "main".
+    commit_message (str): The commit message to use.
+    branch_prefix (str): The prefix for the branch name.
+    title (str): The title of the pull request.
+    body (str): The body of the pull request.
+    path (str | Path): The path or glob to the file to commit.
     """
     github = Github(os.environ["GITHUB_TOKEN"])
     repo = github.get_repo(os.environ["GITHUB_REPOSITORY"])