62575c9a4f
Continuation of #8229 and #8326 # Description The `ShellError` enum at the moment is kind of messy. Many variants are basic tuple structs where you always have to reference the implementation with its macro invocation to know which field serves which purpose. Furthermore we have both variants that are kind of redundant or either overly broad to be useful for the user to match on or overly specific with few uses. So I set out to start fixing the lacking documentation and naming to make it feasible to critically review the individual usages and fix those. Furthermore we can decide to join or split up variants that don't seem to be fit for purpose. # Call to action **Everyone:** Feel free to add review comments if you spot inconsistent use of `ShellError` variants. # User-Facing Changes (None now, end goal more explicit and consistent error messages) # Tests + Formatting (No additional tests needed so far) # Commits (so far) - Remove `ShellError::FeatureNotEnabled` - Name fields on `SE::ExternalNotSupported` - Name field on `SE::InvalidProbability` - Name fields on `SE::NushellFailed` variants - Remove unused `SE::NushellFailedSpannedHelp` - Name field on `SE::VariableNotFoundAtRuntime` - Name fields on `SE::EnvVarNotFoundAtRuntime` - Name fields on `SE::ModuleNotFoundAtRuntime` - Remove usused `ModuleOrOverlayNotFoundAtRuntime` - Name fields on `SE::OverlayNotFoundAtRuntime` - Name field on `SE::NotFound`
107 lines
2.6 KiB
Rust
107 lines
2.6 KiB
Rust
use nu_engine::CallExt;
|
|
use nu_protocol::ast::Call;
|
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
|
use nu_protocol::{
|
|
Category, Example, PipelineData, ShellError, Signature, Spanned, SyntaxShape, Type, Value,
|
|
};
|
|
use rand::prelude::{thread_rng, Rng};
|
|
|
|
#[derive(Clone)]
|
|
pub struct SubCommand;
|
|
|
|
impl Command for SubCommand {
|
|
fn name(&self) -> &str {
|
|
"random bool"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("random bool")
|
|
.input_output_types(vec![(Type::Nothing, Type::Bool)])
|
|
.allow_variants_without_examples(true)
|
|
.named(
|
|
"bias",
|
|
SyntaxShape::Number,
|
|
"Adjusts the probability of a \"true\" outcome",
|
|
Some('b'),
|
|
)
|
|
.category(Category::Random)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Generate a random boolean value."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["generate", "boolean", "true", "false", "1", "0"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
bool(engine_state, stack, call)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Generate a random boolean value",
|
|
example: "random bool",
|
|
result: None,
|
|
},
|
|
Example {
|
|
description: "Generate a random boolean value with a 75% chance of \"true\"",
|
|
example: "random bool --bias 0.75",
|
|
result: None,
|
|
},
|
|
]
|
|
}
|
|
}
|
|
|
|
fn bool(
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let span = call.head;
|
|
let bias: Option<Spanned<f64>> = call.get_flag(engine_state, stack, "bias")?;
|
|
|
|
let mut probability = 0.5;
|
|
|
|
if let Some(prob) = bias {
|
|
probability = prob.item;
|
|
|
|
let probability_is_valid = (0.0..=1.0).contains(&probability);
|
|
|
|
if !probability_is_valid {
|
|
return Err(ShellError::InvalidProbability { span: prob.span });
|
|
}
|
|
}
|
|
|
|
let mut rng = thread_rng();
|
|
let bool_result: bool = rng.gen_bool(probability);
|
|
|
|
Ok(PipelineData::Value(
|
|
Value::Bool {
|
|
val: bool_result,
|
|
span,
|
|
},
|
|
None,
|
|
))
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(SubCommand {})
|
|
}
|
|
}
|