Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: adds --test flag in yr fmt #72

Closed
wants to merge 2 commits into from
Closed

feat: adds --test flag in yr fmt #72

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c339bd
feat: adds --test flag in yr fmt
shellcromancer Jan 13, 2024
d00e011
fix: output files with formatting changes
shellcromancer Mar 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions yara-x-cli/src/commands/fmt.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ use std::fs;
use std::fs::File;
use std::io::{stdin, stdout, Cursor, Seek, Write};
use std::path::PathBuf;
use std::process;

use clap::{arg, value_parser, ArgAction, ArgMatches, Command};
use yara_x_fmt::Formatter;
Expand All @@ -18,27 +19,38 @@ pub fn fmt() -> Command {
arg!(-w --write ... "Write output to source file instead of stdout")
.action(ArgAction::SetTrue),
)
.arg(
arg!(-t --test ... "Exit with failure if reformatting changed the file")
.action(ArgAction::SetTrue),
)
}

pub fn exec_fmt(args: &ArgMatches) -> anyhow::Result<()> {
let files = args.get_many::<PathBuf>("FILE");
let write = args.get_one::<bool>("write");
let test = args.get_one::<bool>("test");

let formatter = Formatter::new();

if let Some(files) = files {
for file in files {
let input = fs::read(file.as_path())?;
if *write.unwrap() {
let mut formatted = Cursor::new(Vec::new());

formatter.format(input.as_slice(), &mut formatted)?;
formatted.rewind()?;
let mut formatted = Cursor::new(Vec::new());

File::create(file.as_path())?
.write_all(formatted.into_inner().as_slice())?;
formatter.format(input.as_slice(), &mut formatted)?;
formatted.rewind()?;

let output = formatted.into_inner();

if *test.unwrap() && input != output {
process::exit(3)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Author

@shellcromancer shellcromancer Mar 3, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

image

}

if *write.unwrap() {
File::create(file.as_path())?.write_all(output.as_slice())?;
} else {
formatter.format(input.as_slice(), stdout())?;
print!("{}", String::from_utf8(output)?);
};
}
} else {
Expand Down