Skip to content

Commit 8647448

Browse files
committed
docs(developing): Use ruff format
1 parent d31eedd commit 8647448

File tree

1 file changed

+27
-29
lines changed

1 file changed

+27
-29
lines changed

docs/developing.md

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -329,86 +329,84 @@ this will load the `.tmuxp.yaml` in the root of the project.
329329

330330
## Formatting
331331

332-
### black
332+
### ruff
333333

334-
[black] is used for formatting.
334+
The project uses [ruff] to handles formatting, sorting imports and linting.
335335

336336
````{tab} Command
337337
338338
poetry:
339339
340340
```console
341-
$ poetry run black .
341+
$ poetry run ruff
342342
```
343343
344344
If you setup manually:
345345
346346
```console
347-
$ black .
347+
$ ruff .
348348
```
349349
350350
````
351351

352352
````{tab} make
353353
354354
```console
355-
$ make black
355+
$ make ruff
356356
```
357357
358358
````
359359

360-
In the future, `ruff` (below) may replace black as formatter.
360+
````{tab} Watch
361361
362-
### ruff
362+
```console
363+
$ make watch_ruff
364+
```
363365
364-
The project uses [ruff] to handles formatting, sorting imports and linting.
366+
requires [`entr(1)`].
365367
366-
````{tab} Command
368+
````
369+
370+
````{tab} Fix files
367371
368372
poetry:
369373
370374
```console
371-
$ poetry run ruff
375+
$ poetry run ruff . --fix
372376
```
373377
374378
If you setup manually:
375379
376380
```console
377-
$ ruff .
381+
$ ruff . --fix
378382
```
379383
380384
````
381385

382-
````{tab} make
386+
#### ruff format
383387

384-
```console
385-
$ make ruff
386-
```
388+
[ruff format] is used for formatting.
387389

388-
````
390+
````{tab} Command
389391
390-
````{tab} Watch
392+
poetry:
391393
392394
```console
393-
$ make watch_ruff
395+
$ poetry run ruff format .
394396
```
395397
396-
requires [`entr(1)`].
397-
398-
````
399-
400-
````{tab} Fix files
401-
402-
poetry:
398+
If you setup manually:
403399
404400
```console
405-
$ poetry run ruff . --fix
401+
$ ruff format .
406402
```
407403
408-
If you setup manually:
404+
````
405+
406+
````{tab} make
409407
410408
```console
411-
$ ruff . --fix
409+
$ make ruff_format
412410
```
413411
414412
````
@@ -467,7 +465,7 @@ the [gh build site].
467465
[entr]: http://entrproject.org/
468466
[`entr(1)`]: http://entrproject.org/
469467
[ruff]: https://ruff.rs
470-
[black]: https://github.com/psf/black
468+
[ruff format]: https://docs.astral.sh/ruff/formatter/
471469
[mypy]: http://mypy-lang.org/
472470
[github actions]: https://github.com/features/actions
473471
[gh build site]: https://github.com/tmux-python/tmuxp/actions?query=workflow%3Atests

0 commit comments

Comments
 (0)