From a7aa3caaaee1a54a749121ccbff3aa73f56b7137 Mon Sep 17 00:00:00 2001 From: konsti Date: Mon, 31 Jul 2023 20:33:12 +0200 Subject: [PATCH] Rename formatter_progress to formatter_ecosystem_checks (#6194) Rename the `scripts/formatter_progress.sh` to `formatter/formatter_ecosysytem_checks.sh` since it fits the actual task better. --- .github/workflows/ci.yaml | 2 +- crates/ruff_python_formatter/README.md | 13 +++++++------ ...er_progress.sh => formatter_ecosystem_checks.sh} | 0 3 files changed, 8 insertions(+), 7 deletions(-) rename scripts/{formatter_progress.sh => formatter_ecosystem_checks.sh} (100%) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index d934768a47..487de99d85 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -335,7 +335,7 @@ jobs: - name: "Cache rust" uses: Swatinem/rust-cache@v2 - name: "Formatter progress" - run: scripts/formatter_progress.sh + run: scripts/formatter_ecosystem_checks.sh - name: "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 diff --git a/crates/ruff_python_formatter/README.md b/crates/ruff_python_formatter/README.md index af3562987a..6c7ecc6cca 100644 --- a/crates/ruff_python_formatter/README.md +++ b/crates/ruff_python_formatter/README.md @@ -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. -You can check the black compatibility on a number of projects using `scripts/formatter_progress`. -It will print the similarity index, the percentage of lines that remains unchanged between black's -formatting and our formatting. You could compute it as the number of neutral lines in a diff divided -by the neutral plus the removed lines. It also checks for common problems such unstable formatting, -internal formatter errors and printing invalid syntax. We 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. +You can check the black compatibility on a number of projects using +`scripts/formatter_ecosystem_checks.sh`. It will print the similarity index, the percentage of lines +that remains unchanged between black's formatting and our formatting. You could compute it as the +number of neutral lines in a diff divided by the neutral plus the removed lines. It also checks for +common problems such unstable formatting, internal formatter errors and printing invalid syntax. We +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. diff --git a/scripts/formatter_progress.sh b/scripts/formatter_ecosystem_checks.sh similarity index 100% rename from scripts/formatter_progress.sh rename to scripts/formatter_ecosystem_checks.sh