feat: adds --test flag in yr fmt #72
Conversation
Adds -t/--test flag in yr fmt which returns an error code if formatting made changes on the file.
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
|
Signed the Google CLA, should be ready for a maintainer review, thanks! 👍 |
yara-x-cli/src/commands/fmt.rs
Outdated
| let output = formatted.into_inner(); | ||
|
|
||
| if *test.unwrap() && input != output { | ||
| process::exit(3) |
There was a problem hiding this comment.
Why not process::exit(2)? Exit code 2 is not used for any purpose yet.
I'm also wondering if it wouldn't be better to return the path of the files that requires changes, as gofmt -l does. This provides more information to the user. If you call yr fm with multiple files, you may want to know which files are changed and which don't.
There was a problem hiding this comment.
Thank you for taking a look! I updated this to use exit code 2, and output a list of files that require changes. Here's an image of runs with and without changes required.
|
In 4b08899 I made multiple changes to the |
|
Makes sense, thanks for including the feature in your changes. 👍 |
Adds -t/--test flag in yr fmt which returns an error code if formatting made changes on the file.
This feature exists in a few other language formatting tools (jsonnet, terraform, gofmt) which is useful as part of stylistic CI/CD checks