mirror of
https://github.com/nushell/nushell.git
synced 2025-04-29 07:34:28 +02:00
1867bb1a88
# Description
Possible fix of #11456
This PR fixes a bug where builtin commands did not respect the logic of
dynamically passed boolean flags. The reason is
[has_flag](6f59abaf43/crates/nu-protocol/src/ast/call.rs (L204C5-L212C6))
method did not evaluate and take into consideration expression used with
flag.
To address this issue a solution is proposed:
1. `has_flag` method is moved to `CallExt` and new logic to evaluate
expression and check if it is a boolean value is added
2. `has_flag_const` method is added to `CallExt` which is a constant
version of `has_flag`
3. `has_named` method is added to `Call` which is basically the old
logic of `has_flag`
4. All usages of `has_flag` in code are updated, mostly to pass
`engine_state` and `stack` to new `has_flag`. In `run_const` commands it
is replaced with `has_flag_const`. And in a few select places: parser,
`to nuon` and `into string` old logic via `has_named` is used.
# User-Facing Changes
Explicit values of boolean flags are now respected in builtin commands.
Before:
After:
Another example:
Before:
After:
# Tests + Formatting
Added test reproducing some variants of original issue.
71 lines
2.3 KiB
Rust
71 lines
2.3 KiB
Rust
mod char_;
|
|
mod detect_columns;
|
|
mod encode_decode;
|
|
mod format;
|
|
mod parse;
|
|
mod split;
|
|
mod str_;
|
|
|
|
pub use char_::Char;
|
|
pub use detect_columns::*;
|
|
pub use encode_decode::*;
|
|
pub use format::*;
|
|
use nu_engine::CallExt;
|
|
pub use parse::*;
|
|
pub use split::*;
|
|
pub use str_::*;
|
|
|
|
use nu_protocol::{
|
|
ast::Call,
|
|
engine::{EngineState, Stack, StateWorkingSet},
|
|
ShellError,
|
|
};
|
|
|
|
// For handling the grapheme_cluster related flags on some commands.
|
|
// This ensures the error messages are consistent.
|
|
pub fn grapheme_flags(
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
) -> Result<bool, ShellError> {
|
|
let g_flag = call.has_flag(engine_state, stack, "grapheme-clusters")?;
|
|
// Check for the other flags and produce errors if they exist.
|
|
// Note that Nushell already prevents nonexistent flags from being used with commands,
|
|
// so this function can be reused for both the --utf-8-bytes commands and the --code-points commands.
|
|
if g_flag && call.has_flag(engine_state, stack, "utf-8-bytes")? {
|
|
Err(ShellError::IncompatibleParametersSingle {
|
|
msg: "Incompatible flags: --grapheme-clusters (-g) and --utf-8-bytes (-b)".to_string(),
|
|
span: call.head,
|
|
})?
|
|
}
|
|
if g_flag && call.has_flag(engine_state, stack, "code-points")? {
|
|
Err(ShellError::IncompatibleParametersSingle {
|
|
msg: "Incompatible flags: --grapheme-clusters (-g) and --utf-8-bytes (-b)".to_string(),
|
|
span: call.head,
|
|
})?
|
|
}
|
|
// Grapheme cluster usage is decided by the non-default -g flag
|
|
Ok(g_flag)
|
|
}
|
|
|
|
// Const version of grapheme_flags
|
|
pub fn grapheme_flags_const(
|
|
working_set: &StateWorkingSet,
|
|
call: &Call,
|
|
) -> Result<bool, ShellError> {
|
|
let g_flag = call.has_flag_const(working_set, "grapheme-clusters")?;
|
|
if g_flag && call.has_flag_const(working_set, "utf-8-bytes")? {
|
|
Err(ShellError::IncompatibleParametersSingle {
|
|
msg: "Incompatible flags: --grapheme-clusters (-g) and --utf-8-bytes (-b)".to_string(),
|
|
span: call.head,
|
|
})?
|
|
}
|
|
if g_flag && call.has_flag_const(working_set, "code-points")? {
|
|
Err(ShellError::IncompatibleParametersSingle {
|
|
msg: "Incompatible flags: --grapheme-clusters (-g) and --utf-8-bytes (-b)".to_string(),
|
|
span: call.head,
|
|
})?
|
|
}
|
|
Ok(g_flag)
|
|
}
|