File tree Expand file tree Collapse file tree 1 file changed +27
-29
lines changed Expand file tree Collapse file tree 1 file changed +27
-29
lines changed Original file line number Diff line number Diff line change @@ -329,86 +329,84 @@ this will load the `.tmuxp.yaml` in the root of the project.
329
329
330
330
## Formatting
331
331
332
- ### black
332
+ ### ruff
333
333
334
- [ black ] is used for formatting.
334
+ The project uses [ ruff ] to handles formatting, sorting imports and linting .
335
335
336
336
```` {tab} Command
337
337
338
338
poetry:
339
339
340
340
```console
341
- $ poetry run black .
341
+ $ poetry run ruff
342
342
```
343
343
344
344
If you setup manually:
345
345
346
346
```console
347
- $ black .
347
+ $ ruff .
348
348
```
349
349
350
350
````
351
351
352
352
```` {tab} make
353
353
354
354
```console
355
- $ make black
355
+ $ make ruff
356
356
```
357
357
358
358
````
359
359
360
- In the future, ` ruff ` (below) may replace black as formatter.
360
+ ```` {tab} Watch
361
361
362
- ### ruff
362
+ ```console
363
+ $ make watch_ruff
364
+ ```
363
365
364
- The project uses [ ruff ] to handles formatting, sorting imports and linting .
366
+ requires [`entr(1)`] .
365
367
366
- ```` {tab} Command
368
+ ````
369
+
370
+ ```` {tab} Fix files
367
371
368
372
poetry:
369
373
370
374
```console
371
- $ poetry run ruff
375
+ $ poetry run ruff . --fix
372
376
```
373
377
374
378
If you setup manually:
375
379
376
380
```console
377
- $ ruff .
381
+ $ ruff . --fix
378
382
```
379
383
380
384
````
381
385
382
- ```` {tab} make
386
+ #### ruff format
383
387
384
- ```console
385
- $ make ruff
386
- ```
388
+ [ ruff format] is used for formatting.
387
389
388
- ````
390
+ ```` {tab} Command
389
391
390
- ```` {tab} Watch
392
+ poetry:
391
393
392
394
```console
393
- $ make watch_ruff
395
+ $ poetry run ruff format .
394
396
```
395
397
396
- requires [`entr(1)`].
397
-
398
- ````
399
-
400
- ```` {tab} Fix files
401
-
402
- poetry:
398
+ If you setup manually:
403
399
404
400
```console
405
- $ poetry run ruff . --fix
401
+ $ ruff format .
406
402
```
407
403
408
- If you setup manually:
404
+ ````
405
+
406
+ ```` {tab} make
409
407
410
408
```console
411
- $ ruff . --fix
409
+ $ make ruff_format
412
410
```
413
411
414
412
````
@@ -467,7 +465,7 @@ the [gh build site].
467
465
[ entr ] : http://entrproject.org/
468
466
[ `entr(1)` ] : http://entrproject.org/
469
467
[ ruff ] : https://ruff.rs
470
- [ black ] : https://github.com/psf/black
468
+ [ ruff format ] : https://docs.astral.sh/ruff/formatter/
471
469
[ mypy ] : http://mypy-lang.org/
472
470
[ github actions ] : https://github.com/features/actions
473
471
[ gh build site ] : https://github.com/tmux-python/tmuxp/actions?query=workflow%3Atests
You can’t perform that action at this time.
0 commit comments