ruff/python/ruff-ecosystem
Zanie 105fb1c682 Refactor ecosystem checks into module 2023-10-23 11:55:14 -05:00
..
ruff_ecosystem Refactor ecosystem checks into module 2023-10-23 11:55:14 -05:00
README.md Refactor ecosystem checks into module 2023-10-23 11:55:14 -05:00
pyproject.toml Refactor ecosystem checks into module 2023-10-23 11:55:14 -05:00

README.md

ruff-ecosystem

Ruff ecosystem checks.

Installation

From the Ruff project root, install with pip:

pip install -e ./python/ruff-ecosystem

Usage

ruff-ecosystem <check | format> <baseline executable> <comparison executable>

Note executable paths must be absolute or relative to the current working directory.

Run ruff check ecosystem checks comparing your debug build to your system Ruff:

ruff-ecosystem check  "$(which ruff)" "./target/debug/ruff"

Run ruff format ecosystem checks comparing your debug build to your system Ruff:

ruff-ecosystem format  "$(which ruff)" "./target/debug/ruff"

Development

When developing, it can be useful to set the --pdb flag to drop into a debugger on failure:

ruff-ecosystem check  "$(which ruff)" "./target/debug/ruff" --pdb

You can also provide a path to cache checkouts to speed up repeated runs:

ruff-ecosystem check  "$(which ruff)" "./target/debug/ruff" --cache ./repos