nu-cli refactor moving commands into their own crate nu-command (#2910)

* move commands, futures.rs, script.rs, utils

* move over maybe_print_errors

* add nu_command crate references to nu_cli

* in commands.rs open up to pub mod from pub(crate)

* nu-cli, nu-command, and nu tests are now passing

* cargo fmt

* clean up nu-cli/src/prelude.rs

* code cleanup

* for some reason lex.rs was not formatted, may be causing my error

* remove mod completion from lib.rs which was not being used along with quickcheck macros

* add in allow unused imports

* comment out one failing external test; comment out one failing internal test

* revert commenting out failing tests; something else might be going on; someone with a windows machine should check and see what is going on with these failing windows tests

* Update Cargo.toml

Extend the optional features to nu-command

Co-authored-by: Jonathan Turner <jonathandturner@users.noreply.github.com>

crates/nu-command/tests/commands/path/basename.rs

@@ -0,0 +1,83 @@
+use nu_test_support::{nu, pipeline};
+
+use super::join_path_sep;
+
+#[test]
+fn returns_basename_of_empty_input() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "" 
+            | path basename
+        "#
+    ));
+
+    assert_eq!(actual.out, "");
+}
+
+#[test]
+fn replaces_basename_of_empty_input() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "" 
+            | path basename -r newname.txt
+        "#
+    ));
+
+    assert_eq!(actual.out, "newname.txt");
+}
+
+#[test]
+fn returns_basename_of_path_ending_with_dot() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "some/file.txt/." 
+            | path basename 
+        "#
+    ));
+
+    assert_eq!(actual.out, "file.txt");
+}
+
+#[test]
+fn replaces_basename_of_path_ending_with_dot() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "some/file.txt/." 
+            | path basename -r viking.txt
+        "#
+    ));
+
+    let expected = join_path_sep(&["some", "viking.txt"]);
+    assert_eq!(actual.out, expected);
+}
+
+#[test]
+fn returns_basename_of_path_ending_with_double_dot() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "some/file.txt/.." 
+            | path basename 
+        "#
+    ));
+
+    assert_eq!(actual.out, "");
+}
+
+#[test]
+fn replaces_basename_of_path_ending_with_double_dot() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "some/file.txt/.." 
+            | path basename -r eggs
+        "#
+    ));
+
+    let expected = join_path_sep(&["some/file.txt/..", "eggs"]);
+    assert_eq!(actual.out, expected);
+}

crates/nu-command/tests/commands/path/dirname.rs

@@ -0,0 +1,137 @@
+use nu_test_support::{nu, pipeline};
+
+use super::join_path_sep;
+
+#[test]
+fn returns_dirname_of_empty_input() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "" 
+            | path dirname
+        "#
+    ));
+
+    assert_eq!(actual.out, "");
+}
+
+#[test]
+fn replaces_dirname_of_empty_input() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "" 
+            | path dirname -r newdir
+        "#
+    ));
+
+    assert_eq!(actual.out, "newdir");
+}
+
+#[test]
+fn returns_dirname_of_path_ending_with_dot() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "some/dir/." 
+            | path dirname 
+        "#
+    ));
+
+    assert_eq!(actual.out, "some");
+}
+
+#[test]
+fn replaces_dirname_of_path_ending_with_dot() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "some/dir/." 
+            | path dirname -r eggs
+        "#
+    ));
+
+    let expected = join_path_sep(&["eggs", "dir"]);
+    assert_eq!(actual.out, expected);
+}
+
+#[test]
+fn returns_dirname_of_path_ending_with_double_dot() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "some/dir/.." 
+            | path dirname 
+        "#
+    ));
+
+    assert_eq!(actual.out, "some/dir");
+}
+
+#[test]
+fn replaces_dirname_of_path_with_double_dot() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "some/dir/.." 
+            | path dirname -r eggs
+        "#
+    ));
+
+    let expected = join_path_sep(&["eggs", ".."]);
+    assert_eq!(actual.out, expected);
+}
+
+#[test]
+fn returns_dirname_of_zero_levels() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "some/dir/with/spam.txt"
+            | path dirname -n 0
+        "#
+    ));
+
+    assert_eq!(actual.out, "some/dir/with/spam.txt");
+}
+
+#[test]
+fn replaces_dirname_of_zero_levels_with_empty_string() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "some/dir/with/spam.txt"
+            | path dirname -n 0 -r ""
+        "#
+    ));
+
+    assert_eq!(actual.out, "");
+}
+
+#[test]
+fn replaces_dirname_of_more_levels() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "some/dir/with/spam.txt"
+            | path dirname -r eggs -n 2
+        "#
+    ));
+
+    let expected = join_path_sep(&["eggs", "with/spam.txt"]);
+    assert_eq!(actual.out, expected);
+}
+
+#[test]
+fn replaces_dirname_of_way_too_many_levels() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "some/dir/with/spam.txt"
+            | path dirname -r eggs -n 999
+        "#
+    ));
+
+    let expected = join_path_sep(&["eggs", "some/dir/with/spam.txt"]);
+    assert_eq!(actual.out, expected);
+}

