mirror of
https://github.com/nushell/nushell.git
synced 2025-05-15 15:34:32 +02:00
99076af18b
# Description _(Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes.)_ I opened this PR to unify the run command method. It's mainly to improve consistency across the tree. # User-Facing Changes None. # Tests + Formatting Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass # After Submitting If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date.
107 lines
2.5 KiB
Rust
107 lines
2.5 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(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 {})
|
|
}
|
|
}
|