🐛 Running biome --version exits with failure

[nhedger]

Environment information

CLI:
  Version:                      1.2.0
  Color support:                true

Platform:
  CPU Architecture:             x86_64
  OS:                           macos

Environment:
  BIOME_LOG_DIR:                unset
  NO_COLOR:                     unset
  TERM:                         "xterm-256color"
  JS_RUNTIME_VERSION:           unset
  JS_RUNTIME_NAME:              unset
  NODE_PACKAGE_MANAGER:         unset

Biome Configuration:
  Status:                       unset

Workspace:
  Open Documents:               0

Discovering running Biome servers...

What happened?

1. Run biome --version
2. See that the version is in the output
3. Check the exit code by running echo $?
4. See that the printed exit code is 1 (failure)

Expected result

Running biome --version should exit with code 0.

Code of Conduct

• I agree to follow Biome's Code of Conduct

[nhedger]

To keep in mind:

When this is fixed, we should update the test block of biome's homebrew formula to check for exit code 0 instead of exit code 1.

[b4s36t4]

I tried to debug it, it only happens with root command when I pass options like (--version, --help). The result of command of type Err which I'm thinking coming from bpaf.

biome/crates/biome_cli/src/main.rs

Line 31 in 59acbfd

let command = biome_command().run_inner(Args::current_args());

[nhedger]

Looks like it's hardcoded: https://github.com/pacak/bpaf/blob/8a948b1510a73fd61f6aeb58c427edcfadab5c11/src/info.rs#L285

[ematipico]

@nhedger should we file an issue upstream?

[nhedger]

Turns out we might be doing something wrong. I'll explain in details later today.

[nhedger]

This will feel counter-intuitive, but I think the problem lies in the following code.

biome/crates/biome_cli/src/main.rs

Lines 32 to 59 in 55f740c

	match command {
	Ok(command) => {
	let color_mode = to_color_mode(command.get_color());
	console.set_color(color_mode);
	let is_verbose = command.is_verbose();
	let result = run_workspace(&mut console, command);
	match result {
	Err(termination) => {
	console.error(markup! {
	{if is_verbose { PrintDiagnostic::verbose(&termination) } else { PrintDiagnostic::simple(&termination) }}
	});
	termination.report()
	}
	Ok(_) => ExitCode::SUCCESS,
	}
	}
	Err(failure) => {
	return if let ParseFailure::Stdout(help, _) = &failure {
	console.log(markup! {{help.to_string()}});
	ExitCode::FAILURE
	} else {
	let diagnostic = CliDiagnostic::parse_error_bpaf(failure);
	console.error(markup! { {PrintDiagnostic::simple(&diagnostic)}});
	ExitCode::FAILURE
	}
	}
	}

Specifically, the part where we're handling the failures.

biome/crates/biome_cli/src/main.rs

Lines 49 to 58 in 55f740c

	Err(failure) => {
	return if let ParseFailure::Stdout(help, _) = &failure {
	console.log(markup! {{help.to_string()}});
	ExitCode::FAILURE
	} else {
	let diagnostic = CliDiagnostic::parse_error_bpaf(failure);
	console.error(markup! { {PrintDiagnostic::simple(&diagnostic)}});
	ExitCode::FAILURE
	}
	}

At line 52, we return Exit::FAILURE if the failure is of the Stdout variant of the ParseFailure enumeration.

According to the documentation of that enum, the Stdout variant means

Print this to stdout and exit with success code

I believe returning Exit::SUCCESS would be correct and would solve the issue.

[ematipico]

Good find, that should be easy to fix then!

[nhedger]

Yep, I'll take care of it later today.

[b4s36t4]

@nhedger But why does only --version commands do throw Err while other commands are giving Ok types? My point is if the return type is Err that's actually err right? it doesn't matter how are we handling it? Maybe an upstream or version update(if any) could solve this.

[pacak]

But why does only --version commands do throw Err while other commands are giving Ok types?

bpaf uses Ok when it produces a value parser is designed to produce - Options, otherwise it produces Err with one of 3 variants - "print this to stderr and exit with failure" and two different "print this to stdout and exit with success", one supports formatting and one doesn't. I'll see if I can improve the docs to make it clearer...

[nhedger]

Thanks for clarifying @pacak, much appreciated.