Skip to content

Commit

Permalink
Fix the output type for 'view files' (#11077)
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.
-->

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

Co-authored-by: JT <547158+jntrnr@users.noreply.github.com>
  • Loading branch information
sophiajt and sophiajt committed Nov 16, 2023
1 parent 80bee40 commit 4205edb
Showing 1 changed file with 21 additions and 6 deletions.
27 changes: 21 additions & 6 deletions crates/nu-command/src/debug/view_files.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,15 @@ impl Command for ViewFiles {

fn signature(&self) -> nu_protocol::Signature {
Signature::build("view files")
.input_output_types(vec![(Type::Nothing, Type::String)])
.input_output_types(vec![(
Type::Nothing,
Type::Table(vec![
("filename".into(), Type::String),
("start".into(), Type::Int),
("end".into(), Type::Int),
("size".into(), Type::Int),
]),
)])
.category(Category::Debug)
}

Expand Down Expand Up @@ -51,10 +59,17 @@ impl Command for ViewFiles {
}

fn examples(&self) -> Vec<Example> {
vec![Example {
description: "View the files registered in nushell's EngineState memory",
example: r#"view files"#,
result: None,
}]
vec![
Example {
description: "View the files registered in Nushell's EngineState memory",
example: r#"view files"#,
result: None,
},
Example {
description: "View how Nushell was originally invoked",
example: r#"view files | get 0"#,
result: None,
},
]
}
}

0 comments on commit 4205edb

Please sign in to comment.