nushell/crates/nu-command/src/commands/filesystem/ls.rs
JT a74d05061d
Begin directory contrib docs and split commands (#3650)
* Begin directory contrib docs and split commands

* Fix unused import warning
2021-06-19 12:06:44 +12:00

91 lines
2.4 KiB
Rust

use crate::prelude::*;
use nu_engine::{shell::LsArgs, WholeStreamCommand};
use nu_errors::ShellError;
use nu_protocol::{Signature, SyntaxShape};
pub struct Ls;
impl WholeStreamCommand for Ls {
fn name(&self) -> &str {
"ls"
}
fn signature(&self) -> Signature {
Signature::build("ls")
.optional(
"path",
SyntaxShape::GlobPattern,
"a path to get the directory contents from",
)
.switch("all", "Show hidden files", Some('a'))
.switch(
"long",
"List all available columns for each entry",
Some('l'),
)
.switch(
"short-names",
"Only print the file names and not the path",
Some('s'),
)
.switch(
"du",
"Display the apparent directory size in place of the directory metadata size",
Some('d'),
)
}
fn usage(&self) -> &str {
"View the contents of the current or given path."
}
fn run_with_actions(&self, args: CommandArgs) -> Result<ActionStream, ShellError> {
let name = args.call_info.name_tag.clone();
let ctrl_c = args.ctrl_c();
let shell_manager = args.shell_manager();
let args = LsArgs {
path: args.opt(0)?,
all: args.has_flag("all"),
long: args.has_flag("long"),
short_names: args.has_flag("short-names"),
du: args.has_flag("du"),
};
shell_manager.ls(args, name, ctrl_c)
}
fn examples(&self) -> Vec<Example> {
vec![
Example {
description: "List all files in the current directory",
example: "ls",
result: None,
},
Example {
description: "List all files in a subdirectory",
example: "ls subdir",
result: None,
},
Example {
description: "List all rust files",
example: "ls *.rs",
result: None,
},
]
}
}
#[cfg(test)]
mod tests {
use super::Ls;
use super::ShellError;
#[test]
fn examples_work_as_expected() -> Result<(), ShellError> {
use crate::examples::test as test_examples;
test_examples(Ls {})
}
}