Document deprecation of $env.NU_LIB_DIRS #2101
Open
+13
−7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The $env.NU_LIB_DIRS has been marked deprecated in the nushell source code for a while now, by default it is an empty list to maintain compatibility. Users should prefer the constant $NU_LIB_DIRS instead, which is populated with some things based on environment variables at nushell startup. The docs had drifted a bit. This commit serves to update them.
Author
|
@ysthakur are you able to take a look? |
Member
|
Sorry, slipped my mind. Yes, I'll take a look today or tomorrow |
ysthakur
requested changes
Jan 9, 2026
Member
ysthakur
left a comment
ysthakur
left a comment
There was a problem hiding this comment.
Looks pretty good, thanks for improving our docs. Just some minor comments
|
|
||
| ### `$env.NU_LIB_DIRS` | ||
|
|
||
| ::: note |
Member
There was a problem hiding this comment.
I think ::: warning works better here
| - `$env.XDG_DATA_HOME`: If this environment variable is set, Nushell sets the `$nu.data-dir` constant to `($env.XDG_DATA_HOME)/nushell`. The `data-dir` is used in several startup tasks: | ||
|
|
||
| - `($nu.data-dir)/completions` is added to the `$env.NU_LIB_DIRS` search path. | ||
| - `($nu.data-dir)/completions` is added to the `const` variable `$NU_LIB_DIRS` search path. (Note: `$env.NU_LIB_DIRS` is not populated by default and is currently deprecated. See [Special Variables - `$env.NU_LIB_DIRS`](./special_variables.md#env-NU_LIB_DIRS).) |
Member
There was a problem hiding this comment.
I'm not sure the entire note is necessary, but it can't hurt. A link to the $NU_LIB_DIRS docs would be helpful though
Suggested change
| - `($nu.data-dir)/completions` is added to the `const` variable `$NU_LIB_DIRS` search path. (Note: `$env.NU_LIB_DIRS` is not populated by default and is currently deprecated. See [Special Variables - `$env.NU_LIB_DIRS`](./special_variables.md#env-NU_LIB_DIRS).) | |
| - `($nu.data-dir)/completions` is added to the `const` variable [`$NU_LIB_DIRS`](./special_variables.md#NU_LIB_DIRS). (Note: `$env.NU_LIB_DIRS` is not populated by default and is currently deprecated. See [Special Variables - `$env.NU_LIB_DIRS`](./special_variables.md#env-NU_LIB_DIRS).) |
| ::: important Important! Importing modules from `$env.NU_LIB_DIRS` | ||
| When importing a module via a relative path, Nushell first searches from the current directory. If a matching module is not found at that location, Nushell then searches each directory in the `$env.NU_LIB_DIRS` list. | ||
| ::: important Important! Importing modules from `$NU_LIB_DIRS` or `$env.NU_LIB_DIRS` | ||
| When importing a module via a relative path, Nushell first searches from the current directory. If a matching module is not found at that location, Nushell then searches each directory in the constant `$NU_LIB_DIRS` list, and then `$env.NU_LIB_DIRS`. |
Member
There was a problem hiding this comment.
Not super important, but if possible, it'd be good to put a "(deprecated)" when the env var is mentioned.
Suggested change
| When importing a module via a relative path, Nushell first searches from the current directory. If a matching module is not found at that location, Nushell then searches each directory in the constant `$NU_LIB_DIRS` list, and then `$env.NU_LIB_DIRS`. | |
| When importing a module via a relative path, Nushell first searches from the current directory. If a matching module is not found at that location, Nushell then searches each directory in the constant `$NU_LIB_DIRS` list, and then `$env.NU_LIB_DIRS` (deprecated). |
If you choose to do this, the Plugins overview also has a mention of $env.NU_LIB_DIRS
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sorry I took a bit longer to draft these changes, I'm going to blame the holiday spirit for my laziness :)
See #2096 for some context.
I went through the docs to see where else the variables in question were mentioned and I updated them. I'm not competent to maintain the other translations, I'm afraid.
I'm also not sure if I got the hyperlinks and the formatting right - those in the know will have to guide me. I tried cargo-culting from other examples.