summaryrefslogtreecommitdiffstats
path: root/docs/config/README.md
AgeCommit message (Collapse)Author
3 daysdocs: fix copy-paste typos in config docs (#5995)Tej Chajed
docs: Fix copy-paste typos in config docs The symbol config line for Gleam was copied from Go, for Haxe was copied from Helm, and for Typst was copied from Daml.
2024-05-15feat(nats): Add NATS Context (#5900)John Hooks
--------- Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
2024-04-14docs: fix typo in README.md (#5902)redistay
docs: fix typos in README.md Signed-off-by: redistay <wujunjing@outlook.com>
2024-04-06feat(k8s): Add detect env vars option (#4488)Thomas O'Donnell
* feat(k8s): Add detect env vars option Have added the option to trigger the k8s module based on what env vars are set, this has been done in a backwards compatible way so if nothing is changed from the defaults the module will still behave the same way as before. This is similar to what I did in #4486 for the python module and if goes well I'd like to rollout to other modules. * Update src/modules/kubernetes.rs Co-authored-by: David Knaack <davidkna@users.noreply.github.com> * Update src/modules/kubernetes.rs --------- Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
2024-04-05feat(username): add aliases option (#5855)Alper Cugun
* Create place to put it in the config * Initial functional version * Fix grammar * Add option documentation to README * Add test for two aliases and emoji translation * Remove println * Rewrite match as iflet * Improve converting the reference * Format file * Try to restore autoformat of markdown * Replace toml:Map with concrete IndexMap * Update schema * Add option that got lost
2024-04-05feat(odin): Add Odin Lang module (#5873)[Error_27]
* Add Odin lang module * add utils string and remove commit number from output * switch to new symbol because ZWJ support is rare * add config docs * add option to show the commit number * fix lack of trimming * fix formatting to comply with checks * Add trailing newline to comply with cargo fmt * Add new Odin test and add newline in cmd output
2024-04-05feat(gleam): Add Gleam module (#5886)boreinhardt
Co-authored-by: benno.reinhardt <benno.reinhardt@silbury.com>
2024-03-30fix(bun): change default icon (#5880)Ramy
* feat: change bun icon #5871 * fix: reverts docs
2024-03-21docs(bun): Add nodejs override to bun config documentation (#5834)Alper Cugun
2024-03-21feat(os): add new os symbols (#5849)David Knaack
2024-03-20feat: $gemset variable for Ruby module (#5429)marcybell
* $gemset variable for Ruby module * typo * Added test for no GEM_HOME env set * Formatting * Uses `rvm current` for gemset, no more version num
2024-03-20feat(quarto): Add Quarto module (#5820)Virgile Andreani
Add Quarto module * Adapted from the Typst module
2024-03-20feat(username): add detect_env_vars as option (#5833)Mick Hohmann
* Added the option "detect_env_vars" to the `username` module with the same functionality as in the `hostname` module. * Fixed logic error and added test to catch it * build(deps): update dependency vitepress to ^1.0.0-rc.45 * build(deps): update rust crate shadow-rs to 0.27.1 * Added the option "detect_env_vars" to the `username` module with the same functionality as in the `hostname` module. * Fixed logic error and added test to catch it * Removed unused gix import * Removed unused gix import, again * Removed unused gix import. Next try --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-03-09docs(python): Remove a bad config example in the python (#5830)Jan Katins
docs(python): Remove a bad config example in the python Running a unknown binary in a subfolder (called `.venv/bin/python`) has at least two drawbacks with some security implication: - In case of a unknown directory, simply cd'ing into a subdirectory could lead to starship executing a unknown binary (usually the binary MUST be in path so it's a decision taken by the user, e.g. by activating the venv) - starship would show the result of the venv python even if the venv is not active but calling `python3` on the cli would NOT run that `python3` in the venv but a different one (most likely the system python3).
2024-03-07docs: Fix git status $all_status documentation (#5826)Brandon Dong
* add `typechanged` to git status $all_status documentation * Revert dog changes for other languages
2024-03-03feat(docs): move to vitepress (#5785)David Knaack
* feat(docs): move to vitepress * change up hero styles to match existing site * A bit more style tweaking * Replace stylus with plain CSS * improve unicode-range value for nerdfont --------- Co-authored-by: Matan Kushner <hello@matchai.dev>
2024-01-11docs(battery): add space after symbol in example (#5695)CAESIUS_TIM
docs(battery): add space after symbol in example (#5695)
2024-01-06fix(direnv): update to work with direnv v2.33 (#5657)Camron Flanders
* update AllowStatus to work with direnv 2.33 direnv now returns int enum instead of boolean, https://github.com/direnv/direnv/pull/1158 * update schema * maybe fixed the schema now * Whoops, I inverted the flags somehow * have coffee, fix mistaken understanding * undo changes to tranlations * Update docs/config/README.md * Update src/modules/direnv.rs Co-authored-by: David Knaack <davidkna@users.noreply.github.com> * update test output --------- Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
2023-12-17feat(direnv): add new direnv module (#5157)Andrew Pantuso
2023-12-17feat(aws): Adding the AWS SSO CLI env variable to profile list (#5640)Stefan Richter
Adding the AWS SSO CLI env variable to profile list Adding support for the profile env variable used by https://github.com/synfinatic/aws-sso-cli
2023-12-14docs: Fix typo in gcloud description (#5634)ecksun
2023-11-25feat(shell): allow distinguishing between pwsh and powershell (#5478)Gilbert Sanchez
* Distinguish between pwsh and powershell Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
2023-11-12feat: add typst moduleCharlotte Thomas
Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
2023-11-02feat(scanner): add option not to follow symlinks (#5325)Ohad Lutzky
Add follow_symlinks option Settings this to false can fix hanging on symlinks to slow/inaccessible filesystems.
2023-10-29docs(config): Add quote to unquoted strings, unifying quotes (#5480)Macilenta
* docs(config): add quote to unquoted strings Add quote to unquoted strings There are some unquoted default value strings in module's "options" table * docs(config): Unify quotes in Option table some strings in modules' "options" table are wrapped in single quotes, some are wrapped in double quotes, standardize them to be wrapped in single quotes * docs(config): Format file using dprint
2023-09-16feat(hostname): add detect_env_vars as option (#5196)Mick Hohmann
* Added hostname.detect_env_vars based on the newly added context::detect_env_vars - extended context::detect_env_vars to check for negated environment variables as well, analogous to the other detect modules - made hostname.detect_env_vars only active if ssh_only is set to false for backwards compatibility Co-authored-by: Dominik Sander <dsander@users.noreply.github.com> * added clippy recommendations, removed unneeded comments * Added new logic (suggested in https://github.com/starship/starship/pull/5196#issuecomment-1566228913) The new `detect_env_vars` now requires either SSH_ONLY to be false or the environment variable SSH_CONNECTION to be set, so that is will be used * Fixed typo * Refactored the detect_env_vars function for early returns and better readability * Change boolean logic for better readability Co-authored-by: David Knaack <davidkna@users.noreply.github.com> * Apply suggestions from code review to `detect_env_vars` method. Co-authored-by: David Knaack <davidkna@users.noreply.github.com> * Fixed bracket error & updated comments - fixed bracket error in hostname.rs, after changes - updated comments for context.rs, for the suggested changes * Removed obsolete warning from docs/config/README.md Co-authored-by: David Knaack <davidkna@users.noreply.github.com> --------- Co-authored-by: Dominik Sander <dsander@users.noreply.github.com> Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
2023-09-02feat(kubernetes): Add styling based on current context (#4550)Jan Katins
* feat(kubernetes): Add styling based on current context Add an ability to customize the configuration of the kubernetes module style, based on the current context. A new variable is added to the config section, called environments, which is a list of possible customizations. Each such customization is an object with a context_pattern regex, which matches context name, and an optional style and icon that will override the global configuration, if the currently used context matched the context_pattern. Based on multiple attempts to add per-context styling and symbols to the kubernetes module. - https://github.com/starship/starship/pull/1568 by @lht https://github.com/lht -> base - https://github.com/starship/starship/pull/614 by @nomaed https://github.com/nomaed -> naming, symbol, some tests Rebased and combined by @jankatins Contains the following squasched commits - Rename to contexts and move aliases into contexts - Move deprecated functions to a submodule - Cleanup: ignore None-valued KubeCtxComponents - Add regex func + clean up matching-context search - Placate paper clip Closes: https://github.com/starship/starship/issues/570 Co-authored-by: =?UTF-8?q?Boris=20Aranovic=CC=8C?= <nomaed@gmail.com> Co-authored-by: Jan Katins <jasc@gmx.net> Co-authored-by: Kevin Song <chips@ksong.dev> * refactor(kubernetes): Remove options and use clearer names * test(kubernetes): Handle duplicated contexts right * refactor(kubernetes): Cleaner user matching * fix(kubernetes): Only show warning in case of problems * feat(kubernetes): Add back alias replacements * refactor(kubernetes): Cleanup rust usage --------- Co-authored-by: Haitao Li <lihaitao@gmail.com> Co-authored-by: =?UTF-8?q?Boris=20Aranovic=CC=8C?= <nomaed@gmail.com> Co-authored-by: Kevin Song <chips@ksong.dev> Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
2023-09-02feat(fossil_metrics): add fossil_metrics module (#4874)Vegard Skui
* feat(fossil_metrics): add fossil_metrics module * Return early if not in a Fossil check-out * Add more tests for fossil_metrics * Move is in Fossil checkout check after module enabled check * Update type for new toml version * Update the config file schema * Rework parsing of fossil diff output * Fix Fossil check-out detection in subdirectories * Use regex to only match expected fossil diff output * Use shared ancestor scanning and fix detection on Windows * Add note on minimum Fossil version
2023-07-27docs(directory): specify option name in example (#5324)thenbe
* docs(directory): specify option name in example It took me longer than I'd like to admit to figure out what option this example was referring to. It didn't help that the referenced option is hidden in a collapsible, which evaded any attempt made through the browser's find `ctrl+f` functionality. * more natural grammar
2023-07-14feat(shlvl): add repeat_offset for repeated symbol (#5289)Vivek Kushwaha
Signed-off-by: Vivek Kushwaha <yoursvivek@users.noreply.github.com>
2023-06-01feat(nodejs): Add `expected_version` variable (#5081)marcybell
* add `expected_version` variable to `nodejs` * show comparison symbols with `expected_version` * documentation, formatting, more tests * Remapped `engines_version` to $version * Added better descriptions to docs * Update docs/config/README.md Co-authored-by: David Knaack <davidkna@users.noreply.github.com> * Removed clone from `nodejs`, formatting * refactored function calls * rewrote `engines_version` formatter * Moved Lazy variables into maps --------- Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
2023-06-01feat(golang): adding `mod_version` variable (#5177)marcybell
2023-05-10fix: update of presets and default configuration to reflect changes in Nerd ↵Mick Hohmann
Fonts 3.0 (#5162) * Updated nf-mdi-* to nf-md-* symbols The following symbols where changed - directory.read_only - memory_usage - meson - nim - os.symbols.Garuda - os.symbols.HardenedBSD - os.symbols.Illumos - os.symbols.OpenBSD - os.symbols.OracleLinux - os.symbols.Redox - os.symbols.Solus - os.symbols.Windows - package - rlang * Updated nf-mdi-* to nf-md-* symbols (for all other presets) The following symbols where changed for pastel-powerline: - directory.substitutions.Documents - nim for tokyo-night - directory.substitutions.Documents - golang * Updated nf-mdi-* to nf-md-* symbols for the default configuration in modules in src/configs/*.rs The following symbols where changed - azure - battery.full_symbol - battery.charging_symbol - battery.discharging_symbol - battery.unknown_symbol - battery.empty_symbol * Updated config-schema.json * Updated src/modules/*.rs docs/config/README.md and used `nerdfix` to check if I overlook anything * Fixed the battery discharging symbol in the tests --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: jtrv <travershasemail@gmail.com>
2023-05-09feat(gcloud): add `detect_env_vars` option (#5166)Denis Cornehl
* feat(gcloud): add `detect_env_vars` option * regenerate config schema
2023-05-09feat(aws): support aws sso with automatic authentication refresh (#5170)kensasongko
* feat(aws): support aws sso with automatic authentication refresh * docs(aws): add sso_session for profile detection
2023-04-13feat: Add Solidity Module (#5047)AnirbanHalder654322
* Adding documentation * Documentation and schema addition * Creating solidity config * Module for solidity lang * Updating all the files * Changing according to clippy * Fixing misspellings * Changes suggested by clippy * Updating schema , maybe fixing docs workflow error * Updating schema * Removing solcjs from default compiler list * Fallback test added and test string fixed * Fixing docs * Updating schema * Updating schema * Fixing docs * Updating schema * Updating schema * Typo fix * Update docs/config/README.md Co-authored-by: David Knaack <davidkna@users.noreply.github.com> * Update src/utils.rs Co-authored-by: David Knaack <davidkna@users.noreply.github.com> * Fix build commit --------- Co-authored-by: Anirban Halder <shaeo967@gmail.com> Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
2023-04-13feat(git_metrics): add option to ignore submodules (#5052)Colton Donnelly
* add docs * update schema * ok, actually update schema * add test * fix lint * accidentally included my .devenv directory
2023-04-13feat(azure): subscription name aliases (#4949)marcybell
* From issue #4448, added `subscription_aliases` as a field for the Azure module Can be set in starship.toml with [azure.subscription_aliases] * Updated config file schema * Added entry into documentation * Update README.md * Formatted with dprint
2023-04-13feat: add typechange to git_status module (#4829)Chad Denyar
Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
2023-04-10build(deps): update rust crate os_info to 3.7.0 (#5057)David Knaack
* build(deps): update rust crate os_info to 3.7.0 * add new os symbols --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-04-02feat(custom): add option to check if pwd is in a repo (#4822)jliaoh
* feat(custom): add option to check if pwd is in a repo * Apply suggestions from code review Co-authored-by: David Knaack <davidkna@users.noreply.github.com> * change whenrepo to require_repo * chore: fix doc formatting --------- Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
2023-03-07docs(character): use updated `vimcmd_symbol` instead of older `vicmd_symbol` ↵Jan Dittrich
variant (#4960) Fix typo in character example
2023-02-20docs(kubernetes): Remove extra backspace from regex in example (#4905)Tom Fenech
Remove extra backspace from regex in example In the example, `[\\w-]` would match a literal backspace `\`, the character `w` or a dash `-`. By removing the backspace, instead it matches any "word character" `\w` or a dash `-`.
2023-02-11feat(java): Add `.sdkmanrc` for Java (#4888)iuhoay
* Add `.sdkmanrc` for Java * Update config-schema.json, Add `.sdkmanrc` file for Java * Update doc
2023-02-07docs: fix typos (#4889)Zhizhen He
2023-02-07build(deps): update rust crate os_info to 3.6.0 (#4878)David Knaack
* build(deps): update rust crate os_info to 3.6.0 * add new os symbols --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-01-31feat(fossil_branch): add fossil_branch module (#4806)Vegard Skui
Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
2022-12-31feat: add pijul_channel module (#4765)Lyle Mantooth
* feat: Pijul VCS support * Extra bits needed for new module. * Format Markdown table. * Fix lint. * Don't test Pijul module so thoroughly. Installing from source is too expensive, and compiled binaries are only available for Windows (and unofficially as well). Perhaps once Pijul 1.0.0 comes out of beta there will be more binaries available in package repos. * Format! * Bad rebase, remove Pijul install from workflow. * Mock Pijul commands for code coverage. * Make fake .pijul directory in fixture. * Truly mock `pijul` command. * Rename module from `pijul` to `pijul_channel`. * Format! * Fix config-schema.json. * Missed changing module name in docs/ folder.
2022-12-31feat(hg_branch): Add support for mercurial topics and find hg root dir (#4771)Nicolas Évrard
* feat(hg_branch): Add support for mercurial topics and find hg root dir * Fix clippy errors * Use crate::utils::read_file * Update config-schema.json * Extend PathExt to retrieve device ID of Path * Break hg root search when switching to another device * Fix clippy and formatting errors * Update docs/config/README.md Co-authored-by: David Knaack <davidkna@users.noreply.github.com> * Update src/modules/utils/path.rs Co-authored-by: David Knaack <davidkna@users.noreply.github.com> * Update src/configs/hg_branch.rs Co-authored-by: David Knaack <davidkna@users.noreply.github.com> * Update hg_branch description * Revert to lazy loading, use truncate_text from utils and use fake topic * Format code and fix clippy error * Revert to previous test string as topic is optional in the config * Fix doc formatting * Stub device_id for windows * Update config-schema.json * Update src/modules/hg_branch.rs Co-authored-by: David Knaack <davidkna@users.noreply.github.com> * Do not use unwrap in device_id * Fix formatter error * Use dev under non linux unixes Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
2022-12-28feat(env_var): Add support for env_var.VAR in format (#4497)David Knaack
Co-Authored-By: Segev Finer <24731903+segevfiner@users.noreply.github.com> Co-authored-by: Segev Finer <24731903+segevfiner@users.noreply.github.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-04 08:30:11 +0000