crates/nu-command/tests/commands/path/exists.rs

@@ -0,0 +1,53 @@
+use nu_test_support::fs::Stub::EmptyFile;
+use nu_test_support::nu;
+use nu_test_support::playground::Playground;
+
+#[test]
+fn checks_if_existing_file_exists() {
+    Playground::setup("path_exists_1", |dirs, sandbox| {
+        sandbox.with_files(vec![EmptyFile("spam.txt")]);
+
+        let actual = nu!(
+            cwd: dirs.test(),
+            "echo spam.txt | path exists"
+        );
+
+        assert_eq!(actual.out, "true");
+    })
+}
+
+#[test]
+fn checks_if_missing_file_exists() {
+    Playground::setup("path_exists_2", |dirs, _| {
+        let actual = nu!(
+            cwd: dirs.test(),
+            "echo spam.txt | path exists"
+        );
+
+        assert_eq!(actual.out, "false");
+    })
+}
+
+#[test]
+fn checks_if_dot_exists() {
+    Playground::setup("path_exists_3", |dirs, _| {
+        let actual = nu!(
+            cwd: dirs.test(),
+            "echo '.' | path exists"
+        );
+
+        assert_eq!(actual.out, "true");
+    })
+}
+
+#[test]
+fn checks_if_double_dot_exists() {
+    Playground::setup("path_exists_4", |dirs, _| {
+        let actual = nu!(
+            cwd: dirs.test(),
+            "echo '..' | path exists"
+        );
+
+        assert_eq!(actual.out, "true");
+    })
+}

crates/nu-command/tests/commands/path/expand.rs

@@ -0,0 +1,45 @@
+use nu_test_support::fs::Stub::EmptyFile;
+use nu_test_support::playground::Playground;
+use nu_test_support::{nu, pipeline};
+
+use std::path::PathBuf;
+
+#[test]
+fn expands_path_with_dot() {
+    Playground::setup("path_expand_1", |dirs, sandbox| {
+        sandbox
+            .within("menu")
+            .with_files(vec![EmptyFile("spam.txt")]);
+
+        let actual = nu!(
+            cwd: dirs.test(), pipeline(
+            r#"
+                echo "menu/./spam.txt" 
+                | path expand
+            "#
+        ));
+
+        let expected = dirs.test.join("menu").join("spam.txt");
+        assert_eq!(PathBuf::from(actual.out), expected);
+    })
+}
+
+#[test]
+fn expands_path_with_double_dot() {
+    Playground::setup("path_expand_2", |dirs, sandbox| {
+        sandbox
+            .within("menu")
+            .with_files(vec![EmptyFile("spam.txt")]);
+
+        let actual = nu!(
+            cwd: dirs.test(), pipeline(
+            r#"
+                echo "menu/../menu/spam.txt" 
+                | path expand
+            "#
+        ));
+
+        let expected = dirs.test.join("menu").join("spam.txt");
+        assert_eq!(PathBuf::from(actual.out), expected);
+    })
+}

crates/nu-command/tests/commands/path/extension.rs

@@ -0,0 +1,37 @@
+use nu_test_support::{nu, pipeline};
+
+#[test]
+fn returns_extension_of_path_ending_with_dot() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "bacon." | path extension
+        "#
+    ));
+
+    assert_eq!(actual.out, "");
+}
+
+#[test]
+fn replaces_extension_with_dot_of_path_ending_with_dot() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "bacon." | path extension -r .egg
+        "#
+    ));
+
+    assert_eq!(actual.out, "bacon..egg");
+}
+
+#[test]
+fn replaces_extension_of_empty_path() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "" | path extension -r egg
+        "#
+    ));
+
+    assert_eq!(actual.out, "");
+}

crates/nu-command/tests/commands/path/filestem.rs

