Formatting: black -> ruff format (#506)

Retain the formatting style of black while eliminating a dev dependency
by using our existing rust-based ruff linter.

See also: https://docs.astral.sh/ruff/formatter/

Author: tony

.github/workflows/tests.yml

@@ -51,8 +51,10 @@ jobs:
           poetry install -E "test coverage lint"
 
       - name: Lint with ruff
-        run: |
-          poetry run ruff .
+        run: poetry run ruff .
+
+      - name: Format with ruff
+        run: poetry run ruff format . --check
 
       - name: Lint with mypy
         run: poetry run mypy .

.vim/.vim/coc-settings.json

@@ -0,0 +1,19 @@
+{
+  "[markdown][python]": {
+    "coc.preferences.formatOnSave": true
+  },
+  "python.analysis.autoSearchPaths": true,
+  "python.analysis.typeCheckingMode": "basic",
+  "python.analysis.useLibraryCodeForTypes": true,
+  "python.formatting.provider": "ruff",
+  "python.linting.ruffEnabled": true,
+  "python.linting.mypyEnabled": true,
+  "python.linting.flake8Enabled": false,
+  "python.linting.pyflakesEnabled": false,
+  "python.linting.pycodestyleEnabled": false,
+  "python.linting.banditEnabled": false,
+  "python.linting.pylamaEnabled": false,
+  "python.linting.pylintEnabled": false,
+  "pyright.organizeimports.provider": "ruff",
+  "pyright.testing.provider": "pytest",
+}

.vim/coc-settings.json

@@ -0,0 +1,19 @@
+{
+  "[markdown][python]": {
+    "coc.preferences.formatOnSave": true
+  },
+  "python.analysis.autoSearchPaths": true,
+  "python.analysis.typeCheckingMode": "basic",
+  "python.analysis.useLibraryCodeForTypes": true,
+  "python.formatting.provider": "ruff",
+  "python.linting.ruffEnabled": true,
+  "python.linting.mypyEnabled": true,
+  "python.linting.flake8Enabled": false,
+  "python.linting.pyflakesEnabled": false,
+  "python.linting.pycodestyleEnabled": false,
+  "python.linting.banditEnabled": false,
+  "python.linting.pylamaEnabled": false,
+  "python.linting.pylintEnabled": false,
+  "pyright.organizeimports.provider": "ruff",
+  "pyright.testing.provider": "pytest",
+}

CHANGES

@@ -28,6 +28,12 @@ $ pip install --user --upgrade --pre libtmux
 ### Development
 
 - Poetry 1.5.1 -> 1.6.1 (#497)
+- Move formatting from `black` to [`ruff format`] (#506)
+
+  This retains the same formatting style of `black` while eliminating a
+  dev dependency by using our existing rust-based `ruff` linter.
+
+  [`ruff format`]: https://docs.astral.sh/ruff/formatter/
 
 ## libtmux 0.23.2 (2023-09-09)
 

Makefile

@@ -38,8 +38,8 @@ serve_docs:
 dev_docs:
 	$(MAKE) -j watch_docs serve_docs
 
-black:
-	poetry run black `${PY_FILES}`
+ruff_format:
+	poetry run ruff format .
 
 ruff:
 	poetry run ruff .

docs/developing.md

@@ -54,86 +54,84 @@ Rebuild docs and run server via one terminal: `make dev_docs` (requires above, a
 
 ## Linting
 
-### black
+### ruff
 
-[black] is used for formatting.
+The project uses [ruff] to handles formatting, sorting imports and linting.
 
 ````{tab} Command
 
 poetry:
 
 ```console
-$ poetry run black .
+$ poetry run ruff
 ```
 
 If you setup manually:
 
 ```console
-$ black .
+$ ruff .
 ```
 
 ````
 
 ````{tab} make
 
 ```console
-$ make black
+$ make ruff
 ```
 
 ````
 
-In the future, `ruff` (below) may replace black as formatter.
+````{tab} Watch
 
-### ruff
+```console
+$ make watch_ruff
+```
 
-The project uses [ruff] to handles formatting, sorting imports and linting.
+requires [`entr(1)`].
 
-````{tab} Command
+````
+
+````{tab} Fix files
 
 poetry:
 
 ```console
-$ poetry run ruff
+$ poetry run ruff . --fix
 ```
 
 If you setup manually:
 
 ```console
-$ ruff .
+$ ruff . --fix
 ```
 
 ````
 
-````{tab} make
+#### ruff format
 
-```console
-$ make ruff
-```
+[ruff format] is used for formatting.
 
-````
+````{tab} Command
 
-````{tab} Watch
+poetry:
 
 ```console
-$ make watch_ruff
+$ poetry run ruff format .
 ```
 
-requires [`entr(1)`].
-
-````
-
-````{tab} Fix files
-
-poetry:
+If you setup manually:
 
 ```console
-$ poetry run ruff . --fix
+$ ruff format .
 ```
 
-If you setup manually:
+````
+
+````{tab} make
 
 ```console
-$ ruff . --fix
+$ make ruff_format
 ```
 
 ````
@@ -236,6 +234,6 @@ Update `__version__` in `__about__.py` and `pyproject.toml`::
 [poetry]: https://python-poetry.org/
 [entr(1)]: http://eradman.com/entrproject/
 [`entr(1)`]: http://eradman.com/entrproject/
-[black]: https://github.com/psf/black
+[ruff format]: https://docs.astral.sh/ruff/formatter/
 [ruff]: https://ruff.rs
 [mypy]: http://mypy-lang.org/

poetry.lock

@@ -73,7 +73,6 @@ coverage = "*"
 pytest-cov = "*"
 
 ### Format ###
-black = "*"
 ruff = "*"
 mypy = "*"
 
@@ -93,7 +92,7 @@ docs = [
 ]
 test = ["pytest", "pytest-rerunfailures", "pytest-mock", "pytest-watcher"]
 coverage = ["codecov", "coverage", "pytest-cov"]
-lint = ["black", "ruff", "mypy"]
+lint = ["ruff", "mypy"]
 
 [tool.poetry.plugins.pytest11]
 libtmux = "libtmux.pytest_plugin"