mirror of
https://github.com/astral-sh/ruff.git
synced 2025-08-04 02:39:12 +00:00
Document ruff_dev and format_dev (#5648)
## Summary Document all `ruff_dev` subcommands and document the `format_dev` flags in the formatter readme. CC @zanieb please flag everything that isn't clear or missing ## Test Plan n/a
This commit is contained in:
parent
5665968b42
commit
f0aa6bd4d3
5 changed files with 145 additions and 2 deletions
|
@ -276,6 +276,14 @@ python scripts/check_ecosystem.py --checkouts target/checkouts --projects github
|
|||
cargo run --bin ruff_dev -- format-dev --stability-check --multi-project target/checkouts
|
||||
```
|
||||
|
||||
Compared to `ruff check`, `cargo run --bin ruff_dev -- format-dev` has 4 additional options:
|
||||
|
||||
- `--write`: Format the files and write them back to disk
|
||||
- `--stability-check`: Format twice (but don't write to disk) and check for differences and crashes
|
||||
- `--multi-project`: Treat every subdirectory as a separate project. Useful for ecosystem checks.
|
||||
- `--error-file`: Use together with `--multi-project`, this writes all errors (but not status
|
||||
messages) to a file.
|
||||
|
||||
## The orphan rules and trait structure
|
||||
|
||||
For the formatter, we would like to implement `Format` from the rust_formatter crate for all AST
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue