chore: Sync ruff. (#246)

Author: huxuan

.pre-commit-config.yaml

@@ -37,21 +37,6 @@ repos:
     repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
   - hooks:
-      - entry: pipenv run python -m black
-        id: black
-        language: system
-        name: black
-        types:
-          - python
-      - entry: pipenv run python -m isort --filter-files
-        id: isort
-        language: system
-        name: isort
-        require_serial: true
-        types_or:
-          - cython
-          - pyi
-          - python
       - entry: make mypy
         id: mypy
         language: system
@@ -60,12 +45,22 @@ repos:
         require_serial: true
         types:
           - python
-      - entry: pipenv run python -m ruff --force-exclude
+      - entry: pipenv run python -m ruff check --force-exclude
         id: ruff
         language: system
         name: ruff
-        types:
+        require_serial: true
+        types_or:
+          - python
+          - pyi
+      - entry: pipenv run python -m ruff format --check --force-exclude
+        id: ruff-format
+        language: system
+        name: ruff-format
+        require_serial: true
+        types_or:
           - python
+          - pyi
       - entry: pipenv run toml-sort
         id: toml-sort
         language: system

.vscode/extensions.json

@@ -4,11 +4,9 @@
     "ExecutableBookProject.myst-highlight",
     "PascalReitermann93.vscode-yaml-sort",
     "charliermarsh.ruff",
-    "ms-python.black-formatter",
     "ms-python.mypy-type-checker",
     "ms-python.python",
     "richie5um2.vscode-sort-json",
-    "streetsidesoftware.code-spell-checker",
-    "trond-snekvik.simple-rst"
+    "streetsidesoftware.code-spell-checker"
   ]
 }

.vscode/settings.json

