Move from source to source-env (#6277)

* start working on source-env

* WIP

* Get most tests working, still one to go

* Fix file-relative paths; Report parser error

* Fix merge conflicts; Restore source as deprecated

* Tests: Use source-env; Remove redundant tests

* Fmt

* Respect hidden env vars

* Fix file-relative eval for source-env

* Add file-relative eval to "overlay use"

* Use FILE_PWD only in source-env and "overlay use"

* Ignore new tests for now

This will be another issue

* Throw an error if setting FILE_PWD manually

* Fix source-related test failures

* Fix nu-check to respect FILE_PWD

* Fix corrupted spans in source-env shell errors

* Fix up some references to old source

* Remove deprecation message

* Re-introduce deleted tests

Co-authored-by: kubouch <kubouch@gmail.com>

crates/nu-command/src/core_commands/mod.rs

@@ -25,7 +25,6 @@ mod let_;
 mod metadata;
 mod module;
 pub(crate) mod overlay;
-mod source;
 mod use_;
 mod version;
 
@@ -56,7 +55,6 @@ pub use let_::Let;
 pub use metadata::Metadata;
 pub use module::Module;
 pub use overlay::*;
-pub use source::Source;
 pub use use_::Use;
 pub use version::Version;
 #[cfg(feature = "plugin")]

crates/nu-command/src/core_commands/overlay/use_.rs

@@ -1,7 +1,9 @@
-use nu_engine::{eval_block, redirect_env, CallExt};
+use nu_engine::{eval_block, find_in_dirs_env, redirect_env, CallExt};
 use nu_protocol::ast::Call;
 use nu_protocol::engine::{Command, EngineState, Stack};
-use nu_protocol::{Category, Example, PipelineData, ShellError, Signature, Spanned, SyntaxShape};
+use nu_protocol::{
+    Category, Example, PipelineData, ShellError, Signature, Spanned, SyntaxShape, Value,
+};
 
 use std::path::Path;
 
@@ -79,7 +81,7 @@ impl Command for OverlayUse {
             .find_overlay(name_arg.item.as_bytes())
             .is_some()
         {
-            (name_arg.item, name_arg.span)
+            (name_arg.item.clone(), name_arg.span)
         } else if let Some(os_str) = Path::new(&name_arg.item).file_stem() {
             if let Some(name) = os_str.to_str() {
                 (name.to_string(), name_arg.span)
@@ -131,6 +133,22 @@ impl Command for OverlayUse {
 
                     // Evaluate the export-env block (if any) and keep its environment
                     if let Some(block_id) = module.env_block {
+                        let maybe_path =
+                            find_in_dirs_env(&name_arg.item, engine_state, caller_stack)?;
+
+                        if let Some(path) = &maybe_path {
+                            // Set the currently evaluated directory, if the argument is a valid path
+                            let mut parent = path.clone();
+                            parent.pop();
+
+                            let file_pwd = Value::String {
+                                val: parent.to_string_lossy().to_string(),
+                                span: call.head,
+                            };
+
+                            caller_stack.add_env_var("FILE_PWD".to_string(), file_pwd);
+                        }
+
                         let block = engine_state.get_block(block_id);
                         let mut callee_stack = caller_stack.gather_captures(&block.captures);
 
@@ -143,7 +161,13 @@ impl Command for OverlayUse {
                             call.redirect_stderr,
                         );
 
+                        // Merge the block's environment to the current stack
                         redirect_env(engine_state, caller_stack, &callee_stack);
+
+                        if maybe_path.is_some() {
+                            // Remove the file-relative PWD, if the argument is a valid path
+                            caller_stack.remove_env_var(engine_state, "FILE_PWD");
+                        }
                     }
                 }
             }

crates/nu-command/src/core_commands/source.rs

@@ -1,74 +0,0 @@
-use nu_engine::{eval_block, CallExt};
-use nu_protocol::ast::Call;
-use nu_protocol::engine::{Command, EngineState, Stack};
-use nu_protocol::{Category, Example, PipelineData, ShellError, Signature, SyntaxShape};
-
-/// Source a file for environment variables.
-#[derive(Clone)]
-pub struct Source;
-
-impl Command for Source {
-    fn name(&self) -> &str {
-        "source"
-    }
-
-    fn signature(&self) -> Signature {
-        Signature::build("source")
-            .required(
-                "filename",
-                SyntaxShape::Filepath,
-                "the filepath to the script file to source",
-            )
-            .category(Category::Core)
-    }
-
-    fn usage(&self) -> &str {
-        "Runs a script file in the current context."
-    }
-
-    fn extra_usage(&self) -> &str {
-        r#"This command is a parser keyword. For details, check:
-  https://www.nushell.sh/book/thinking_in_nu.html"#
-    }
-
-    fn is_parser_keyword(&self) -> bool {
-        true
-    }
-
-    fn run(
-        &self,
-        engine_state: &EngineState,
-        stack: &mut Stack,
-        call: &Call,
-        input: PipelineData,
-    ) -> Result<PipelineData, ShellError> {
-        // Note: this hidden positional is the block_id that corresponded to the 0th position
-        // it is put here by the parser
-        let block_id: i64 = call.req(engine_state, stack, 1)?;
-
-        let block = engine_state.get_block(block_id as usize).clone();
-        eval_block(
-            engine_state,
-            stack,
-            &block,
-            input,
-            call.redirect_stdout,
-            call.redirect_stderr,
-        )
-    }
-
-    fn examples(&self) -> Vec<Example> {
-        vec![
-            Example {
-                description: "Runs foo.nu in the current context",
-                example: r#"source foo.nu"#,
-                result: None,
-            },
-            Example {
-                description: "Runs foo.nu in current context and call the command defined, suppose foo.nu has content: `def say-hi [] { echo 'Hi!' }`",
-                example: r#"source ./foo.nu; say-hi"#,
-                result: None,
-            },
-        ]
-    }
-}