rename unfold to generate (#10770)

# Description

This PR renames the `unfold` command to `generate`.
closes #10760

# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->

# 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` to
check that you're using the standard code style
- `cargo test --workspace` to check that all tests pass (on Windows make
sure to [enable developer
mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging))
- `cargo run -- -c "use std testing; testing run-tests --path
crates/nu-std"` to run the tests for the standard library

> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```
-->

# 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.
-->
This commit is contained in:
Darren Schroeder
2023-10-19 09:30:34 -05:00
committed by GitHub
parent b907939916
commit adb99938f7
5 changed files with 34 additions and 34 deletions

View File

@ -382,7 +382,7 @@ pub fn add_shell_command_context(mut engine_state: EngineState) -> EngineState {
Seq,
SeqDate,
SeqChar,
Unfold,
Generate,
};
// Hash

View File

@ -1,23 +1,22 @@
use itertools::unfold;
use nu_engine::{eval_block_with_early_return, CallExt};
use nu_protocol::ast::Call;
use nu_protocol::engine::{Closure, Command, EngineState, Stack};
use nu_protocol::{
ast::Call,
engine::{Closure, Command, EngineState, Stack},
Category, Example, IntoInterruptiblePipelineData, IntoPipelineData, PipelineData, ShellError,
Signature, Span, Spanned, SyntaxShape, Type, Value,
};
#[derive(Clone)]
pub struct Unfold;
pub struct Generate;
impl Command for Unfold {
impl Command for Generate {
fn name(&self) -> &str {
"unfold"
"generate"
}
fn signature(&self) -> Signature {
Signature::build("unfold")
Signature::build("generate")
.input_output_types(vec![
(Type::Nothing, Type::List(Box::new(Type::Any))),
(
@ -48,13 +47,13 @@ used as the next argument to the closure, otherwise generation stops.
}
fn search_terms(&self) -> Vec<&str> {
vec!["generate", "stream"]
vec!["unfold", "stream", "yield", "expand"]
}
fn examples(&self) -> Vec<Example> {
vec![
Example {
example: "unfold 0 {|i| if $i <= 10 { {out: $i, next: ($i + 2)} }}",
example: "generate 0 {|i| if $i <= 10 { {out: $i, next: ($i + 2)} }}",
description: "Generate a sequence of numbers",
result: Some(Value::list(
vec![
@ -69,7 +68,7 @@ used as the next argument to the closure, otherwise generation stops.
)),
},
Example {
example: "unfold [0, 1] {|fib| {out: $fib.0, next: [$fib.1, ($fib.0 + $fib.1)]} } | first 10",
example: "generate [0, 1] {|fib| {out: $fib.0, next: [$fib.1, ($fib.0 + $fib.1)]} } | first 10",
description: "Generate a stream of fibonacci numbers",
result: Some(Value::list(
vec![
@ -226,6 +225,6 @@ mod test {
fn test_examples() {
use crate::test_examples;
test_examples(Unfold {})
test_examples(Generate {})
}
}

View File

@ -1,11 +1,11 @@
mod cal;
mod generate;
mod seq;
mod seq_char;
mod seq_date;
mod unfold;
pub use cal::Cal;
pub use generate::Generate;
pub use seq::Seq;
pub use seq_char::SeqChar;
pub use seq_date::SeqDate;
pub use unfold::Unfold;