Skip to content

Commit

Permalink
make grid throw an error when not enough columns (nushell#12672)
Browse files Browse the repository at this point in the history
<!--
if this PR closes one or more issues, you can automatically link the PR
with
them by using one of the [*linking
keywords*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword),
e.g.
- this PR should close #xxxx
- fixes #xxxx

you can also mention related issues, PRs or discussions!
-->

# Description
<!--
Thank you for improving Nushell. Please, check our [contributing
guide](../CONTRIBUTING.md) and talk to the core team before making major
changes.

Description of your pull request goes here. **Provide examples and/or
screenshots** if your changes affect the user experience.
-->

Resolves nushell#12654. 

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

`grid` can now throw an error.

# 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
> ```
-->

Added relevant test.
  • Loading branch information
merelymyself committed Apr 26, 2024
1 parent 822c434 commit d23a373
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 8 deletions.
19 changes: 11 additions & 8 deletions crates/nu-command/src/viewers/griddle.rs
Original file line number Diff line number Diff line change
Expand Up @@ -233,14 +233,17 @@ fn create_grid_output(
}
}

Ok(
if let Some(grid_display) = grid.fit_into_width(cols as usize) {
Value::string(grid_display.to_string(), call.head)
} else {
Value::string(format!("Couldn't fit grid into {cols} columns!"), call.head)
}
.into_pipeline_data(),
)
if let Some(grid_display) = grid.fit_into_width(cols as usize) {
Ok(Value::string(grid_display.to_string(), call.head).into_pipeline_data())
} else {
Err(ShellError::GenericError {
error: format!("Couldn't fit grid into {cols} columns"),
msg: "too few columns to fit the grid into".into(),
span: Some(call.head),
help: Some("try rerunning with a different --width".into()),
inner: Vec::new(),
})
}
}

#[allow(clippy::type_complexity)]
Expand Down
8 changes: 8 additions & 0 deletions crates/nu-command/tests/commands/griddle.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
use nu_test_support::nu;

#[test]
fn grid_errors_with_few_columns() {
let actual = nu!("[1 2 3 4 5] | grid --width 5");

assert!(actual.err.contains("Couldn't fit grid into 5 columns"));
}
1 change: 1 addition & 0 deletions crates/nu-command/tests/commands/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ mod format;
mod generate;
mod get;
mod glob;
mod griddle;
mod group_by;
mod hash_;
mod headers;
Expand Down

0 comments on commit d23a373

Please sign in to comment.