remove black as dev dependency and upgrade ruff

Author: elfkuzco

.pre-commit-config.yaml

@@ -6,14 +6,13 @@ repos:
   hooks:
   -   id: trailing-whitespace
   -   id: end-of-file-fixer
-- repo: https://github.com/psf/black
-  rev: "24.4.2"
-  hooks:
-  -   id: black
+
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.5.1
+  rev: v0.15.12
   hooks:
-  - id: ruff
+    - id: ruff-check
+    - id: ruff-format
+
 - repo: https://github.com/RobertCraigie/pyright-python
   rev: v1.1.370
   hooks:

CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+- Remove `black` from `pyproject.toml` and `tasks.py`
+- Upgrade `ruff` to `0.15.12`
+
 ### Changed
 
 - Upgrade Docker image to use python:3.12-slim-bookworm

docs/Developer-Setup.md

@@ -49,7 +49,6 @@ The key part is the symlink to `.venv` so that LSP-pyright and other tool can au
 - When doing some JS, you obviously need a Node.JS as well 
 - [hatch](https://pypi.org/project/hatch/) installed globally
 - [Visual Studio Code](https://github.com/microsoft/vscode) with following extensions (more or less related to Python development)
-  - Black Formater (Microsoft)
   - Dev Containers (Microsoft)
   - Docker (Microsoft)
   - Excalidraw (pomdtr)
@@ -77,12 +76,6 @@ This additional Hatch config section ensures that all virtual environments (the
 On every project, create a local `.vscode/settings.json` to automatically format your code (adjust `typeCheckingMode` depending on your project):
 ``` json
 {
-  "[python]": {
-    "editor.defaultFormatter": "ms-python.black-formatter",
-    "editor.codeActionsOnSave": {
-      "source.organizeImports": "explicit"
-    }
-  },
   "python.analysis.typeCheckingMode": "strict",
   "eslint.validate": ["javascript", "typescript", "vue"],
   "eslint.workingDirectories": [{ "mode": "auto" }],

docs/pyproject.toml.md

@@ -20,12 +20,12 @@ Version must be dynamic and set once in code. `module.__about__` usually.
 
 ### Linting
 
-- Black (latest available version)
+- Ruff (latest available version)
 - Ruff for import sorting (isort-like) and many other checks
 - Dedicated hatch environment
-- Black and ruff configuration so those works without hatch as well
-- Scripts for just black and just ruff checking
-- Scripts for black fixing and ruf fixing (accepts params)
+- Ruff configuration so those works without hatch as well
+- Scripts for just ruff checking
+- Scripts for ruff fixing (accepts params)
 - Scripts for global checking and fixing
 - Sample ruff configuration
 
@@ -42,4 +42,4 @@ Version must be dynamic and set once in code. `module.__about__` usually.
 - Dedicated hatch environment
 - Hatch environment matrix to easily tests on multiple python versions
 - pytest and coverage configuration so those works without hatch as well
-- Scripts for running tests (accepts params), running with coverage and reporting
+- Scripts for running tests (accepts params), running with coverage and reporting

pyproject.toml

@@ -20,8 +20,7 @@ scripts = [
   "invoke==2.2.0",
 ]
 lint = [
-  "black==24.4.2",
-  "ruff==0.5.1",
+  "ruff==0.15.12",
 ]
 check = [
   "pyright==1.1.370",
@@ -75,10 +74,8 @@ skip-install = false
 features = ["scripts", "lint"]
 
 [tool.hatch.envs.lint.scripts]
-black = "inv lint-black --args '{args}'"
 ruff = "inv lint-ruff --args '{args}'"
 all = "inv lintall --args '{args}'"
-fix-black = "inv fix-black --args '{args}'"
 fix-ruff = "inv fix-ruff --args '{args}'"
 fixall = "inv fixall --args '{args}'"
 
@@ -89,9 +86,6 @@ features = ["scripts", "check"]
 pyright = "inv check-pyright --args '{args}'"
 all = "inv checkall --args '{args}'"
 
-[tool.black]
-line-length = 88
-target-version = ['py311']
 
 [tool.ruff]
 target-version = "py312"

tasks.py

@@ -42,11 +42,6 @@ def coverage(ctx: Context, args: str = "", *, html: bool = False):
     report_cov(ctx, html=html)
 
 
-@task(optional=["args"], help={"args": "black additional arguments"})
-def lint_black(ctx: Context, args: str = "."):
-    args = args or "."  # needed for hatch script
-    ctx.run("black --version", pty=use_pty)
-    ctx.run(f"black --check --diff {args}", pty=use_pty)
 
 
 @task(optional=["args"], help={"args": "ruff additional arguments"})
@@ -59,13 +54,12 @@ def lint_ruff(ctx: Context, args: str = "."):
 @task(
     optional=["args"],
     help={
-        "args": "linting tools (black, ruff) additional arguments, typically a path",
+        "args": "linting tools (ruff) additional arguments, typically a path",
     },
 )
 def lintall(ctx: Context, args: str = "."):
     """Check linting"""
     args = args or "."  # needed for hatch script
-    lint_black(ctx, args)
     lint_ruff(ctx, args)
 
 
@@ -82,11 +76,6 @@ def checkall(ctx: Context, args: str = ""):
     check_pyright(ctx, args)
 
 
-@task(optional=["args"], help={"args": "black additional arguments"})
-def fix_black(ctx: Context, args: str = "."):
-    """fix black formatting"""
-    args = args or "."  # needed for hatch script
-    ctx.run(f"black {args}", pty=use_pty)
 
 
 @task(optional=["args"], help={"args": "ruff additional arguments"})
@@ -99,12 +88,11 @@ def fix_ruff(ctx: Context, args: str = "."):
 @task(
     optional=["args"],
     help={
-        "args": "linting tools (black, ruff) additional arguments, typically a path",
+        "args": "linting tools ( ruff) additional arguments, typically a path",
     },
 )
 def fixall(ctx: Context, args: str = "."):
     """Fix everything automatically"""
     args = args or "."  # needed for hatch script
-    fix_black(ctx, args)
     fix_ruff(ctx, args)
     lintall(ctx, args)