Repository navigation
docs(book): configure the prompt through $env.config.prompt - #2293
Draft
kronberger-droid wants to merge 1 commit into
Draft
kronberger-droid wants to merge 1 commit into
kronberger-droid wants to merge 1 commit into
Conversation
Describes nushell 0.118, where nushell/nushell#18734 moved the prompt out of the `PROMPT_*` environment variables. Not for merging before that release, since the book follows the released version. The translated pages and the generated `commands/docs` are left alone.
This branch has not been deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
nushell/nushell#18734 moved the prompt out of the
PROMPT_*environment variables into$env.config.prompt, and the book still taught the variables.This updates the English book pages for 0.118.
It should not be merged before 0.118.0 is released, since the keys do not exist in 0.117.
Before
The book configured the prompt through
$env.PROMPT_COMMAND,$env.PROMPT_INDICATORand friends,$env.config.render_right_prompt_on_last_line, andhide-env TRANSIENT_PROMPT_COMMANDto reset the transient prompt.Two of those now error on a default setup: reading
$env.PROMPT_COMMAND, and thehide-env.After
book/configuration.md: the prompt and transient prompt sections list the$env.config.promptkeys, say which accept a closure, show how to wrap and restore the default prompt, and carry one note on the deprecated variables.book/coloring_and_theming.md: same keys, the new vi indicator defaults, and that unstyled prompt text now keeps the terminal foreground (fix(prompt): don't tint a supplied prompt with the default colors nushell#18686).book/3rdpartyprompts.md: the manual oh-my-posh and Starship snippets set the config keys.book/line_editor.md: Helix select mode usesvi_visual.book/environment.md,book/coming_from_cmd.md: one example each that used$env.PROMPT_COMMAND.Additional notes
Every snippet was run on a build of
main.The translated pages and the generated
commands/docsare not touched.