Skip to content

docs(wrapperModules.nushell): add notes about the differences to normal config file placement #559

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Noah765 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(wrapperModules.nushell): add notes about the differences to normal config file placement #559

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions wrapperModules/n/nushell/module.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@
Provide either `.content` to inline the file contents or `.path` to reference an existing file.
This file is passed to Nushell using `--env-config`, and is typically used to define
environment variables or startup commands that apply to all shells.

Note that Nushell also reads this file in non-interactive environments unless
`--no-config-file` is specified. This is a subtle yet significant difference from
placing the config file at $XDG_CONFIG_HOME/nushell/env.nu. For more details, see
https://www.nushell.sh/book/configuration.html#flag-behavior.
'';
};
"config.nu" = lib.mkOption {
Expand All @@ -32,6 +37,11 @@
Provide either `.content` to inline the file contents or `.path` to reference an existing file.
This file is passed to Nushell using `--config`, and controls general shell behavior,
key bindings, and built-in command settings.

Note that Nushell also reads this file in non-interactive environments unless
`--no-config-file` is specified. This is a subtle yet significant difference from
placing the config file at $XDG_CONFIG_HOME/nushell/config.nu. For more details, see
https://www.nushell.sh/book/configuration.html#flag-behavior.
'';
};
};
Expand Down
Loading