Change default format for ecosystem checks to markdown (#8412)

To facilitate easier local runs
This commit is contained in:
Zanie Blue 2023-11-01 16:51:33 -05:00 committed by GitHub
parent 29573daef5
commit 4d23c1fc83
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 1 deletions

View file

@ -31,6 +31,9 @@ Run `ruff format` ecosystem checks comparing your debug build to your system Ruf
ruff-ecosystem format ruff "./target/debug/ruff" ruff-ecosystem format ruff "./target/debug/ruff"
``` ```
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 ## Development
When developing, it can be useful to set the `--pdb` flag to drop into a debugger on failure: When developing, it can be useful to set the `--pdb` flag to drop into a debugger on failure:

View file

@ -121,7 +121,7 @@ def parse_args() -> argparse.Namespace:
parser.add_argument( parser.add_argument(
"--output-format", "--output-format",
choices=[option.name for option in OutputFormat], choices=[option.name for option in OutputFormat],
default="json", default="markdown",
help="Location for caching cloned repositories", help="Location for caching cloned repositories",
) )
parser.add_argument( parser.add_argument(