mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-04 02:38:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Rename ruff_python_formatter/README.md to CONTRIBUTING.md (#7065)

Browse source
This commit is contained in:
Charlie Marsh 2023-09-02 17:25:23 +01:00 • committed by GitHub
parent 45680bbb44
commit 577280c8be
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

25
crates/ruff_python_formatter/README.md → crates/ruff_python_formatter/CONTRIBUTING.md
View file

@ -1,28 +1,21 @@
# Rust Python Formatter
# Contributing to the Ruff Formatter
The goal of our formatter is to be compatible with Black except for rare edge cases (mostly
involving comment placement).
involving comment placement). This document outlines the expected development workflow for the
formatter and walks through some of its internals.
You can try an experimental version of the formatter on your project with:
## Testing your changes
```shell
cargo run --bin ruff -- format path/to/your/project
```
Note that currently the only supported option is `line-length` and that both the CLI and the
formatting are a work-in-progress and will change before the stable release.
## Dev tools
**Testing your changes** You can use the `ruff_python_formatter` binary to format individual files
and show debug info. It's fast to compile because it doesn't depend on `ruff`. The easiest way is to
create a `scratch.py` (or `scratch.pyi`) in the project root and run
You can use the `ruff_python_formatter` binary to format individual files and show debug info.
It's fast to compile because it doesn't depend on `ruff`. The easiest way is to create a
`scratch.py` (or `scratch.pyi`) in the project root and run:
```shell
cargo run --bin ruff_python_formatter -- --emit stdout scratch.py
```
which has `--print-ir` and `--print-comments` options. We especially recommend `--print-comments`.
...which supports the `--print-ir` and `--print-comments` flag. (We recommend running with
`--print-comments`.)
<details>
<summary>Usage example</summary>