@@ -7,9 +7,11 @@
   },
   "[python]": {
     "editor.codeActionsOnSave": {
-      "source.organizeImports": true
+      "source.fixAll.ruff": true,
+      "source.organizeImports.ruff": true
     },
-    "editor.defaultFormatter": "ms-python.black-formatter"
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "editor.formatOnSave": true
   },
   "[yaml]": {
     "editor.defaultFormatter": "PascalReitermann93.vscode-yaml-sort"
@@ -27,7 +29,6 @@
     "genindex",
     "huxuan",
     "interruptible",
-    "isort",
     "JPKXI",
     "maxdepth",
     "modindex",

Makefile

@@ -1,4 +1,4 @@
-.PHONY: clean deepclean install dev constraints black isort mypy ruff toml-sort lint pre-commit test-run test build upload docs-autobuild changelog docs-gen docs-mypy docs-coverage docs
+.PHONY: clean deepclean install dev constraints mypy ruff ruff-format toml-sort lint pre-commit test-run test build upload docs-autobuild changelog docs-gen docs-mypy docs-coverage docs
 
 ########################################################################################
 # Variables
@@ -71,28 +71,24 @@ constraints: deepclean
 # Lint and pre-commit
 ########################################################################################
 
-# Check lint with black.
-black:
-	$(PIPRUN) python -m black --check .
-
-# Check lint with isort.
-isort:
-	$(PIPRUN) python -m isort --check .
-
 # Check lint with mypy.
 mypy:
 	$(PIPRUN) python -m mypy .
 
-# Check lint with ruff.
+# Lint with ruff.
 ruff:
-	$(PIPRUN) python -m ruff .
+	$(PIPRUN) python -m ruff check .
+
+# Format with ruff.
+ruff-format:
+	$(PIPRUN) python -m ruff format --check .
 
 # Check lint with toml-sort.
 toml-sort:
 	$(PIPRUN) toml-sort --check pyproject.toml
 
 # Check lint with all linters.
-lint: black isort mypy ruff toml-sort
+lint: mypy ruff ruff-format toml-sort
 
 # Run pre-commit with autofix against all files.
 pre-commit:

README.md

@@ -10,8 +10,6 @@ A Python project template covering the entire development lifecycle with various
 [![GitHub](https://img.shields.io/github/license/serious-scaffold/ss-python)](https://github.com/serious-scaffold/ss-python/blob/main/LICENSE)
 
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
 [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![Pydantic v2](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pydantic/pydantic/5697b1e4c4a9790ece607654e6c02a160620c7e1/docs/badge/v2.json)](https://pydantic.dev)
@@ -34,7 +32,7 @@ If you find this helpful, please consider [sponsorship](https://github.com/spons
 - Manage [virtual environments](https://docs.python.org/3/glossary.html#term-virtual-environment) for development with [`pipenv`](https://pipenv.pypa.io/).
 - Manage dependency with categorized [requirements](https://pip.pypa.io/en/stable/user_guide/#requirements-files) and [constraints](https://pip.pypa.io/en/stable/user_guide/#constraints-files).
 - Automate Git hooks with [pre-commit hooks](https://github.com/pre-commit/pre-commit-hooks) and [local](https://pre-commit.com/#repository-local-hooks) linters.
-- Lint with [`black`](https://github.com/psf/black), [`isort`](https://pycqa.github.io/isort/), [`mypy`](http://www.mypy-lang.org/), [`ruff`](https://github.com/charliermarsh/ruff), and [`toml-sort`](https://github.com/pappasam/toml-sort).
+- Lint with [`mypy`](http://www.mypy-lang.org/), [`ruff`](https://github.com/charliermarsh/ruff), and [`toml-sort`](https://github.com/pappasam/toml-sort).
 - Test with [`pytest`](https://pytest.org/) and [`coverage`](https://coverage.readthedocs.io) for threshold and reports.
 - Document with [`sphinx`](https://www.sphinx-doc.org/), the [`furo`](https://pradyunsg.me/furo) theme, and [mypy](https://mypy.readthedocs.io/en/stable/command_line.html?report-generation)/[coverage](https://coverage.readthedocs.io/en/7.3.0/cmd.html#html-reporting-coverage-html) reports.
 - Version the package using git metadata with [`setuptools-scm`](https://github.com/pypa/setuptools_scm/).

docs/conf.py

@@ -10,7 +10,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 author = "huxuan"
-copyright = "2023, huxuan"  # noqa: A001
+copyright = "2023, huxuan"
 project = "Serious Scaffold Python"
 release = metadata.version("ss-python")
 version = ".".join(release.split(".")[:2])

pyproject.toml

@@ -42,13 +42,6 @@ ss-python-cli = "ss_python.cli:app"
 homepage = "https://github.com/serious-scaffold/ss-python/"
 issue = "https://github.com/serious-scaffold/ss-python/issues"
 
-[tool.black]
-force-exclude = '''
-(
-  template/.*
-)
-'''
-
 [tool.coverage.report]
 fail_under = 100
 
@@ -57,13 +50,6 @@ source = [
   "ss_python",
 ]
 
-[tool.isort]
-color_output = true
-extend_skip = [
-  "template",
-]
-profile = "black"
-
 [tool.mypy]
 check_untyped_defs = true
 disallow_any_unimported = true
@@ -92,27 +78,28 @@ extend-exclude = [
   "template",
 ]
 fix = true
-ignore = [
-  # https://docs.astral.sh/ruff/rules/#pydocstyle-d
-  "D203",
-  "D204",
-  "D213",
-  "D215",
-  "D400",
-  "D404",
-  "D406",
-  "D407",
-  "D408",
-  "D409",
-  "D413",
-]
-select = ["ALL"]
 src = ["src"]
 
-[tool.ruff.per-file-ignores]
-"docs/conf.py" = ["INP001"]
+[tool.ruff.lint]
+select = [
+  "B", # flake8-bugbear
+  "D", # pydocstyle
+  "E", # pycodestyle error
+  "F", # Pyflakes
+  "I", # isort
+  "RUF100", # Unused noqa directive
+  "S", # flake8-bandit
+  "SIM", # flake8-simplify
+  "UP", # pyupgrade
+  "W", # pycodestyle warning
+]
+
+[tool.ruff.lint.per-file-ignores]
 "test/*" = ["S101"]
 
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
 [tool.setuptools.dynamic]
 dependencies = {file = ["requirements.txt"]}
 

requirements/lint.txt

@@ -1,6 +1,4 @@
 # Requirements for lint.
-black
-isort
 mypy
 ruff
 toml-sort

src/ss_python/settings.py

@@ -16,11 +16,7 @@ class GlobalSettings(BaseSettings):
 class Settings(BaseSettings):
     """Project specific settings."""
 
-    # NOTE(huxuan): Pydantic cannot leverage future annotations at runtime prior to
-    # Python 3.10, so `from __future__ import annotations` cannot be used here, and the
-    # lint error need to be ignored unless the minimal Python version >= 3.10.
-    # Reference: https://github.com/pydantic/pydantic/issues/3300#issuecomment-1034007897
-    logging_level: Optional[str] = getLevelName(logging.INFO)  # noqa: FA100
+    logging_level: Optional[str] = getLevelName(logging.INFO)
     """Default logging level for the project."""
 
     model_config = SettingsConfigDict(

template/.pre-commit-config.yaml.jinja

@@ -48,21 +48,6 @@ repos:
     repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
   - hooks:
-      - entry: pipenv run python -m black
-        id: black
-        language: system
-        name: black
-        types:
-          - python
-      - entry: pipenv run python -m isort --filter-files
-        id: isort
-        language: system
-        name: isort
-        require_serial: true
-        types_or:
-          - cython
-          - pyi
-          - python
       - entry: make mypy
         id: mypy
         language: system
@@ -71,12 +56,22 @@ repos:
         require_serial: true
         types:
           - python
-      - entry: pipenv run python -m ruff --force-exclude
+      - entry: pipenv run python -m ruff check --force-exclude
         id: ruff
         language: system
         name: ruff
-        types:
+        require_serial: true
+        types_or:
+          - python
+          - pyi
+      - entry: pipenv run python -m ruff format --check --force-exclude
+        id: ruff-format
+        language: system
+        name: ruff-format
+        require_serial: true
+        types_or:
           - python
+          - pyi
       - entry: pipenv run toml-sort
         id: toml-sort
         language: system