README.md

ecosystem-check

Compare format results for two different executable versions (e.g. main and a PR) on real world projects.

Usage

 # debug build vs system djangofmt
just ecosystem-check <baseline executable> <comparison executable>

Note executable paths may be absolute, relative to the root git directory, or will be looked up in the current Python environment and PATH.

Run djangofmt ecosystem checks comparing your debug build to your system djangofmt:

just ecosystem-check-dev

Run djangofmt ecosystem checks comparing with changes to code that is already formatted:

just ecosystem-check djangofmt ./target/debug/djangofmt --format-comparison base-then-comp

The default output format is markdown, which includes nice summaries of the changes. You can use --output-format json to display the raw data — this is particularly useful when making changes to the ecosystem checks.

Development

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

just ecosystem-check djangofmt ./target/debug/djangofmt --pdb