🎨 CodeStyle: add pre-commit

Author: gouzil

.github/workflows/release.yaml

@@ -9,4 +9,4 @@ wheels/
 # Virtual environments
 .venv
 src/yamlfmt/_version.py
-.python-version
+.python-version

.gitignore

@@ -0,0 +1,19 @@
+repos:
+  # Common hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.6
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix, --no-cache]
+      - id: ruff-format
+
+  # TODO: add self

.pre-commit-config.yaml

@@ -1,13 +1,16 @@
+from __future__ import annotations
+
 import os
 import platform
+import shutil
 import sys
-from hatchling.builders.hooks.plugin.interface import BuildHookInterface
-from typing import Any
-from pathlib import Path
+import tarfile
 import tempfile
+from pathlib import Path
+from typing import Any
 from urllib import request
-import tarfile
-import shutil
+
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
 
 
 class SpecialBuildHook(BuildHookInterface):
@@ -29,9 +32,7 @@ def initialize(self, version: str, build_data: dict[str, Any]) -> None:
         if target_arch not in ["x86_64", "arm64", "aarch64", "i386"]:
             raise NotImplementedError(f"no support arch: {target_arch}")
 
-        if not any(
-            os_name in target_os_info for os_name in ["linux", "darwin", "macos", "win"]
-        ):
+        if not any(os_name in target_os_info for os_name in ["linux", "darwin", "macos", "win"]):
             raise NotImplementedError(f"no support os: {target_os_info}")
 
         # 检查系统和架构的组合
@@ -59,9 +60,7 @@ def initialize(self, version: str, build_data: dict[str, Any]) -> None:
         # TODO: 加一个 sum 校验
         bin_path = self.temp_dir / self.BIN_NAME
         assert bin_path.is_file(), f"{self.BIN_NAME} not found"
-        build_data["force_include"][f"{bin_path.resolve()}"] = (
-            f"yamlfmt/{self.BIN_NAME}"
-        )
+        build_data["force_include"][f"{bin_path.resolve()}"] = f"yamlfmt/{self.BIN_NAME}"
 
     def download_yamlfmt(self, target_os_info: str, target_arch: str) -> None:
         """Download the yamlfmt binary for the specified OS and architecture."""
@@ -74,15 +73,11 @@ def download_yamlfmt(self, target_os_info: str, target_arch: str) -> None:
             "amd64": "x86_64",
             "aarch64": "arm64",
         }
-        file_path = (
-            self.temp_dir / f"{self.BIN_NAME}_{target_os_info}_{target_arch}.tar.gz"
-        )
+        file_path = self.temp_dir / f"{self.BIN_NAME}_{target_os_info}_{target_arch}.tar.gz"
         request.urlretrieve(
             self.YAMLFMT_REPO.format(
                 version=self.metadata.version,
-                target_os_info=target_os_info_to_go_os.get(
-                    target_os_info, target_os_info
-                ),
+                target_os_info=target_os_info_to_go_os.get(target_os_info, target_os_info),
                 target_arch=target_arch_to_go_arch.get(target_arch, target_arch),
             ),
             file_path,

hatch_build.py

@@ -6,6 +6,11 @@ readme = "README.md"
 requires-python = ">=3.9"
 dependencies = []
 
+[dependency-groups]
+dev = [
+    "hatchling>=1.27.0",
+]
+
 [project.scripts]
 yamlfmt = "yamlfmt.__main__:main"
 
@@ -24,7 +29,56 @@ version.source = "vcs"
 requires = ["hatchling", "hatch-vcs"]
 build-backend = "hatchling.build"
 
-[dependency-groups]
-dev = [
-    "hatchling>=1.27.0",
+
+[tool.ruff]
+line-length = 120
+target-version = "py39"
+
+[tool.ruff.lint]
+select = [
+  # Pyflakes
+  "F",
+  # Pycodestyle
+  "E",
+  "W",
+  # Isort
+  "I",
+  # Comprehensions
+  "C4",
+  # Debugger
+  "T100",
+  # Pyupgrade
+  "UP",
+  # Flake8-pyi
+  "PYI",
+  # Bugbear
+  "B",
+  # Pylint
+  "PLE",
+  # Flake8-simplify
+  "SIM101",
+  # Flake8-use-pathlib
+  "PTH",
+  # Pygrep-hooks
+  "PGH004",
+  # Flake8-type-checking
+  "TC",
+  # Flake8-raise
+  "RSE",
+  # Refurb
+  "FURB",
+  # Flake8-future-annotations
+  "FA",
+  # Yesqa
+  "RUF100",
+]
+ignore = [
+  "E501",  # line too long, duplicate with ruff fmt
+  "F401",  # imported but unused, duplicate with pyright
+  "F841",  # local variable is assigned to but never used, duplicate with pyright
+  "UP038", # It will cause the performance regression on python3.10
 ]
+
+[tool.ruff.lint.isort]
+required-imports = ["from __future__ import annotations"]
+combine-as-imports = true

pyproject.toml

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from ._version import version as __version__
 
 __all__ = ["__version__"]

src/yamlfmt/__init__.py

@@ -1,25 +1,31 @@
+from __future__ import annotations
+
+import importlib.resources as pkg_resources
 import os
 import platform
-import sys
 import subprocess
-import importlib.resources as pkg_resources
+import sys
+
 from yamlfmt import BIN_NAME
 
+
 def get_executable_path():
-    with pkg_resources.as_file(pkg_resources.files('yamlfmt').joinpath(f"./{BIN_NAME}")) as p:
+    with pkg_resources.as_file(pkg_resources.files("yamlfmt").joinpath(f"./{BIN_NAME}")) as p:
         executable_path = p
 
     if platform.system() != "Windows":
         if not os.access(executable_path, os.X_OK):
-            current_mode = os.stat(executable_path).st_mode
-            os.chmod(executable_path, current_mode | 0o111)
+            current_mode = executable_path.stat().st_mode
+            executable_path.chmod(current_mode | 0o111)
 
     return executable_path
 
+
 def main():
     executable_path = get_executable_path()
     result = subprocess.run([executable_path] + sys.argv[1:], check=False)
     sys.exit(result.returncode)
 
+
 if __name__ == "__main__":
     main()

src/yamlfmt/__main__.py

@@ -1,2 +1,2 @@
 version: str
-version_tuple: tuple[int, int, int, str, str] | tuple[int, int, int]
+version_tuple: tuple[int, int, int, str, str] | tuple[int, int, int]