@@ -0,0 +1,95 @@
+use nu_test_support::{nu, pipeline};
+
+use super::join_path_sep;
+
+#[test]
+fn returns_filestem_of_dot() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "menu/eggs/." 
+            | path filestem
+        "#
+    ));
+
+    assert_eq!(actual.out, "eggs");
+}
+
+#[test]
+fn returns_filestem_of_double_dot() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "menu/eggs/.." 
+            | path filestem
+        "#
+    ));
+
+    assert_eq!(actual.out, "");
+}
+
+#[test]
+fn returns_filestem_of_path_with_empty_prefix() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "menu/spam.txt" 
+            | path filestem -p ""
+        "#
+    ));
+
+    assert_eq!(actual.out, "spam");
+}
+
+#[test]
+fn returns_filestem_of_path_with_empty_suffix() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "menu/spam.txt" 
+            | path filestem -s ""
+        "#
+    ));
+
+    assert_eq!(actual.out, "spam.txt");
+}
+
+#[test]
+fn returns_filestem_of_path_with_empty_prefix_and_suffix() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "menu/spam.txt" 
+            | path filestem -p "" -s ""
+        "#
+    ));
+
+    assert_eq!(actual.out, "spam.txt");
+}
+
+#[test]
+fn returns_filestem_with_wrong_prefix_and_suffix() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "menu/spam.txt" 
+            | path filestem -p "bacon" -s "eggs"
+        "#
+    ));
+
+    assert_eq!(actual.out, "spam.txt");
+}
+
+#[test]
+fn replaces_filestem_stripped_to_dot() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "menu/spam.txt" 
+            | path filestem -p "spam" -s "txt" -r ".eggs."
+        "#
+    ));
+
+    let expected = join_path_sep(&["menu", "spam.eggs.txt"]);
+    assert_eq!(actual.out, expected);
+}

crates/nu-command/tests/commands/path/mod.rs

@@ -0,0 +1,33 @@
+mod basename;
+mod dirname;
+mod exists;
+mod expand;
+mod extension;
+mod filestem;
+mod type_;
+
+use std::path::MAIN_SEPARATOR;
+
+/// Helper function that joins string literals with '/' or '\', based on host OS
+fn join_path_sep(pieces: &[&str]) -> String {
+    let sep_string = String::from(MAIN_SEPARATOR);
+    pieces.join(&sep_string)
+}
+
+#[cfg(windows)]
+#[test]
+fn joins_path_on_windows() {
+    let pieces = ["sausage", "bacon", "spam"];
+    let actual = join_path_sep(&pieces);
+
+    assert_eq!(&actual, "sausage\\bacon\\spam");
+}
+
+#[cfg(not(windows))]
+#[test]
+fn joins_path_on_other_than_windows() {
+    let pieces = ["sausage", "bacon", "spam"];
+    let actual = join_path_sep(&pieces);
+
+    assert_eq!(&actual, "sausage/bacon/spam");
+}

crates/nu-command/tests/commands/path/type_.rs

@@ -0,0 +1,54 @@
+use nu_test_support::fs::Stub::EmptyFile;
+use nu_test_support::playground::Playground;
+use nu_test_support::{nu, pipeline};
+
+#[test]
+fn returns_type_of_missing_file() {
+    let actual = nu!(
+        cwd: "tests", pipeline(
+        r#"
+            echo "spam.txt" 
+            | path type
+        "#
+    ));
+
+    assert_eq!(actual.out, "");
+}
+
+#[test]
+fn returns_type_of_existing_file() {
+    Playground::setup("path_expand_1", |dirs, sandbox| {
+        sandbox
+            .within("menu")
+            .with_files(vec![EmptyFile("spam.txt")]);
+
+        let actual = nu!(
+            cwd: dirs.test(), pipeline(
+            r#"
+                echo "menu" 
+                | path type
+            "#
+        ));
+
+        assert_eq!(actual.out, "Dir");
+    })
+}
+
+#[test]
+fn returns_type_of_existing_directory() {
+    Playground::setup("path_expand_1", |dirs, sandbox| {
+        sandbox
+            .within("menu")
+            .with_files(vec![EmptyFile("spam.txt")]);
+
+        let actual = nu!(
+            cwd: dirs.test(), pipeline(
+            r#"
+                echo "menu/spam.txt" 
+                | path type
+            "#
+        ));
+
+        assert_eq!(actual.out, "File");
+    })
+}