mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-31 15:47:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Rename formatter_progress to formatter_ecosystem_checks (#6194)

Browse source 
Rename the `scripts/formatter_progress.sh` to
`formatter/formatter_ecosysytem_checks.sh` since it fits the actual task
better.
This commit is contained in:
konsti 2023-07-31 20:33:12 +02:00 • committed by GitHub
parent e52b636da0
commit a7aa3caaae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 8 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.github/workflows/ci.yaml vendored
View file

@ -335,7 +335,7 @@ jobs:
- name: "Cache rust" - name: "Cache rust"
uses: Swatinem/rust-cache@v2 uses: Swatinem/rust-cache@v2
- name: "Formatter progress" - name: "Formatter progress"
run: scripts/formatter_progress.sh run: scripts/formatter_ecosystem_checks.sh
- name: "Github step summary" - name: "Github step summary"
run: grep "similarity index" target/progress_projects_report.txt | sort > $GITHUB_STEP_SUMMARY run: grep "similarity index" target/progress_projects_report.txt | sort > $GITHUB_STEP_SUMMARY
# CPython is not black formatted, so we run only the stability check # CPython is not black formatted, so we run only the stability check

13
crates/ruff_python_formatter/README.md
View file

@ -231,12 +231,13 @@ additional test cases in `resources/test/fixtures/ruff`.
The full Ruff test suite is slow, `cargo test -p ruff_python_formatter` is a lot faster. The full Ruff test suite is slow, `cargo test -p ruff_python_formatter` is a lot faster.
You can check the black compatibility on a number of projects using `scripts/formatter_progress`. You can check the black compatibility on a number of projects using
It will print the similarity index, the percentage of lines that remains unchanged between black's `scripts/formatter_ecosystem_checks.sh`. It will print the similarity index, the percentage of lines
formatting and our formatting. You could compute it as the number of neutral lines in a diff divided that remains unchanged between black's formatting and our formatting. You could compute it as the
by the neutral plus the removed lines. It also checks for common problems such unstable formatting, number of neutral lines in a diff divided by the neutral plus the removed lines. It also checks for
internal formatter errors and printing invalid syntax. We run this script in CI and you can view the common problems such unstable formatting, internal formatter errors and printing invalid syntax. We
results in a PR page under "Checks" > "CI" > "Summary" at the bottom of the page. run this script in CI and you can view the results in a PR page under "Checks" > "CI" > "Summary" at
the bottom of the page.
There is a `ruff_python_formatter` binary that avoid building and linking the main `ruff` crate. There is a `ruff_python_formatter` binary that avoid building and linking the main `ruff` crate.

0
scripts/formatter_progress.sh → scripts/formatter_ecosystem_checks.sh
View file