mirror of
https://github.com/Llewellynvdm/starship.git
synced 2024-11-19 11:35:16 +00:00
20d845f9b3
* refactor(directory): Introduce `logical-path` argument which allows a shell to explicitly specify both a logical and physical filesystem path Fix `directory::module` to consume both path and logical-path (if provided). The "logical" path is preferred when rendering the "display path", while the "physical" path is used to resolve the "read only" flag. Repo- and home-directory contraction behavior is maintained, based on the logical path if it is set, or the physical path if it is not. The custom "get_current_dir" logic has been removed entirely, and the `directory` module now relies on `context.current_dir` / `context.logical_dir` entirely. Changes have been made to `init/starship.ps1` to work with this new flag: - Calculate and pass "physical" and "logical" paths explicitly (as other shells do not pass `--logical-path` that they fall back to rendering the physical path) - Moved the "powershell provider prefix" cleanup code to the PowerShell script - this code _should_ now support any kind of powershell path prefix. * fix(powershell): Fix an issue with trailing backslashes on file paths causing command line parsing issues. This is a bit of a footgun! The work-around chosen is to append a trailing space when a path string ends with a backslash, and then trim any extra whitespace away in the Context constructor. Other alternatives considered and rejected: 1. Always trim trailing backslashes as the filesystem generally doesn't need them. 2. Escape trailing backslashes with another backslash. This proved complex as PS only quotes string args when the string includes some whitespace, and other backslashes within the string apparently don't need to be escaped. * fix(powershell): Use Invoke-Native pattern for safely invoking native executables with strings which may contain characters which need to be escaped carefully. * fix(context): Remove superfluous argument trims These were in place to clean up extra whitespace sometimes injected by starship.ps1::prompt, and are no longer required with the new Invoke-Native helper in place. * refactor(directory): Clean up the semantics of `logical_dir` defaulting it to `current_dir` but overridable by the `--logical-dir` flag. - Restore `use_logical_path` config flag. - Always attempt to contract repo paths from the `current_dir`. * fix(directory) :Use logical_dir for contracting the home directory This keeps the two calls to contract_path in sync. * fix(directory): Remove test script * refactor(directory): Convert current_dir to canonical filesystem path when use_logical_path = false - This requires some clean-up to remove the extended-path prefix on Windows - The configured logical_dir is ignored entirely in this mode - we calculate a new logical_dir by cleaning up the physical_dir path for display. - Test coverage * fix(directory): Use AsRef style for passing Path arguments * fix(directory): Strip the windows extended-path prefix from the display string later in the render process * fix(docs): Update docs/config/README.md for use_logical_path * refactor(context): Populate `current_dir` from `--path` or `std::env::current_dir`, populate `logical_dir` from `--logical-path` or the `PWD` env var - `current_dir` is always canonicalized - On Windows, `current_dir` will have an extended-path prefix - `logical_dir` is now always set - `directory::module` now just selects between `current_dir` and `logical_dir` when picking which path to render - Test coverage * fix(directory): Fix path comparison operations in directory to ignore differences between path prefixes - Added PathExt extension trait which adds `normalised_equals`, `normalised_starts_with` and `without_prefix` * fix(path): Add test coverage for PathExt on *nix * fix(directory): Test coverage for `contract_repo_path`, `contract_path` with variations of verbatim and non-verbatim paths * fix(directory): Update path-slash to latest This fixes the issue with the trailing character of some Windows paths being truncated, e.g. `\\server\share` and `C:` * fix(powershell): Improve UTF8 output handling, argument encoding - Use `ProcessStartInfo` to launch native executable, replacing manual UTF8 output encoding handling - If we detect we're on PWSH6+ use the new `System.Diagnostics.ProcessStartInfo.ArgumentList` parameter, otherwise manually escape the argument string - Move `Get-Cwd` and `Invoke-Native` into the prompt function scope so that they don't leak into the user's shell scope * fix(path): Make PathExt methods no-ops on *nix * fix(path): Cargo fmt * fix(powershell): Remove typo ';'. Fix variable assignment lint. |
||
|---|---|---|
| .. | ||
| .vuepress | ||
| advanced-config | ||
| ar-SA | ||
| ckb-IR | ||
| config | ||
| de-DE | ||
| es-ES | ||
| faq | ||
| fr-FR | ||
| guide | ||
| installing | ||
| it-IT | ||
| ja-JP | ||
| ko-KR | ||
| migrating-to-0.45.0 | ||
| nl-NL | ||
| pl-PL | ||
| presets | ||
| pt-BR | ||
| pt-PT | ||
| ru-RU | ||
| tr-TR | ||
| vi-VN | ||
| zh-CN | ||
| zh-TW | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| home | heroImage | heroText | tagline | actionText | actionLink | features | footer | metaTitle | description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| true | /logo.svg | null | The minimal, blazing-fast, and infinitely customizable prompt for any shell! | Get Started → | ./guide/ |
|
ISC Licensed | Copyright © 2019-present Starship Contributors | Starship: Cross-Shell Prompt | Starship is the minimal, blazing fast, and extremely customizable prompt for any shell! Shows the information you need, while staying sleek and minimal. Quick installation available for Bash, Fish, ZSH, Ion, and PowerShell. |
Quick Install
-
Install the starship binary:
Install Latest Version
With Shell:
curl -fsSL https://starship.rs/install.sh | bashInstall via Package Manager
With Homebrew:
brew install starshipWith Scoop:
scoop install starship -
Add the init script to your shell's config file:
Bash
Add the following to the end of
~/.bashrc:# ~/.bashrc eval "$(starship init bash)"Fish
Add the following to the end of
~/.config/fish/config.fish:# ~/.config/fish/config.fish starship init fish | sourceZsh
Add the following to the end of
~/.zshrc:# ~/.zshrc eval "$(starship init zsh)"Powershell
Add the following to the end of
Microsoft.PowerShell_profile.ps1. You can check the location of this file by querying the$PROFILEvariable in PowerShell. Typically the path is~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1or~/.config/powershell/Microsoft.PowerShell_profile.ps1on -Nix.Invoke-Expression (&starship init powershell)Ion
Add the following to the end of
~/.config/ion/initrc:# ~/.config/ion/initrc eval $(starship init ion)Elvish
::: warning Only elvish v0.15 or higher is supported. :::
Add the following to the end of
~/.elvish/rc.elv:# ~/.elvish/rc.elv eval (starship init elvish)