A Nu Function to Get the Current Sourced Script Location

Oct 13, 2025 by talynt.org 74 views

Introduction

Nu shell, also known as Nu, is a modern shell that provides a powerful and flexible way to work with files, directories, and processes. One of the key features of Nu is its ability to source other scripts, allowing you to reuse code and create complex workflows. However, when working with sourced scripts, it can be challenging to determine the current script location. In this article, we will explore how to get the current sourced script location in Nu shell.

The Problem

When you source a script in Nu, the current script location is not automatically updated to the location of the sourced script. This can make it difficult to determine the current script location, especially when working with complex workflows that involve multiple sourced scripts.

The Current Solution

One common approach to getting the current script location in Nu is to use the $env.FILE_PWD variable. This variable returns the path of the current script file. However, this approach has a limitation: it only works for the current script file, not for sourced scripts.

For example, consider the following script:

# main.nu
source ./lib/func.nu
echo "Script file: ($env.FILE_PWD)"

If you run this script, the output will be the path of the main.nu file, not the path of the func.nu file that was sourced.

A Better Solution

So, how can we get the current sourced script location in Nu? One approach is to use the $env.FILE_PWD variable in combination with the source command. When you use the source command, Nu creates a new scope for the sourced script. We can use this scope to get the current script location.

Here's an example:

# main.nu
source ./lib/func.nu
$env.FILE_PWD = $env.FILE_PWD | Get-Item
echo "Script file: ($env.FILE_PWD)"

In this example, we use the Get-Item command to get the current script location. The Get-Item command returns an object that contains information about the current script file, including its path.

A Nu Function to Get the Current Sourced Script Location

To make it easier to get the current sourced script location, we can create a Nu function that takes care of the details for us. Here's an example:

# Get-CurrentScriptLocation.nu
function Get-CurrentScriptLocation {
  # Get the current script location
  $scriptLocation = $env.FILE_PWD | Get-Item
return $scriptLocation
}

We can then use this function in our scripts to get the current sourced script location:

# main.nu
source ./lib/func.nu
$scriptLocation = Get-CurrentScriptLocation
echo "Script file: ($scriptLocation)"

Conclusion

In this article, we explored how to get the current sourced script location in Nu shell. We discussed the limitations of the current solution and presented a better approach that uses the $env.FILE_PWD variable in combination with the source command. We also created a Nu function that takes care of the details for us, making it easier to get the current sourced script location.

Example Use Cases

Here are some example use cases for getting the current sourced script location in Nu:

Logging: When working with complex workflows that involve multiple sourced scripts, it can be helpful to log the current script location. This can help you debug issues and understand the flow of your script.
Error Handling: When an error occurs in a sourced script, it can be helpful to log the current script location. This can help you understand where the error occurred and how to fix it.
Script Maintenance: When maintaining a large script that involves multiple sourced scripts, it can be helpful to get the current sourced script location. This can help you understand the flow of your script and make changes as needed.

Best Practices

Here are some best practices to keep in mind when working with sourced scripts in Nu:

Use meaningful variable names: When working with sourced scripts, it's a good idea to use meaningful variable names to help you understand the flow of your script.
Use comments: Comments can help you understand the flow of your script and make changes as needed.
Test your script: Before running your script, make sure to test it to ensure that it works as expected.

Conclusion

Introduction

In our previous article, we explored how to get the current sourced script location in Nu shell. We discussed the limitations of the current solution and presented a better approach that uses the $env.FILE_PWD variable in combination with the source command. We also created a Nu function that takes care of the details for us, making it easier to get the current sourced script location.

In this article, we will answer some frequently asked questions about getting the current sourced script location in Nu shell.

Q: What is the current sourced script location?

A: The current sourced script location is the path of the script that is currently being executed. This can be different from the path of the script that was originally sourced.

Q: How do I get the current sourced script location in Nu shell?

A: You can get the current sourced script location in Nu shell by using the $env.FILE_PWD variable in combination with the source command. Alternatively, you can use the Get-CurrentScriptLocation function that we created in our previous article.

Q: What is the difference between the current script location and the sourced script location?

A: The current script location is the path of the script that is currently being executed, while the sourced script location is the path of the script that was originally sourced.

Q: Can I use the `source` command to get the current sourced script location?

A: Yes, you can use the source command to get the current sourced script location. However, this approach has a limitation: it only works for the current script file, not for sourced scripts.

Q: How do I use the `Get-CurrentScriptLocation` function?

A: To use the Get-CurrentScriptLocation function, you can simply call it in your script. For example:

$scriptLocation = Get-CurrentScriptLocation
echo "Script file: ($scriptLocation)"

Q: Can I modify the `Get-CurrentScriptLocation` function to suit my needs?

A: Yes, you can modify the Get-CurrentScriptLocation function to suit your needs. For example, you can add additional logic to handle specific cases or modify the function to return different information.

Q: What are some best practices for working with sourced scripts in Nu shell?

A: Here are some best practices for working with sourced scripts in Nu shell:

Use meaningful variable names to help you understand the flow of your script.
Use comments to explain the purpose of your script and how it works.
Test your script thoroughly before running it.
Use the Get-CurrentScriptLocation function to get the current sourced script location.
Modify the Get-CurrentScriptLocation function to suit your needs.

Q: Can I use the `Get-CurrentScriptLocation` function in a loop?

A: Yes, you can use the Get-CurrentScriptLocation function in a loop. For example:

foreach ($script in Get-ChildItem -Path ./lib/*.nu) {
  $scriptLocation = Get-CurrentScriptLocation
  echo "Script file: ($scriptLocation)"
}

Q: What are some common use cases for getting the current sourced script location in Nu shell?

A: Here are some common use cases for getting the current sourced script location in Nu shell:

Logging: When working with complex workflows that involve multiple sourced scripts, it can be helpful to log the current script location.
Error Handling: When an error occurs in a sourced script, it can be helpful to log the current script location.
Script Maintenance: When maintaining a large script that involves multiple sourced scripts, it can be helpful to get the current sourced script location.

Conclusion

In conclusion, getting the current sourced script location in Nu shell is a common task that can be challenging to accomplish. However, by using the $env.FILE_PWD variable in combination with the source command, we can create a better solution that takes care of the details for us. We also created a Nu function that takes care of the details for us, making it easier to get the current sourced script location. By following the best practices outlined in this article, you can write more effective and maintainable scripts that involve multiple sourced scripts.