mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-07-16 01:25:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
ruff/scripts/benchmarks
History
Charlie Marsh 5849a75223
Rename ruff crate to ruff_linter (#7529)
2023-09-20 08:38:27 +02:00
..
dark.svg Re-run benchmark and update documentation (#1907) 2023-01-16 01:38:58 -05:00
graph-spec.json Re-run benchmark and update documentation (#1907) 2023-01-16 01:38:58 -05:00
light.svg Re-run benchmark and update documentation (#1907) 2023-01-16 01:38:58 -05:00
poetry.lock Add a benchmarking script for the formatter CLI (#7340) 2023-09-13 13:15:48 -04:00
pyproject.toml Add a benchmarking script for the formatter CLI (#7340) 2023-09-13 13:15:48 -04:00
README.md markdownlint: enforce 100 char max length (#4698) 2023-05-28 22:45:56 -04:00
run.sh Rename ruff crate to ruff_linter (#7529) 2023-09-20 08:38:27 +02:00
run_all.sh Rename ruff crate to ruff_linter (#7529) 2023-09-20 08:38:27 +02:00
run_comparisons.sh Rename ruff crate to ruff_linter (#7529) 2023-09-20 08:38:27 +02:00
run_formatter.sh Add a benchmarking script for the formatter CLI (#7340) 2023-09-13 13:15:48 -04:00
run_plugins.sh Rename ruff crate to ruff_linter (#7529) 2023-09-20 08:38:27 +02:00
run_silent.sh Rename ruff crate to ruff_linter (#7529) 2023-09-20 08:38:27 +02:00
setup.sh Rename ruff crate to ruff_linter (#7529) 2023-09-20 08:38:27 +02:00

README.md

benchmarks

Utilities for benchmarking Ruff.

Getting Started

Run ./scripts/benchmarks/run.sh to clone the benchmarking target (CPython).

If you're looking to benchmark Ruff against other tools, you'll also need to run poetry install to create a virtual environment with the required dependencies.

Running Benchmarks

Run ./scripts/benchmarks/run.sh to run Ruff over the target repo (CPython). The ./scripts/benchmarks folder contains a few other benchmarks (e.g., scripts/benchmarks/run_comparisons.sh compares Ruff to a variety of other tools).

Generating Plots

The Vega specification for the benchmark plot depicted in the root README can be found at scripts/benchmarks/graph-spec.json. You can render this JSON spec in the Vega Editor.

The images seen in the README are generated by exporting the rendered Vega spec as SVG (at around 688px wide) and manually bolding the Ruff title and benchmark time. The dark mode variant is generated by changing the fill from fill="#333333" to fill="#C9D1D9".