[pull] main from nushell:main

crates/nu-command/src/env/config/config_env.rs

@@ -15,7 +15,16 @@ impl Command for ConfigEnv {
         Signature::build(self.name())
             .category(Category::Env)
             .input_output_types(vec![(Type::Nothing, Type::Any)])
-            .switch("default", "Print default `env.nu` file instead.", Some('d'))
+            .switch(
+                "default",
+                "Print the internal default `env.nu` file instead.",
+                Some('d'),
+            )
+            .switch(
+                "sample",
+                "Print a commented, sample `env.nu` file instead.",
+                Some('s'),
+            )
         // TODO: Signature narrower than what run actually supports theoretically
     }
 
@@ -26,18 +35,18 @@ impl Command for ConfigEnv {
     fn examples(&self) -> Vec<Example> {
         vec![
             Example {
-                description: "allow user to open and update nu env",
+                description: "open user's env.nu in the default editor",
                 example: "config env",
                 result: None,
             },
             Example {
-                description: "allow user to print default `env.nu` file",
-                example: "config env --default,",
+                description: "pretty-print a commented, sample `env.nu` that explains common settings",
+                example: "config env --sample | nu-highlight,",
                 result: None,
             },
             Example {
-                description: "allow saving the default `env.nu` locally",
-                example: "config env --default | save -f ~/.config/nushell/default_env.nu",
+                description: "pretty-print the internal `env.nu` file which is loaded before the user's environment",
+                example: "config env --default | nu-highlight,",
                 result: None,
             },
         ]
@@ -50,12 +59,28 @@ impl Command for ConfigEnv {
         call: &Call,
         _input: PipelineData,
     ) -> Result<PipelineData, ShellError> {
+        let default_flag = call.has_flag(engine_state, stack, "default")?;
+        let sample_flag = call.has_flag(engine_state, stack, "sample")?;
+        if default_flag && sample_flag {
+            return Err(ShellError::IncompatibleParameters {
+                left_message: "can't use `--default` at the same time".into(),
+                left_span: call.get_flag_span(stack, "default").expect("has flag"),
+                right_message: "because of `--sample`".into(),
+                right_span: call.get_flag_span(stack, "sample").expect("has flag"),
+            });
+        }
         // `--default` flag handling
         if call.has_flag(engine_state, stack, "default")? {
             let head = call.head;
             return Ok(Value::string(nu_utils::get_default_env(), head).into_pipeline_data());
         }
 
+        // `--sample` flag handling
+        if sample_flag {
+            let head = call.head;
+            return Ok(Value::string(nu_utils::get_sample_env(), head).into_pipeline_data());
+        }
+
         // Find the editor executable.
         let (editor_name, editor_args) = get_editor(engine_state, stack, call.head)?;
         let paths = nu_engine::env::path_str(engine_state, stack, call.head)?;

crates/nu-command/src/env/config/config_nu.rs

@@ -17,9 +17,14 @@ impl Command for ConfigNu {
             .input_output_types(vec![(Type::Nothing, Type::Any)])
             .switch(
                 "default",
-                "Print default `config.nu` file instead.",
+                "Print the internal default `config.nu` file instead.",
                 Some('d'),
             )
+            .switch(
+                "sample",
+                "Print a commented, sample `config.nu` file instead.",
+                Some('s'),
+            )
         // TODO: Signature narrower than what run actually supports theoretically
     }
 
@@ -30,18 +35,19 @@ impl Command for ConfigNu {
     fn examples(&self) -> Vec<Example> {
         vec![
             Example {
-                description: "allow user to open and update nu config",
+                description: "open user's config.nu in the default editor",
                 example: "config nu",
                 result: None,
             },
             Example {
-                description: "allow user to print default `config.nu` file",
-                example: "config nu --default,",
+                description: "pretty-print a commented, sample `config.nu` that explains common settings",
+                example: "config nu --sample | nu-highlight",
                 result: None,
             },
             Example {
-                description: "allow saving the default `config.nu` locally",
-                example: "config nu --default | save -f ~/.config/nushell/default_config.nu",
+                description:
+                    "pretty-print the internal `config.nu` file which is loaded before user's config",
+                example: "config nu --default | nu-highlight",
                 result: None,
             },
         ]
@@ -54,12 +60,29 @@ impl Command for ConfigNu {
         call: &Call,
         _input: PipelineData,
     ) -> Result<PipelineData, ShellError> {
+        let default_flag = call.has_flag(engine_state, stack, "default")?;
+        let sample_flag = call.has_flag(engine_state, stack, "sample")?;
+        if default_flag && sample_flag {
+            return Err(ShellError::IncompatibleParameters {
+                left_message: "can't use `--default` at the same time".into(),
+                left_span: call.get_flag_span(stack, "default").expect("has flag"),
+                right_message: "because of `--sample`".into(),
+                right_span: call.get_flag_span(stack, "sample").expect("has flag"),
+            });
+        }
+
         // `--default` flag handling
-        if call.has_flag(engine_state, stack, "default")? {
+        if default_flag {
             let head = call.head;
             return Ok(Value::string(nu_utils::get_default_config(), head).into_pipeline_data());
         }
 
+        // `--sample` flag handling
+        if sample_flag {
+            let head = call.head;
+            return Ok(Value::string(nu_utils::get_sample_config(), head).into_pipeline_data());
+        }
+
         // Find the editor executable.
         let (editor_name, editor_args) = get_editor(engine_state, stack, call.head)?;
         let paths = nu_engine::env::path_str(engine_state, stack, call.head)?;

crates/nu-protocol/tests/into_config.rs

@@ -35,7 +35,7 @@ fn config_affected_when_mutated() {
 
 #[test]
 fn config_affected_when_deep_mutated() {
-    let actual = nu!(cwd: "crates/nu-utils/src/sample_config", nu_repl_code(&[
+    let actual = nu!(cwd: "crates/nu-utils/src/default_files", nu_repl_code(&[
         r#"source default_config.nu"#,
         r#"$env.config.filesize.metric = true"#,
         r#"20mib | into string"#]));
@@ -45,7 +45,7 @@ fn config_affected_when_deep_mutated() {
 
 #[test]
 fn config_add_unsupported_key() {
-    let actual = nu!(cwd: "crates/nu-utils/src/sample_config", nu_repl_code(&[
+    let actual = nu!(cwd: "crates/nu-utils/src/default_files", nu_repl_code(&[
         r#"source default_config.nu"#,
         r#"$env.config.foo = 2"#,
         r#";"#]));
@@ -57,7 +57,7 @@ fn config_add_unsupported_key() {
 
 #[test]
 fn config_add_unsupported_type() {
-    let actual = nu!(cwd: "crates/nu-utils/src/sample_config", nu_repl_code(&[r#"source default_config.nu"#,
+    let actual = nu!(cwd: "crates/nu-utils/src/default_files", nu_repl_code(&[r#"source default_config.nu"#,
         r#"$env.config.ls = '' "#,
         r#";"#]));
 
@@ -66,7 +66,7 @@ fn config_add_unsupported_type() {
 
 #[test]
 fn config_add_unsupported_value() {
-    let actual = nu!(cwd: "crates/nu-utils/src/sample_config", nu_repl_code(&[r#"source default_config.nu"#,
+    let actual = nu!(cwd: "crates/nu-utils/src/default_files", nu_repl_code(&[r#"source default_config.nu"#,
         r#"$env.config.history.file_format = ''"#,
         r#";"#]));
 
@@ -77,7 +77,7 @@ fn config_add_unsupported_value() {
 #[test]
 #[ignore = "Figure out how to make test_bins::nu_repl() continue execution after shell errors"]
 fn config_unsupported_key_reverted() {
-    let actual = nu!(cwd: "crates/nu-utils/src/sample_config", nu_repl_code(&[r#"source default_config.nu"#,
+    let actual = nu!(cwd: "crates/nu-utils/src/default_files", nu_repl_code(&[r#"source default_config.nu"#,
         r#"$env.config.foo = 1"#,
         r#"'foo' in $env.config"#]));
 
@@ -87,7 +87,7 @@ fn config_unsupported_key_reverted() {
 #[test]
 #[ignore = "Figure out how to make test_bins::nu_repl() continue execution after shell errors"]
 fn config_unsupported_type_reverted() {
-    let actual = nu!(cwd: "crates/nu-utils/src/sample_config", nu_repl_code(&[r#" source default_config.nu"#,
+    let actual = nu!(cwd: "crates/nu-utils/src/default_files", nu_repl_code(&[r#" source default_config.nu"#,
         r#"$env.config.ls = ''"#,
         r#"$env.config.ls | describe"#]));
 
@@ -97,7 +97,7 @@ fn config_unsupported_type_reverted() {
 #[test]
 #[ignore = "Figure out how to make test_bins::nu_repl() continue execution after errors"]
 fn config_unsupported_value_reverted() {
-    let actual = nu!(cwd: "crates/nu-utils/src/sample_config", nu_repl_code(&[r#" source default_config.nu"#,
+    let actual = nu!(cwd: "crates/nu-utils/src/default_files", nu_repl_code(&[r#" source default_config.nu"#,
         r#"$env.config.history.file_format = 'plaintext'"#,
         r#"$env.config.history.file_format = ''"#,
         r#"$env.config.history.file_format | to json"#]));

crates/nu-std/src/lib.rs

@@ -54,6 +54,7 @@ pub fn load_standard_library(
         ("mod.nu", "std/math", include_str!("../std/math/mod.nu")),
         ("mod.nu", "std/util", include_str!("../std/util/mod.nu")),
         ("mod.nu", "std/xml", include_str!("../std/xml/mod.nu")),
+        ("mod.nu", "std/config", include_str!("../std/config/mod.nu")),
     ];
 
     for (filename, std_subdir_name, content) in std_submodules.drain(..) {

crates/nu-std/std/config/mod.nu

@@ -0,0 +1,139 @@
+# Returns a dark-mode theme that can be assigned to $env.config.color_config
+export def dark-theme [] {
+    {
+        # color for nushell primitives
+        separator: white
+        leading_trailing_space_bg: { attr: n } # no fg, no bg, attr none effectively turns this off
+        header: green_bold
+        empty: blue
+        # Closures can be used to choose colors for specific values.
+        # The value (in this case, a bool) is piped into the closure.
+        # eg) {|| if $in { 'light_cyan' } else { 'light_gray' } }
+        bool: light_cyan
+        int: white
+        filesize: cyan
+        duration: white
+        date: purple
+        range: white
+        float: white
+        string: white
+        nothing: white
+        binary: white
+        cell-path: white
+        row_index: green_bold
+        record: white
+        list: white
+        block: white
+        hints: dark_gray
+        search_result: { bg: red fg: white }
+        shape_and: purple_bold
+        shape_binary: purple_bold
+        shape_block: blue_bold
+        shape_bool: light_cyan
+        shape_closure: green_bold
+        shape_custom: green
+        shape_datetime: cyan_bold
+        shape_directory: cyan
+        shape_external: cyan
+        shape_externalarg: green_bold
+        shape_external_resolved: light_yellow_bold
+        shape_filepath: cyan
+        shape_flag: blue_bold
+        shape_float: purple_bold
+        # shapes are used to change the cli syntax highlighting
+        shape_garbage: { fg: white bg: red attr: b }
+        shape_glob_interpolation: cyan_bold
+        shape_globpattern: cyan_bold
+        shape_int: purple_bold
+        shape_internalcall: cyan_bold
+        shape_keyword: cyan_bold
+        shape_list: cyan_bold
+        shape_literal: blue
+        shape_match_pattern: green
+        shape_matching_brackets: { attr: u }
+        shape_nothing: light_cyan
+        shape_operator: yellow
+        shape_or: purple_bold
+        shape_pipe: purple_bold
+        shape_range: yellow_bold
+        shape_record: cyan_bold
+        shape_redirection: purple_bold
+        shape_signature: green_bold
+        shape_string: green
+        shape_string_interpolation: cyan_bold
+        shape_table: blue_bold
+        shape_variable: purple
+        shape_vardecl: purple
+        shape_raw_string: light_purple
+    }
+}
+
+# Returns a light-mode theme that can be assigned to $env.config.color_config
+export def light-theme [] {
+    {
+        # color for nushell primitives
+        separator: dark_gray
+        leading_trailing_space_bg: { attr: n } # no fg, no bg, attr none effectively turns this off
+        header: green_bold
+        empty: blue
+        # Closures can be used to choose colors for specific values.
+        # The value (in this case, a bool) is piped into the closure.
+        # eg) {|| if $in { 'dark_cyan' } else { 'dark_gray' } }
+        bool: dark_cyan
+        int: dark_gray
+        filesize: cyan_bold
+        duration: dark_gray
+        date: purple
+        range: dark_gray
+        float: dark_gray
+        string: dark_gray
+        nothing: dark_gray
+        binary: dark_gray
+        cell-path: dark_gray
+        row_index: green_bold
+        record: dark_gray
+        list: dark_gray
+        block: dark_gray
+        hints: dark_gray
+        search_result: { fg: white bg: red }
+        shape_and: purple_bold
+        shape_binary: purple_bold
+        shape_block: blue_bold
+        shape_bool: light_cyan
+        shape_closure: green_bold
+        shape_custom: green
+        shape_datetime: cyan_bold
+        shape_directory: cyan
+        shape_external: cyan
+        shape_externalarg: green_bold
+        shape_external_resolved: light_purple_bold
+        shape_filepath: cyan
+        shape_flag: blue_bold
+        shape_float: purple_bold
+        # shapes are used to change the cli syntax highlighting
+        shape_garbage: { fg: white bg: red attr: b }
+        shape_glob_interpolation: cyan_bold
+        shape_globpattern: cyan_bold
+        shape_int: purple_bold
+        shape_internalcall: cyan_bold
+        shape_keyword: cyan_bold
+        shape_list: cyan_bold
+        shape_literal: blue
+        shape_match_pattern: green
+        shape_matching_brackets: { attr: u }
+        shape_nothing: light_cyan
+        shape_operator: yellow
+        shape_or: purple_bold
+        shape_pipe: purple_bold
+        shape_range: yellow_bold
+        shape_record: cyan_bold
+        shape_redirection: purple_bold
+        shape_signature: green_bold
+        shape_string: green
+        shape_string_interpolation: cyan_bold
+        shape_table: blue_bold
+        shape_variable: purple
+        shape_vardecl: purple
+        shape_raw_string: light_purple
+    }
+}

crates/nu-std/std/mod.nu

@@ -14,6 +14,7 @@ export module std/iter
 export module std/log
 export module std/math
 export module std/xml
+export module std/config
 
 # Load main dirs command and all subcommands
 export use std/dirs main