mirror of
https://github.com/nushell/nushell.git
synced 2025-05-01 08:34:26 +02:00
<!--
if this PR closes one or more issues, you can automatically link the PR
with
them by using one of the [*linking
keywords*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword),
e.g.
- this PR should close #xxxx
- fixes #xxxx
you can also mention related issues, PRs or discussions!
-->
# Description
<!--
Thank you for improving Nushell. Please, check our [contributing
guide](../CONTRIBUTING.md) and talk to the core team before making major
changes.
Description of your pull request goes here. **Provide examples and/or
screenshots** if your changes affect the user experience.
-->
In this PR I continued the idea of #11494, it added an `auto` option to
the ansi coloring config option, I did this too but in a more simple
approach.
So I added a new enum `UseAnsiColoring` with the three values `True`,
`False` and `Auto`. When that value is set to `auto`, the default value,
it will use `std::io::stdout().is_terminal()` to decided whether to use
ansi coloring. This allows to dynamically decide whether to print ansi
color codes or not, [cargo does it the same
way](
|
||
---|---|---|
.. | ||
default_config.nu | ||
default_env.nu | ||
doc_config.nu | ||
doc_env.nu | ||
README.md | ||
scaffold_config.nu | ||
scaffold_env.nu |
Nushell configuration files
default_env.nu
:
- The internal default environment variables (other than
$env.config
) that will be set during Nushell startup. - Is loaded before the user's
env.nu
. - Will be loaded during any startup where the user's
env.nu
is also loaded. For example:- During normal startup with
nu
- During a startup where the user specifies an alternative
env.nu
vianu --env-config <path>
- During a
nu -c <commandstring>
ornu <script>
startup so thatENV_CONVERSIONS
is properly handled for Windows.
- During normal startup with
- Is not loaded when running with an explicit
no --no-config-file (-n)
. - Is not commented - Comments are in
doc_env.nu
. - Should be optimized for fastest load times.
- Can be introspected via
config env --default | nu-highlight
default_config.nu
:
Counterpart to default_env.nu
.
- Contains any
$env.config
values that are not set via Rust defaults. - Is loaded after the user's
env.nu
. - Is loaded before the user's
config.nu
. - Will be loaded during any startup where the user's
config.nu
is also loaded. For example:- During normal startup with
nu
- During a startup where the user specifies an alternative
config.nu
vianu --config <path>
- During normal startup with
- Likewise, is never loaded during a startup where the user's
config.nu
would not be loaded. For example:nu -n/--no-config
nu -c "ls"
nu <script.nu>
- Is not commented - Comments are in
doc_config.nu
. - Should be optimized for fastest load times. Whenever possible, values should be set via nu-protocol::config
- Exception:
color_config
values are currently set in this file so that user's can introspect the values - TODO: Implement defaults for
color_config
in nu-protocol::config and remove fromdefault_config.nu
- Exception:
- Can be introspected via
config nu --default | nu-highlight
- An ideal
default_config.nu
(when all values are set vianu-protocol::config
) will simply be:$env.config = {}
doc_env.nu
- A commented file documenting the most common environment variables that a user might configure in
env.nu
- For convenient in-shell access - Can be pretty-printed via
config env --doc | nu-highlight
- Since this file is for documentation only, include actual Nushell code without comments so that it can be pretty-printed
- No optimization necessary - Not intended for use other than documentation.
- Consider replacing
config env --doc
withhelp env.nu
at some point. - Uses a mix of default values (explained) as well as other examples that users might want in their own
env.nu
doc_config.nu
Counterpart to doc_env.nu
.
- A commented file documenting the most common environment variables that a user might configure in
config.nu
- For convenient in-shell access - Can be pretty-printed via
config nu --doc | nu-highlight
- Since this file is for documentation only, include actual Nushell code without comments so that it can be pretty-printed
- No optimization necessary - Not intended for use other than documentation.
- Consider replacing
config nu --doc
withhelp config.nu
at some point. - Uses a mix of default values (explained) as well as other examples that users might want in their own
config.nu
scaffold_env.nu
- This file is used one-time (typically) at first startup
- If the
$nu.default-config-path
directory does not exist, the directory is created and then bothscaffold_env.nu
andscaffold_config.nu
are written to it - Contains only commented lines explaining the purpose of the file to the user, along with information on the
config env
command.
scaffold_config.nu
Counterpart to scaffold_env.nu
.
- This file is used one-time (typically) at first startup
- If the
$nu.default-config-path
directory does not exist, the directory is created and then bothscaffold_env.nu
andscaffold_config.nu
are written to it - Contains only commented lines explaining the purpose of the file to the user, along with information on the
config nu
command.