diff --git a/docs/ar-SA/README.md b/docs/ar-SA/README.md index 4767ca0b1..5887681e3 100644 --- a/docs/ar-SA/README.md +++ b/docs/ar-SA/README.md @@ -110,3 +110,16 @@ description: Starship is the minimal, blazing fast, and extremely customizable p eval $(starship init ion) ``` + + #### Elvish + + ::: warning Only elvish v0.15 or higher is supported. ::: + + Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/ar-SA/config/README.md b/docs/ar-SA/config/README.md index 984ef22d4..976885f27 100644 --- a/docs/ar-SA/config/README.md +++ b/docs/ar-SA/config/README.md @@ -209,6 +209,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -371,6 +372,8 @@ The character will tell you whether the last command was successful or not. It c By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). +::: warning `error_symbol` is not supported on elvish shell. ::: + ### Options | Option | Default | Description | @@ -2156,6 +2159,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ::: +::: warning This module is not supported on elvish shell. ::: + ### Options | Option | Default | Description | @@ -2195,7 +2200,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" symbol = "🔴" -format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) ' +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false @@ -2382,6 +2387,40 @@ disabled = false show_always = true ``` +## Vagrant + +The `vagrant` module shows the currently installed version of Vagrant. The module will be shown if any of the following conditions are met: + +- The current directory contains a `Vagrantfile` file + +### Options + +| Option | Default | Description | +| ---------- | ------------------------------------ | --------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `Vagrant` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ---------------- | ------------------------------------ | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + ## Zig The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/ar-SA/guide/README.md b/docs/ar-SA/guide/README.md index c53391a57..319d99b68 100644 --- a/docs/ar-SA/guide/README.md +++ b/docs/ar-SA/guide/README.md @@ -92,6 +92,13 @@ height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Français" /> +   + Tiếng Việt

@@ -211,6 +218,17 @@ eval $(starship init ion) ``` + + #### Elvish + + **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + ## 🤝 Contributing We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/ckb-IR/README.md b/docs/ckb-IR/README.md index 4767ca0b1..5887681e3 100644 --- a/docs/ckb-IR/README.md +++ b/docs/ckb-IR/README.md @@ -110,3 +110,16 @@ description: Starship is the minimal, blazing fast, and extremely customizable p eval $(starship init ion) ``` + + #### Elvish + + ::: warning Only elvish v0.15 or higher is supported. ::: + + Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/ckb-IR/config/README.md b/docs/ckb-IR/config/README.md index 984ef22d4..976885f27 100644 --- a/docs/ckb-IR/config/README.md +++ b/docs/ckb-IR/config/README.md @@ -209,6 +209,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -371,6 +372,8 @@ The character will tell you whether the last command was successful or not. It c By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). +::: warning `error_symbol` is not supported on elvish shell. ::: + ### Options | Option | Default | Description | @@ -2156,6 +2159,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ::: +::: warning This module is not supported on elvish shell. ::: + ### Options | Option | Default | Description | @@ -2195,7 +2200,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" symbol = "🔴" -format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) ' +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false @@ -2382,6 +2387,40 @@ disabled = false show_always = true ``` +## Vagrant + +The `vagrant` module shows the currently installed version of Vagrant. The module will be shown if any of the following conditions are met: + +- The current directory contains a `Vagrantfile` file + +### Options + +| Option | Default | Description | +| ---------- | ------------------------------------ | --------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `Vagrant` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ---------------- | ------------------------------------ | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + ## Zig The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/ckb-IR/guide/README.md b/docs/ckb-IR/guide/README.md index c53391a57..319d99b68 100644 --- a/docs/ckb-IR/guide/README.md +++ b/docs/ckb-IR/guide/README.md @@ -92,6 +92,13 @@ height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Français" /> +   + Tiếng Việt

@@ -211,6 +218,17 @@ eval $(starship init ion) ``` + + #### Elvish + + **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + ## 🤝 Contributing We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/de-DE/README.md b/docs/de-DE/README.md index b26599aba..88bd159c6 100644 --- a/docs/de-DE/README.md +++ b/docs/de-DE/README.md @@ -110,3 +110,16 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P eval $(starship init ion) ``` + + #### Elvish + + ::: warning Only elvish v0.15 or higher is supported. ::: + + Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/de-DE/config/README.md b/docs/de-DE/config/README.md index fbf271cab..7fc923e9d 100644 --- a/docs/de-DE/config/README.md +++ b/docs/de-DE/config/README.md @@ -209,6 +209,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -371,6 +372,8 @@ Das Zeichen zeigt an ob der letzte Befehl erfolgreich war, oder einen Fehler erz By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). +::: warning `error_symbol` is not supported on elvish shell. ::: + ### Optionen | Option | Standardwert | Beschreibung | @@ -1601,7 +1604,7 @@ truncation_symbol = "" The `nim` module shows the currently installed version of Nim. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: -- The current directory contains a `nim.cfg` file +- Das aktuelle Verzeichnis enthält eine `nim.cfg`-Datei - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -1677,7 +1680,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' Das `nodejs`-Modul zeigt die aktuell installierte Version von NodeJS. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: -- The current directory contains a `package.json` file +- Das aktuelle Verzeichnis enthält eine `package.json`-Datei - The current directory contains a `.node-version` file - Das aktuelle Verzeichnis enthält ein `node_modules`-Verzeichnis - The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension @@ -1872,7 +1875,7 @@ format = "via [🦪 $version]($style) " Das `php`-Modul zeigt die aktuell installierte Version von PHP. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: -- The current directory contains a `composer.json` file +- Das aktuelle Verzeichnis enthält eine `composer.json`-Datei - The current directory contains a `.php-version` file - Das aktuelle Verzeichnis enthält eine `.php`-Datei @@ -1908,7 +1911,7 @@ format = "via [🔹 $version](147 bold) " The `purescript` module shows the currently installed version of PureScript version. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: -- The current directory contains a `spago.dhall` file +- Das aktuelle Verzeichnis enthält eine `spago.dhall`-Datei - The current directory contains a \*.purs files ### Optionen @@ -1948,8 +1951,8 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: - Das aktuelle Verzeichnis enthält eine `.python-version`-Datei -- The current directory contains a `requirements.txt` file -- The current directory contains a `pyproject.toml` file +- Das aktuelle Verzeichnis enthält eine `requirements.txt`-Datei +- Das aktuelle Verzeichnis enthält eine `pyproject.toml`-Datei - The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true) - Das aktuelle Verzeichnis enthält eine `Pipfile`-Datei - Das aktuelle Verzeichnis enthält eine `tox.ini`-Datei @@ -2156,6 +2159,8 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis ::: +::: warning This module is not supported on elvish shell. ::: + ### Optionen | Option | Standardwert | Beschreibung | @@ -2195,7 +2200,7 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis [status] style = "bg:blue" symbol = "🔴" -format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) ' +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false @@ -2238,7 +2243,7 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +Das `Terraform` Modul zeigt den aktuell ausgewählten terraform Arbeitsbereich und die Version an. ::: Tipp @@ -2293,7 +2298,7 @@ format = "[🏎💨 $workspace]($style) " ## Zeit -The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. +Das `time` Modul zeigt die aktuelle **lokale** Zeit an. Der `format` Wert wird von der crate [`chrono`](https://crates.io/crates/chrono) benutzt um die Zeit zu formatieren. Schau dir [die chrono strftime Dokumentation](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) an, um die möglichen Optionen zu sehen. ::: Tipp @@ -2313,7 +2318,7 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis | `disabled` | `true` | Deaktiviert das `time`-Modul. | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | -If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. +If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Andernfalls ist es standardmäßig `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. ### Variables @@ -2339,7 +2344,7 @@ time_range = "10:00:00-14:00:00" ## Username -The `username` module shows active user's username. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: +Das `username` Modul zeigt den Namen des aktiven Benutzers. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: - Der aktuelle Benutzer ist root - Der aktuelle Benutzer ist nicht der eingeloggte Benutzer @@ -2382,6 +2387,40 @@ disabled = false show_always = true ``` +## Vagrant + +The `vagrant` module shows the currently installed version of Vagrant. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: + +- The current directory contains a `Vagrantfile` file + +### Optionen + +| Option | Standardwert | Beschreibung | +| ---------- | ------------------------------------ | --------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `style` | `"cyan bold"` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `Vagrant` module. | + +### Variables + +| Variable | Beispiel | Beschreibung | +| --------- | ---------------- | ------------------------------------ | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### Beispiel + +```toml +# ~/.config/starship.toml + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + ## Zig The `zig` module shows the currently installed version of Zig. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: diff --git a/docs/de-DE/guide/README.md b/docs/de-DE/guide/README.md index 176267c44..3ad1e71eb 100644 --- a/docs/de-DE/guide/README.md +++ b/docs/de-DE/guide/README.md @@ -92,6 +92,13 @@ height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Français" /> +   + Tiếng Việt

@@ -211,6 +218,17 @@ eval $(starship init ion) ``` + + #### Elvish + + **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + ## 🤝 Mitwirken Wir laden Leute **aller Erfahrungsstufen** herzlich ein mitzumachen! Falls du dich mit dem Projekt vertaut machen willst, versuche ein [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/es-ES/README.md b/docs/es-ES/README.md index 3a91a166f..994c2ceca 100644 --- a/docs/es-ES/README.md +++ b/docs/es-ES/README.md @@ -110,3 +110,16 @@ description: Starship es el símbolo de sistema minimalista, ultrarápido e infi eval $(starship init ion) ``` + + #### Elvish + + ::: advertencia Solo se admite Elvish v0.15 o superior. ::: + + Añade el siguiente código al final de `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/es-ES/config/README.md b/docs/es-ES/config/README.md index e83787cd5..48498183d 100644 --- a/docs/es-ES/config/README.md +++ b/docs/es-ES/config/README.md @@ -174,7 +174,7 @@ La varieble `format` por defecto se utiliza para definir el formato del prompt, ```toml format = "$all" -# Equivalente a +# Que es equivalente a format = """ $username\ $hostname\ @@ -210,6 +210,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -372,6 +373,8 @@ El carácter te dirá si el último comando funcionó o no. Se puede hacer de do Por defecto sólo cambia el color. Si también se quiere cambiar su forma, ver [este ejemplo](#with-custom-error-shape). +::: advertencia `error_symbol` no es compatible con el intérprete de comandos Elvish. ::: + ### Opciones | Opción | Por defecto | Descripción | @@ -447,15 +450,15 @@ El módulo `cmake` muestra la versión instalada de CMake si se cumple alguna de ## Tiempo de Ejecución -El módulo `cmd_duration` muestra cuánto tiempo tardó el último comando en ejecutarse. El módulo se mostrará solo si el comando llevó dos segundos o más, o el valor de `min_time`, si existe. +El módulo `cmd_duration` muestra cuánto tiempo tomó ejecutarse el último comando. El módulo se mostrará solo si el comando tomó más de dos segundos, o si el valor de configuración de `min_time` existe. -::: warning No utilizar DEBUG en Bash +::: advertencia No utilizar la trampa DEBUG en Bash -Si estás usando Starship con `bash`, no uses `DEBUG` después de ejecutar `eval $(starship init $0)`, o el módulo **se romperá**. +Si se está usando Starship con `bash`, no usar `DEBUG` después de ejecutar `eval $(starship init $0)`, o el módulo **se romperá**. ::: -Los usuarios de bash que necesiten la funcionalidad preexec-like pueden usar el framework rcaloras's bash_preexec. Simplemente define los arrays preexec_functions y precmd_functions antes de ejecutar eval $(starship init $0), y continúa con normalidad. Basta con definir los arrays `preexec_functions` y `precmd_functions` antes de ejecutar `eval $(starship init $0)`, y luego proceder como siempre. +Los usuarios de bash que necesiten una funcionalidad como preexec pueden usar el [framework rcaloras's bash_preexec](https://github.com/rcaloras/bash-preexec). Simplemente definir los arreglos `preexec_functions` y `precmd_functions` antes de ejecutar `eval $(starship init $0)`, y luego proceder de forma normal. ### Opciones @@ -500,7 +503,7 @@ El módulo `conda` muestra el actual entorno conda, si la variable `$CONDA_DEFAU ::: tip -Esto no modifica el propio símbolo de sistema de conda. En caso de querer suprimirlo, ejecuta `conda config --set changeps1 False`. +Esto no modifica el propio prompt de conda. En caso de querer suprimirlo, ejecuta `conda config --set changeps1 False`. ::: @@ -536,7 +539,7 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -El módulo `crystal` muestra la versión actual de Crystal. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +El módulo `crystal` muestra la versión actual instalada de Crystal. El módulo se muestra si algunas de las siguientes condiciones se cumplen: - El directorio actual contiene un fichero `shard.yml` - El directorio actual contiene un fichero `.cr` @@ -609,9 +612,9 @@ format = "via [🔰 $version](bold red) " El módulo `directory` muestra la ruta hasta el directorio actual, mostrando tres directorios padre como máximo. Tu directorio se truncará a la raíz del repositorio git en el que estés. -Cuando usas el estilo fish de la opción pwd, en lugar de ocultar la ruta truncada, verás una versión acortada del nombre de cada directorio basada en el número que activa la opción. +Cuando usas el estilo fish de la opción pwd, en lugar de ocultar la ruta truncada, verás una versión acortada del nombre de cada directorio basada en el número que activaste para la opción. -Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repositorio y el valor de la opción es `1`. En ese caso, verás `~/D/N/nixpkgs/pkgs`, cuando antes hubiera sido `nixpkgs/pkgs`. +Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repositorio y la opción establecida a `1`. En ese caso, verás `~/D/N/nixpkgs/pkgs`, cuando antes hubiera sido `nixpkgs/pkgs`. ### Opciones @@ -625,7 +628,7 @@ Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repos | `read_only` | `"🔒"` | El símbolo que indica si el directorio actual es de sólo lectura. | | `read_only_style` | `"red"` | El estilo para el símbolo de sólo lectura. | | `truncation_symbol` | `""` | El símbolo a prefijar a las rutas truncadas. ej: "…/" | -| `home_symbol` | `"~"` | The symbol indicating home directory. | +| `home_symbol` | `"~"` | El símbolo que indica el directorio personal. |
Este módulo tiene algunas opciones avanzadas de configuración que controlan cómo se muestra el directorio. @@ -669,7 +672,7 @@ truncation_symbol = "…/" ## Docker Context -El módulo `docker_context` muestra el [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) activo si no está a `default`. +El módulo `docker_context` muestra el [contexto de Docker](https://docs.docker.com/engine/context/working-with-contexts/) actualmente activo si no está establecido en `default`. ### Opciones @@ -716,9 +719,9 @@ Este módulo solo se mostrará en tu mensaje cuando uno o más de los siguientes - `*.fsproj` - `*.xproj` -También necesitará tener instalado .NET Core SDK para poder usarlo correctamente. +También necesitarás tener instalado .NET Core SDK para poder usarlo correctamente. -Internamente, este módulo utiliza su propio mecanismo para la detección de versiones. Normalmente es el doble de rápido que ejecutar `dotnet --version`, pero puede mostrar una versión incorrecta si tu proyecto .NET tiene un diseño de directorio inusual. Si la precisión es más importante que la velocidad, puede desactivar el mecanismo estableciendo `heuristic = false` en las opciones del módulo. +Internamente, este módulo utiliza su propio mecanismo para la detección de versiones. Normalmente es el doble de rápido que ejecutar `dotnet --version`, pero puede mostrar una versión incorrecta si tu proyecto .NET tiene un diseño de directorio inusual. Si la precisión es más importante que la velocidad, puede desactivar el mecanismo estableciendo `heurístico = false` en las opciones del módulo. El módulo también mostrará el Target Framework Moniker ([https://docs.microsoft. om/es/dotnet/standard/frameworks#supported-target-framework-versions](https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-framework-versions)) cuando exista un archivo csproj en el directorio actual. @@ -2046,7 +2049,7 @@ symbol = "🔺 " ## Rust -El módulo `rust` muestra la versión instalada de Rust. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +El módulo `rust` muestra la versión actualmente instalada de Rust. El módulo se muestra si algunas de las siguientes condiciones se cumplen: - El directorio actual contiene un archivo `Cargo.toml` - El directorio actual contiene un archivo con la extensión `.rs` @@ -2157,6 +2160,8 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable ::: +::: advertencia Este módulo no es compatible con el intérprete de comandos Elvish. ::: + ### Opciones | Opción | Por defecto | Descripción | @@ -2196,7 +2201,7 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable [status] style = "bg:blue" symbol = "🔴" -format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) ' +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false @@ -2239,11 +2244,11 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +El módulo `terraform` muestra el espacio de trabajo y la versión actual de terraform. ::: tip -By default the terraform version is not shown, since this is slow for current versions of terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-version). +Por defecto no se mostrara la versión actual de terraform, ya que esto es lento en las versiones actuales de terraform cuando muchos plugins están en uso. Si aún deseas activarlo, [sigue el ejemplo que se muestra a continuación](#with-version). ::: @@ -2294,7 +2299,7 @@ format = "[🏎💨 $workspace]($style) " ## Hora -The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. +El módulo `time` muestra la hora **local** actual. El valor de configuración de `format` es usado por la caja de [`chrono`](https://crates.io/crates/chrono) para controlar cómo se muestra la hora. Echa un vistazo a [los documentos de chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) para ver qué opciones están disponibles. ::: tip @@ -2314,7 +2319,7 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable | `disabled` | `true` | Desactiva el módulo `time`. | | `time_range` | `"-"` | Establece el intervalo de tiempo durante el cual el módulo se mostrará. La hora debe ser especificada en formato de 24 horas | -If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. +Si `use_12hr` es `true`, entonces `time_format` por defecto `"%r"`. De lo contrario, el valor por defecto es `"%T"`. Configurar manualmente `time_format` sobrescribirá la configuración `use_12hr`. ### Variables @@ -2340,7 +2345,7 @@ time_range = "10:00:00-14:00:00" ## Nombre de usuario -The `username` module shows active user's username. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +El módulo `username` muestra el nombre de usuario activo. El módulo se muestra si algunas de las siguientes condiciones se cumplen: - El usuario actual es root - El usuario actual no es el mismo que el que está conectado @@ -2349,7 +2354,7 @@ The `username` module shows active user's username. El módulo se muestra si alg ::: tip -SSH connection is detected by checking environment variables `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value. +La conexión SSH se detecta comprobando las variables de entorno `SSH_CONNECTION`, `SSH_CLIENT`, y `SSH_TTY`. Si su host SSH no configura estas variables, una solución es establecer una de ellas con un valor tonto. ::: @@ -2383,9 +2388,43 @@ disabled = false show_always = true ``` +## Vagrant + +El módulo `vagrant` muestra la versión instalada de Vagrant. El módulo se muestra si algunas de las siguientes condiciones se cumplen: + +- El directorio actual contiene un archivo `Vagrantfile` + +### Opciones + +| Opción | Por defecto | Descripción | +| ---------- | ------------------------------------ | ----------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `symbol` | `"⍱ "` | Una cadena de formato que representa el símbolo de Vagrant. | +| `style` | `"cyan bold"` | El estilo del módulo. | +| `disabled` | `false` | Deshabilita el módulo `Vagrant`. | + +### Variables + +| Variable | Ejemplo | Descripción | +| --------- | ---------------- | -------------------------------------- | +| version | `Vagrant 2.2.10` | La versión de `Vagrant` | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | + +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo + +### Ejemplo + +```toml +# ~/.config/starship.toml + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + ## Zig -The `zig` module shows the currently installed version of Zig. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +El módulo `zig` muestra la versión instalada de Zig. El módulo se muestra si algunas de las siguientes condiciones se cumplen: - El directorio actual contiene un archivo `.zig` @@ -2419,9 +2458,9 @@ symbol = "⚡️ " ## Comandos personalizados -The `custom` modules show the output of some arbitrary commands. +Los módulos `personalizados` muestran la salida de algunos comandos arbitrarios. -These modules will be shown if any of the following conditions are met: +Estos módulos se mostrarán si se cumplen alguna de las siguientes condiciones: - El directorio actual contiene un archivo cuyo nombre está en `files` - El directorio actual contiene un directorio cuyo nombre está en `directories` @@ -2430,37 +2469,37 @@ These modules will be shown if any of the following conditions are met: ::: tip -Multiple custom modules can be defined by using a `.`. +Múltiples módulos personalizados pueden definirse usando un `.`. ::: ::: tip -The order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined. +El orden en el que se muestran los módulos personalizados se puede establecer individualmente incluyendo `${custom.foo}` en el `format` de nivel superior (ya que incluye un punto, necesita usar `${...}`). Por defecto, el módulo `custom` simplemente mostrará todos los módulos personalizados en el orden en que fueron definidos. ::: ::: tip -[Issue #1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there! +[El issue #1252](https://github.com/starship/starship/discussions/1252) contiene ejemplos de módulos personalizados. ¡Si tienes un ejemplo interesante no cubierto allí, no dudes en compartirlo! ::: ### Opciones -| Opción | Por defecto | Descripción | -| ------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | -| `command` | | El comando cuya salida debe ser impresa. El comando se pasará en stdin al shell. | -| `when` | | Comando de shell usado como condición para mostrar el módulo. El módulo se mostrará si el comando devuelve un código de estado `0`. | -| `shell` | | [Ver abajo](#custom-command-shell) | -| `description` | `""` | La descripción del módulo que se muestra al ejecutar `starship explain`. | -| `files` | `[]` | Los archivos que se buscarán en el directorio de trabajo para obtener una coincidencia. | -| `directories` | `[]` | Los directorios que se buscarán en el directorio de trabajo para una coincidencia. | -| `extensions` | `[]` | Las extensiones que se buscarán en el directorio de trabajo para obtener una coincidencia. | -| `symbol` | `""` | El símbolo usado antes de mostrar la salida del comando. | -| `style` | `"bold green"` | El estilo del módulo. | -| `format` | `"[$symbol($output )]($style)"` | El formato del módulo. | -| `disabled` | `false` | Desactiva este módulo `custom`. | +| Opción | Por defecto | Descripción | +| ------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `command` | | El comando cuya salida debe ser impresa. El comando se pasará en stdin al shell. | +| `when` | | Un comando de shell usado como condición para mostrar el modulo. El módulo se mostrará si el comando devuelve un código de estado `0`. | +| `shell` | | [Ver a continuación](#custom-command-shell) | +| `description` | `""` | La descripción del módulo que se muestra al ejecutar `starship explain`. | +| `files` | `[]` | Los archivos que se buscarán en el directorio de trabajo para obtener una coincidencia. | +| `directories` | `[]` | Los directorios que se buscarán en el directorio de trabajo para una coincidencia. | +| `extensions` | `[]` | Las extensiones que se buscarán en el directorio de trabajo para obtener una coincidencia. | +| `symbol` | `""` | El símbolo usado antes de mostrar la salida del comando. | +| `style` | `"bold green"` | El estilo del módulo. | +| `format` | `"[$symbol($output )]($style)"` | El formato del módulo. | +| `disabled` | `false` | Desactiva este módulo `custom`. | ### Variables @@ -2474,30 +2513,30 @@ The order in which custom modules are shown can be individually set by including #### Comando personalizado de shell -`shell` accepts a non-empty list of strings, where: +`shell` acepta una lista no vacía de cadenas, donde: - La primera cadena es la ruta al intérprete de comandos a usar para ejecutar el comando. - Otros argumentos siguientes son pasados al shell. -If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows. +Si no está activado, se retornará a STARSHIP_SHELL y luego a "sh" en Linux, y "cmd /C" en Windows. -The `command` will be passed in on stdin. +El `comando` será pasado en stdin. -If `shell` is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: `-NoProfile -Command -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. +Si no se da el `shell` o solo contiene un elemento y Starship detecta PowerShell los siguientes argumentos se añadirán automáticamente: `-NoProfile -Command -`. Este comportamiento puede evitarse pasando explícitamente argumentos al intérprete, p.ej. ```toml shell = ["pwsh", "-Command", "-"] ``` -::: warning Make sure your custom shell configuration exits gracefully +::: advertencia Asegúrate de que tu configuración personalizada de shell salga con éxito -If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option). +Si establece un comando personalizado, asegúrese de que el Shell por defecto usado por starship ejecutará correctamente el comando con una salida elgante (a través de la opción `shell`). -For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop. +Por ejemplo, PowerShell requiere el parámetro `-Command` para ejecutar una sola línea. Omitir este parámetro puede arrojar a starchip a un bucle recursivo donde el shell podría intentar cargar un entorno de perfil completo con starship en sí misma y volver a ejecutar el comando personalizado, entrando en un bucle infinito. -Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation. +Se recomiendan parámetros similares a `-NoProfile` en PowerShell para otros shells para evitar tiempo extra de carga de un perfil personalizado en cada invocación de starship. -Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario. +La detección automática de shells y la adición adecuada de parámetros están actualmente implementados, pero es posible que no todos los shells estén cubiertos. Por favor, [abre un issue](https://github.com/starship/starship/issues/new/choose) con los detalles del intérprete de comandos y la configuración de Starship si te encuentras en tal escenario. ::: diff --git a/docs/es-ES/guide/README.md b/docs/es-ES/guide/README.md index 2c51e270f..c22f6bfa4 100644 --- a/docs/es-ES/guide/README.md +++ b/docs/es-ES/guide/README.md @@ -92,6 +92,13 @@ height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Francés" /> +   + Tiếng Việt

@@ -211,6 +218,17 @@ eval $(starship init ion) ``` + + #### Elvish + + **Advertencia** Sólo se admite Elvish v0.15 o superior. Añade el siguiente código al final de `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + ## 🤝 Colaborando ¡Siempre estamos buscando colaboradores de **todos los niveles y habilidades**! Si estas buscando una manera fácil de ayudar este proyecto, puedes intentar resolver un problema con la etiqueta "[good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)". diff --git a/docs/fr-FR/README.md b/docs/fr-FR/README.md index 4e7f667ef..88a1784bd 100644 --- a/docs/fr-FR/README.md +++ b/docs/fr-FR/README.md @@ -110,3 +110,16 @@ description: Starship est un invite minimaliste, ultra-rapide et hautement perso eval $(starship init ion) ``` + + #### Elvish + + ::: warning Only elvish v0.15 or higher is supported. ::: + + Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/fr-FR/config/README.md b/docs/fr-FR/config/README.md index 95de7a5bc..2c3c1d956 100644 --- a/docs/fr-FR/config/README.md +++ b/docs/fr-FR/config/README.md @@ -209,6 +209,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -371,6 +372,8 @@ Le caractère vous dira si la dernière commande a été réussie ou pas. Cela p Par défaut, il ne change que la couleur. Si vous voulez également changer sa forme, jetez un œil à [cet exemple](#with-custom-error-shape). +::: warning `error_symbol` is not supported on elvish shell. ::: + ### Options | Option | Défaut | Description | @@ -454,7 +457,7 @@ Si vous utilisez starship en `bash`, n'accrochez pas `DEBUG` après avoir exécu ::: -Les utilisateurs de Bash qui ont besoin de fonctionnalité pré-exec peuvent utiliser [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Définissez simplement les array `preexec_functions` et `precmd_functions` avant d'exécuter `eval $(starship init $0)`, puis procédez comme d'habitude. +Les utilisateurs de Bash qui ont besoin de fonctionnalité pré-exec peuvent utiliser [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Définissez simplement les array `preexec_functions` et `precmd_functions` avant d'éxécuter `eval $(starship init $0)`, puis procédez comme d'habitude. ### Options @@ -535,7 +538,7 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -Le module `crystal` affiche la version actuellement installée de Crystal. Le module est affiché si l'une de ces conditions est remplie : +Le module `crystal` affiche la version actuellement installée de Crystal. Le module est affiché si l'une des ces conditions est remplie : - Le répertoire courant contient un fichier `shard.yml` - Le répertoire courant contient un fichier `.cr` @@ -570,7 +573,7 @@ format = "via [✨ $version](bold blue) " ## Dart -Le module `dart` affiche la version courante installée de Dart. Le module est affiché si l'une de ces conditions est remplie : +Le module `dart` affiche la version courante installée de Dart. Le module est affiché si l'une des ces conditions est remplie : - Le répertoire courant contient un fichier `.dart` - Le répertoire courant contient un répertoire `.dart_tool` @@ -1601,7 +1604,7 @@ truncation_symbol = "" The `nim` module shows the currently installed version of Nim. Le module est affiché si l'une des ces conditions est remplie : -- The current directory contains a `nim.cfg` file +- Le répertoire courant contient un fichier `nim.cfg` - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -1677,7 +1680,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' The `nodejs` module shows the currently installed version of NodeJS. Le module est affiché si l'une des ces conditions est remplie : -- The current directory contains a `package.json` file +- Le répertoire courant contient un fichier `package.json` - The current directory contains a `.node-version` file - The current directory contains a `node_modules` directory - The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension @@ -1872,7 +1875,7 @@ format = "via [🦪 $version]($style) " The `php` module shows the currently installed version of PHP. Le module est affiché si l'une des ces conditions est remplie : -- The current directory contains a `composer.json` file +- Le répertoire courant contient un fichier `composer.json` - The current directory contains a `.php-version` file - The current directory contains a `.php` file @@ -1948,8 +1951,8 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name Le module est affiché si l'une des ces conditions est remplie : - The current directory contains a `.python-version` file -- The current directory contains a `requirements.txt` file -- The current directory contains a `pyproject.toml` file +- Le répertoire courant contient un fichier `requirements.txt` +- Le répertoire courant contient un fichier `pyproject.toml` - The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true) - The current directory contains a `Pipfile` file - Le répertoire courant contient un fichier `tox.ini` @@ -2156,6 +2159,8 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur ::: +::: warning This module is not supported on elvish shell. ::: + ### Options | Option | Défaut | Description | @@ -2195,7 +2200,7 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur [status] style = "bg:blue" symbol = "🔴" -format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) ' +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false @@ -2293,7 +2298,7 @@ format = "[🏎💨 $workspace]($style) " ## Temps -The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. +Le module `time` affiche l'heure actuelle **localement**. La valeur de `format` est utilisée par le package [`chrono`](https://crates.io/crates/chrono) pour contrôler la façon dont l'heure est affichée. Consultez la [doc de chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) pour découvrir les options disponibles. ::: tip @@ -2313,7 +2318,7 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur | `disabled` | `true` | Désactiver le module `time`. | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | -If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. +If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Sinon, il est défini comme `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. ### Variables @@ -2339,7 +2344,7 @@ time_range = "10:00:00-14:00:00" ## Nom d'utilisateur -The `username` module shows active user's username. Le module est affiché si l'une des ces conditions est remplie : +Le module `username` affiche le nom d'utilisateur de l'utilisateur actif. Le module est affiché si l'une des ces conditions est remplie : - L'utilisateur courant est root - L'utilisateur courant est différent de celui connecté @@ -2382,6 +2387,40 @@ disabled = false show_always = true ``` +## Vagrant + +The `vagrant` module shows the currently installed version of Vagrant. Le module est affiché si l'une des ces conditions est remplie : + +- The current directory contains a `Vagrantfile` file + +### Options + +| Option | Défaut | Description | +| ---------- | ------------------------------------ | --------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format du module. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `style` | `"cyan bold"` | Le style du module. | +| `disabled` | `false` | Disables the `Vagrant` module. | + +### Variables + +| Variable | Exemple | Description | +| --------- | ---------------- | -------------------------------------- | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| symbol | | Reflète la valeur de l'option `symbol` | +| style\* | | Reflète la valeur de l'option `style` | + +\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style + +### Exemple + +```toml +# ~/.config/starship.toml + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + ## Zig The `zig` module shows the currently installed version of Zig. Le module est affiché si l'une des ces conditions est remplie : @@ -2473,7 +2512,7 @@ The order in which custom modules are shown can be individually set by including #### Commandes shell personnalisées -`shell` accepts a non-empty list of strings, where: +`shell` accepte une liste de chaînes non vide, où: - La première chaîne est le chemin vers le shell à utiliser pour exécuter la commande. - Other following arguments are passed to the shell. diff --git a/docs/fr-FR/guide/README.md b/docs/fr-FR/guide/README.md index d0a288a56..90785c422 100644 --- a/docs/fr-FR/guide/README.md +++ b/docs/fr-FR/guide/README.md @@ -92,6 +92,13 @@ height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Français" /> +   + Tiếng Việt

@@ -211,6 +218,17 @@ eval $(starship init ion) ``` + + #### Elvish + + **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + ## 🤝Contribution Nous sommes toujours à la recherche de contributeurs de **tous niveaux de compétence**! Si vous cherchez à faciliter votre entrée dans le projet, essayez un [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/it-IT/README.md b/docs/it-IT/README.md index 29b05b7a1..4ce32a2d6 100644 --- a/docs/it-IT/README.md +++ b/docs/it-IT/README.md @@ -110,3 +110,16 @@ description: Starship è il prompt minimalista, super veloce ed estremamente per eval $(starship init ion) ``` + + #### Elvish + + ::: warning Only elvish v0.15 or higher is supported. ::: + + Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/it-IT/config/README.md b/docs/it-IT/config/README.md index 9e9e3cf93..1e06b0096 100644 --- a/docs/it-IT/config/README.md +++ b/docs/it-IT/config/README.md @@ -209,6 +209,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -371,6 +372,8 @@ The character will tell you whether the last command was successful or not. It c By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). +::: warning `error_symbol` is not supported on elvish shell. ::: + ### Options | Option | Default | Description | @@ -2156,6 +2159,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ::: +::: warning This module is not supported on elvish shell. ::: + ### Options | Option | Default | Description | @@ -2195,7 +2200,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" symbol = "🔴" -format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) ' +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false @@ -2382,6 +2387,40 @@ disabled = false show_always = true ``` +## Vagrant + +The `vagrant` module shows the currently installed version of Vagrant. The module will be shown if any of the following conditions are met: + +- The current directory contains a `Vagrantfile` file + +### Options + +| Option | Default | Description | +| ---------- | ------------------------------------ | --------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `Vagrant` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ---------------- | ------------------------------------ | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + ## Zig The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/it-IT/guide/README.md b/docs/it-IT/guide/README.md index a99cd23dc..2f0cc7897 100644 --- a/docs/it-IT/guide/README.md +++ b/docs/it-IT/guide/README.md @@ -92,6 +92,13 @@ height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Francese" /> +   + Tiếng Việt

@@ -211,6 +218,17 @@ eval $(starship init ion) ``` + + #### Elvish + + **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + ## 🤝 Contribuire Siamo sempre alla ricerca di collaboratori di **tutti i livelli**! Se stai cercando di entrare facilmente nel progetto, prova un [buon primo problema](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/ja-JP/README.md b/docs/ja-JP/README.md index 756369d52..b72c9a54b 100644 --- a/docs/ja-JP/README.md +++ b/docs/ja-JP/README.md @@ -110,3 +110,16 @@ description: Starship はミニマルで、非常に高速で、カスタマイ eval $(starship init ion) ``` + + #### Elvish + + ::: warning Only elvish v0.15 or higher is supported. ::: + + Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/ja-JP/config/README.md b/docs/ja-JP/config/README.md index a72de6d2f..56e668916 100644 --- a/docs/ja-JP/config/README.md +++ b/docs/ja-JP/config/README.md @@ -210,6 +210,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -372,6 +373,8 @@ style = "bold yellow" デフォルトでは、色だけが変更されます。 If you also want to change it's shape take a look at [this example](#with-custom-error-shape). +::: warning `error_symbol` is not supported on elvish shell. ::: + ### オプション | オプション | デフォルト | 説明 | @@ -1603,7 +1606,7 @@ truncation_symbol = "" The `nim` module shows the currently installed version of Nim. 次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `nim.cfg` file +- カレントディレクトリに`nim.cfg`ファイルが含まれている - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -1874,7 +1877,7 @@ format = "via [🦪 $version]($style) " `php`モジュールは、現在インストールされているPHPのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `composer.json` file +- カレントディレクトリに`composer.json`ファイルが含まれている - The current directory contains a `.php-version` file - カレントディレクトリに`.php`の拡張子のファイルが含まれている @@ -1910,7 +1913,7 @@ format = "via [🔹 $version](147 bold) " The `purescript` module shows the currently installed version of PureScript version. 次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `spago.dhall` file +- カレントディレクトリに`spago.dhall`ファイルが含まれている - The current directory contains a \*.purs files ### オプション @@ -2158,6 +2161,8 @@ The `status` module displays the exit code of the previous command. The module w ::: +::: warning This module is not supported on elvish shell. ::: + ### オプション | オプション | デフォルト | 説明 | @@ -2197,7 +2202,7 @@ The `status` module displays the exit code of the previous command. The module w [status] style = "bg:blue" symbol = "🔴" -format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) ' +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false @@ -2240,7 +2245,7 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +`terraform`モジュールには、現在選択されているterraformワークスペースとバージョンが表示されます。 ::: tip @@ -2295,7 +2300,7 @@ format = "[🏎💨 $workspace]($style) " ## Time -The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. +`time`モジュールは、現在の**現地**時間を示します。 `format`設定は、時間の表示方法を制御するために[`chrono`](https://crates.io/crates/chrono)クレートによって使用されます。 使用可能なオプションを確認するには、[chrono strftimeのドキュメント](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)をご覧ください。 ::: tip @@ -2315,7 +2320,7 @@ The `time` module shows the current **local** time. The `format` configuration v | `disabled` | `true` | `time`モジュールを無効にします。 | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | -If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. +If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. それ以外の場合、デフォルトは`"%T"`です。 Manually setting `time_format` will override the `use_12hr` setting. ### 変数 @@ -2341,7 +2346,7 @@ time_range = "10:00:00-14:00:00" ## ユーザー名 -The `username` module shows active user's username. 次の条件のいずれかが満たされると、モジュールが表示されます。 +`username`モジュールには、アクティブなユーザーのユーザー名が表示されます。 次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントユーザーがroot - カレントユーザーが、ログインしているユーザーとは異なる @@ -2384,6 +2389,40 @@ disabled = false show_always = true ``` +## Vagrant + +The `vagrant` module shows the currently installed version of Vagrant. 次の条件のいずれかが満たされると、モジュールが表示されます。 + +- The current directory contains a `Vagrantfile` file + +### オプション + +| オプション | デフォルト | 説明 | +| ---------- | ------------------------------------ | --------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `style` | `"cyan bold"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `Vagrant` module. | + +### 変数 + +| 変数 | 設定例 | 説明 | +| --------- | ---------------- | ------------------------ | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | + +\*: この変数はスタイル文字列の一部としてのみ使用できます + +### 設定例 + +```toml +# ~/.config/starship.toml + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + ## Zig The `zig` module shows the currently installed version of Zig. 次の条件のいずれかが満たされると、モジュールが表示されます。 diff --git a/docs/ja-JP/guide/README.md b/docs/ja-JP/guide/README.md index 7c0311207..c97c0e7ef 100644 --- a/docs/ja-JP/guide/README.md +++ b/docs/ja-JP/guide/README.md @@ -92,6 +92,13 @@ height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Français" /> +   + Tiếng Việt

@@ -211,6 +218,17 @@ eval $(starship init ion) ``` + + #### Elvish + + **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + ## 🤝 貢献 私たちは常に**すべてのスキルレベル**の貢献者を探しています！ もし簡単にプロジェクトへ参加する方法をお探しなら、 [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) に取り組んでみてください。 diff --git a/docs/ko-KR/README.md b/docs/ko-KR/README.md index cfdd95989..ee4bc3eea 100644 --- a/docs/ko-KR/README.md +++ b/docs/ko-KR/README.md @@ -110,3 +110,16 @@ description: Starship is the minimal, blazing fast, and extremely customizable p eval $(starship init ion) ``` + + #### Elvish + + ::: warning Only elvish v0.15 or higher is supported. ::: + + Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/ko-KR/config/README.md b/docs/ko-KR/config/README.md index 984ef22d4..976885f27 100644 --- a/docs/ko-KR/config/README.md +++ b/docs/ko-KR/config/README.md @@ -209,6 +209,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -371,6 +372,8 @@ The character will tell you whether the last command was successful or not. It c By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). +::: warning `error_symbol` is not supported on elvish shell. ::: + ### Options | Option | Default | Description | @@ -2156,6 +2159,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ::: +::: warning This module is not supported on elvish shell. ::: + ### Options | Option | Default | Description | @@ -2195,7 +2200,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" symbol = "🔴" -format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) ' +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false @@ -2382,6 +2387,40 @@ disabled = false show_always = true ``` +## Vagrant + +The `vagrant` module shows the currently installed version of Vagrant. The module will be shown if any of the following conditions are met: + +- The current directory contains a `Vagrantfile` file + +### Options + +| Option | Default | Description | +| ---------- | ------------------------------------ | --------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `Vagrant` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ---------------- | ------------------------------------ | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + ## Zig The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/ko-KR/guide/README.md b/docs/ko-KR/guide/README.md index 407933fb9..3203fc17c 100644 --- a/docs/ko-KR/guide/README.md +++ b/docs/ko-KR/guide/README.md @@ -92,6 +92,13 @@ height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Français" /> +   + Tiếng Việt

@@ -211,6 +218,17 @@ eval $(starship init ion) ``` + + #### Elvish + + **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + ## 🤝 기여 We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/nl-NL/README.md b/docs/nl-NL/README.md index 4767ca0b1..5887681e3 100644 --- a/docs/nl-NL/README.md +++ b/docs/nl-NL/README.md @@ -110,3 +110,16 @@ description: Starship is the minimal, blazing fast, and extremely customizable p eval $(starship init ion) ``` + + #### Elvish + + ::: warning Only elvish v0.15 or higher is supported. ::: + + Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/nl-NL/config/README.md b/docs/nl-NL/config/README.md index 984ef22d4..976885f27 100644 --- a/docs/nl-NL/config/README.md +++ b/docs/nl-NL/config/README.md @@ -209,6 +209,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -371,6 +372,8 @@ The character will tell you whether the last command was successful or not. It c By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). +::: warning `error_symbol` is not supported on elvish shell. ::: + ### Options | Option | Default | Description | @@ -2156,6 +2159,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ::: +::: warning This module is not supported on elvish shell. ::: + ### Options | Option | Default | Description | @@ -2195,7 +2200,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" symbol = "🔴" -format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) ' +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false @@ -2382,6 +2387,40 @@ disabled = false show_always = true ``` +## Vagrant + +The `vagrant` module shows the currently installed version of Vagrant. The module will be shown if any of the following conditions are met: + +- The current directory contains a `Vagrantfile` file + +### Options + +| Option | Default | Description | +| ---------- | ------------------------------------ | --------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `Vagrant` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ---------------- | ------------------------------------ | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + ## Zig The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/nl-NL/guide/README.md b/docs/nl-NL/guide/README.md index c53391a57..319d99b68 100644 --- a/docs/nl-NL/guide/README.md +++ b/docs/nl-NL/guide/README.md @@ -92,6 +92,13 @@ height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Français" /> +   + Tiếng Việt

@@ -211,6 +218,17 @@ eval $(starship init ion) ``` + + #### Elvish + + **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + ## 🤝 Contributing We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/pl-PL/README.md b/docs/pl-PL/README.md index 4767ca0b1..5887681e3 100644 --- a/docs/pl-PL/README.md +++ b/docs/pl-PL/README.md @@ -110,3 +110,16 @@ description: Starship is the minimal, blazing fast, and extremely customizable p eval $(starship init ion) ``` + + #### Elvish + + ::: warning Only elvish v0.15 or higher is supported. ::: + + Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/pl-PL/config/README.md b/docs/pl-PL/config/README.md index 984ef22d4..976885f27 100644 --- a/docs/pl-PL/config/README.md +++ b/docs/pl-PL/config/README.md @@ -209,6 +209,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -371,6 +372,8 @@ The character will tell you whether the last command was successful or not. It c By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). +::: warning `error_symbol` is not supported on elvish shell. ::: + ### Options | Option | Default | Description | @@ -2156,6 +2159,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ::: +::: warning This module is not supported on elvish shell. ::: + ### Options | Option | Default | Description | @@ -2195,7 +2200,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" symbol = "🔴" -format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) ' +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false @@ -2382,6 +2387,40 @@ disabled = false show_always = true ``` +## Vagrant + +The `vagrant` module shows the currently installed version of Vagrant. The module will be shown if any of the following conditions are met: + +- The current directory contains a `Vagrantfile` file + +### Options + +| Option | Default | Description | +| ---------- | ------------------------------------ | --------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `Vagrant` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ---------------- | ------------------------------------ | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + ## Zig The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/pl-PL/guide/README.md b/docs/pl-PL/guide/README.md index c53391a57..319d99b68 100644 --- a/docs/pl-PL/guide/README.md +++ b/docs/pl-PL/guide/README.md @@ -92,6 +92,13 @@ height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Français" /> +   + Tiếng Việt

@@ -211,6 +218,17 @@ eval $(starship init ion) ``` + + #### Elvish + + **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + ## 🤝 Contributing We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/pt-BR/README.md b/docs/pt-BR/README.md index 24226b348..6714e8244 100644 --- a/docs/pt-BR/README.md +++ b/docs/pt-BR/README.md @@ -110,3 +110,16 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam eval $(starship init ion) ``` + + #### Elvish + + ::: warning Only elvish v0.15 or higher is supported. ::: + + Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/pt-BR/config/README.md b/docs/pt-BR/config/README.md index 0a9d1cacc..0a2728683 100644 --- a/docs/pt-BR/config/README.md +++ b/docs/pt-BR/config/README.md @@ -209,6 +209,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -371,6 +372,8 @@ The character will tell you whether the last command was successful or not. It c By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). +::: warning `error_symbol` is not supported on elvish shell. ::: + ### Opções | Option | Padrão | Descrição | @@ -2156,6 +2159,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ::: +::: warning This module is not supported on elvish shell. ::: + ### Opções | Option | Padrão | Descrição | @@ -2195,7 +2200,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" symbol = "🔴" -format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) ' +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false @@ -2382,6 +2387,40 @@ disabled = false show_always = true ``` +## Vagrant + +The `vagrant` module shows the currently installed version of Vagrant. The module will be shown if any of the following conditions are met: + +- The current directory contains a `Vagrantfile` file + +### Opções + +| Option | Padrão | Descrição | +| ---------- | ------------------------------------ | --------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `style` | `"cyan bold"` | O estilo do módulo. | +| `disabled` | `false` | Disables the `Vagrant` module. | + +### Variables + +| Variável | Exemplo | Descrição | +| --------- | ---------------- | ------------------------------------ | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### Exemplo + +```toml +# ~/.config/starship.toml + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + ## Zig The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/pt-BR/guide/README.md b/docs/pt-BR/guide/README.md index 385831474..9cfd80d84 100644 --- a/docs/pt-BR/guide/README.md +++ b/docs/pt-BR/guide/README.md @@ -92,6 +92,13 @@ height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Français" /> +   + Tiếng Việt

@@ -211,6 +218,17 @@ eval $(starship init ion) ``` + + #### Elvish + + **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + ## 🤝 Contribuindo Nós estamos sempre procurando contribuidores de **todos os níveis de conhecimento**! Se você está buscando um caminho mais fácil para começar no projeto, veja essas [boas issues para começar](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/pt-PT/README.md b/docs/pt-PT/README.md index 4767ca0b1..5887681e3 100644 --- a/docs/pt-PT/README.md +++ b/docs/pt-PT/README.md @@ -110,3 +110,16 @@ description: Starship is the minimal, blazing fast, and extremely customizable p eval $(starship init ion) ``` + + #### Elvish + + ::: warning Only elvish v0.15 or higher is supported. ::: + + Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/pt-PT/config/README.md b/docs/pt-PT/config/README.md index 984ef22d4..976885f27 100644 --- a/docs/pt-PT/config/README.md +++ b/docs/pt-PT/config/README.md @@ -209,6 +209,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -371,6 +372,8 @@ The character will tell you whether the last command was successful or not. It c By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). +::: warning `error_symbol` is not supported on elvish shell. ::: + ### Options | Option | Default | Description | @@ -2156,6 +2159,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ::: +::: warning This module is not supported on elvish shell. ::: + ### Options | Option | Default | Description | @@ -2195,7 +2200,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" symbol = "🔴" -format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) ' +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false @@ -2382,6 +2387,40 @@ disabled = false show_always = true ``` +## Vagrant + +The `vagrant` module shows the currently installed version of Vagrant. The module will be shown if any of the following conditions are met: + +- The current directory contains a `Vagrantfile` file + +### Options + +| Option | Default | Description | +| ---------- | ------------------------------------ | --------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `Vagrant` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ---------------- | ------------------------------------ | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + ## Zig The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/pt-PT/guide/README.md b/docs/pt-PT/guide/README.md index c53391a57..319d99b68 100644 --- a/docs/pt-PT/guide/README.md +++ b/docs/pt-PT/guide/README.md @@ -92,6 +92,13 @@ height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Français" /> +   + Tiếng Việt

@@ -211,6 +218,17 @@ eval $(starship init ion) ``` + + #### Elvish + + **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + ## 🤝 Contributing We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/ru-RU/README.md b/docs/ru-RU/README.md index 04a39dae0..9b008285d 100644 --- a/docs/ru-RU/README.md +++ b/docs/ru-RU/README.md @@ -110,3 +110,16 @@ description: Starship - минимальная, быстрая и бесконе eval $(starship init ion) ``` + + #### Elvish + + ::: warning Only elvish v0.15 or higher is supported. ::: + + Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/ru-RU/config/README.md b/docs/ru-RU/config/README.md index db35423c8..bf8657ab2 100644 --- a/docs/ru-RU/config/README.md +++ b/docs/ru-RU/config/README.md @@ -209,6 +209,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -371,6 +372,8 @@ style = "bold yellow" By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). +::: warning `error_symbol` is not supported on elvish shell. ::: + ### Опции | Параметр | По умолчанию | Описание | @@ -1601,7 +1604,7 @@ truncation_symbol = "" The `nim` module shows the currently installed version of Nim. Модуль будет показан, если любое из следующих условий соблюдено: -- The current directory contains a `nim.cfg` file +- Текущий каталог содержит файл `nim.cfg` - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -1908,7 +1911,7 @@ format = "via [🔹 $version](147 bold) " The `purescript` module shows the currently installed version of PureScript version. Модуль будет показан, если любое из следующих условий соблюдено: -- The current directory contains a `spago.dhall` file +- Текущий каталог содержит файл `spago.dhall` - The current directory contains a \*.purs files ### Опции @@ -2156,6 +2159,8 @@ The `status` module displays the exit code of the previous command. The module w ::: +::: warning This module is not supported on elvish shell. ::: + ### Опции | Параметр | По умолчанию | Описание | @@ -2195,7 +2200,7 @@ The `status` module displays the exit code of the previous command. The module w [status] style = "bg:blue" symbol = "🔴" -format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) ' +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false @@ -2238,7 +2243,7 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +Модуль `terraform` показывает выбранную рабочую область и версию terraform. ::: tip @@ -2293,7 +2298,7 @@ format = "[🏎💨 $workspace]($style) " ## Время -The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. +Модуль `time` показывает текущее **локальное** время. Значение конфигурации `format` используется пакетом [`chrono`](https://crates.io/crates/chrono) для контроля того, как отображается время. Ознакомьтесь с [документацией chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html), чтобы увидеть доступные параметры. ::: tip @@ -2313,7 +2318,7 @@ The `time` module shows the current **local** time. The `format` configuration v | `disabled` | `true` | Отключает модуль `time`. | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | -If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. +If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Иначе по умолчанию используется `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. ### Переменные @@ -2339,7 +2344,7 @@ time_range = "10:00:00-14:00:00" ## Имя пользователя -The `username` module shows active user's username. Модуль будет показан, если любое из следующих условий соблюдено: +Модуль `username` показывает имя текущего пользователя. Модуль будет показан, если любое из следующих условий соблюдено: - Текущий пользователь - root - Текущий пользователь отличается от залогиненного @@ -2382,6 +2387,40 @@ disabled = false show_always = true ``` +## Vagrant + +The `vagrant` module shows the currently installed version of Vagrant. Модуль будет показан, если любое из следующих условий соблюдено: + +- The current directory contains a `Vagrantfile` file + +### Опции + +| Параметр | По умолчанию | Описание | +| ---------- | ------------------------------------ | --------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `style` | `"cyan bold"` | Стиль модуля. | +| `disabled` | `false` | Disables the `Vagrant` module. | + +### Переменные + +| Переменная | Пример | Описание | +| ---------- | ---------------- | ------------------------------------ | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| symbol | | Отражает значение параметра `symbol` | +| style\* | | Отражает значение параметра `style` | + +\*: Эта переменная может использоваться только в качестве части строки style + +### Пример + +```toml +# ~/.config/starship.toml + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + ## Zig The `zig` module shows the currently installed version of Zig. Модуль будет показан, если любое из следующих условий соблюдено: diff --git a/docs/ru-RU/guide/README.md b/docs/ru-RU/guide/README.md index 4da3c323c..f6a7c157a 100644 --- a/docs/ru-RU/guide/README.md +++ b/docs/ru-RU/guide/README.md @@ -92,6 +92,13 @@ height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Français" /> +   + Tiếng Việt

@@ -211,6 +218,17 @@ eval $(starship init ion) ``` + + #### Elvish + + **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + ## 🤝 Помощь Мы всегда ищем помощь людей **всех уровней навыков**! Если вы хотите облегчить свой путь к проекту, посмотрите хорошие первые ошибки ([first good issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)). diff --git a/docs/tr-TR/README.md b/docs/tr-TR/README.md index 4767ca0b1..5887681e3 100644 --- a/docs/tr-TR/README.md +++ b/docs/tr-TR/README.md @@ -110,3 +110,16 @@ description: Starship is the minimal, blazing fast, and extremely customizable p eval $(starship init ion) ``` + + #### Elvish + + ::: warning Only elvish v0.15 or higher is supported. ::: + + Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/tr-TR/config/README.md b/docs/tr-TR/config/README.md index 984ef22d4..976885f27 100644 --- a/docs/tr-TR/config/README.md +++ b/docs/tr-TR/config/README.md @@ -209,6 +209,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -371,6 +372,8 @@ The character will tell you whether the last command was successful or not. It c By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). +::: warning `error_symbol` is not supported on elvish shell. ::: + ### Options | Option | Default | Description | @@ -2156,6 +2159,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ::: +::: warning This module is not supported on elvish shell. ::: + ### Options | Option | Default | Description | @@ -2195,7 +2200,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" symbol = "🔴" -format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) ' +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false @@ -2382,6 +2387,40 @@ disabled = false show_always = true ``` +## Vagrant + +The `vagrant` module shows the currently installed version of Vagrant. The module will be shown if any of the following conditions are met: + +- The current directory contains a `Vagrantfile` file + +### Options + +| Option | Default | Description | +| ---------- | ------------------------------------ | --------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `Vagrant` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ---------------- | ------------------------------------ | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + ## Zig The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/tr-TR/guide/README.md b/docs/tr-TR/guide/README.md index c53391a57..319d99b68 100644 --- a/docs/tr-TR/guide/README.md +++ b/docs/tr-TR/guide/README.md @@ -92,6 +92,13 @@ height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Français" /> +   + Tiếng Việt

@@ -211,6 +218,17 @@ eval $(starship init ion) ``` + + #### Elvish + + **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + ## 🤝 Contributing We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/vi-VN/README.md b/docs/vi-VN/README.md index 567441302..edcdc3a41 100644 --- a/docs/vi-VN/README.md +++ b/docs/vi-VN/README.md @@ -108,5 +108,18 @@ description: Starship là prompt nhỏ, cực nhanh, và khả năng tuỳ biế ```sh # ~/.config/ion/initrc -eval $(starship init ion) +eval $(starship init ion) ``` + + #### Elvish + + ::: warning Only elvish v0.15 or higher is supported. ::: + + Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/vi-VN/config/README.md b/docs/vi-VN/config/README.md index f7cf7d568..e2022be07 100644 --- a/docs/vi-VN/config/README.md +++ b/docs/vi-VN/config/README.md @@ -173,7 +173,7 @@ Mặc định `format` được sử dụng để định nghĩa định dạng ```toml format = "$all" -# Cái đó tương đương với +# Which is equivalent to format = """ $username\ $hostname\ @@ -209,6 +209,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -371,6 +372,8 @@ Kí tự sẽ nói cho bạn câu lệnh cuối liệu thành công hay thất b Mặc định, nó chỉ thay đổi màu. Nếu bạn cũng muốn thay đổi hình dạng, tham khảo [ví dụ này](#with-custom-error-shape). +::: warning `error_symbol` is not supported on elvish shell. ::: + ### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | @@ -497,7 +500,7 @@ format = "underwent [$duration](bold yellow)" Module `conda` cho biết môi trường conda hiện tại, nếu `$CONDA_DEFAULT_ENV` được thiết lập. -::: thủ thuật +::: thử thuật Cái này không loại bỏ conda's prompt mà nó sở hữu, bạn có thể muốn chạy `conda config --set changeps1 False`. @@ -535,7 +538,7 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -Module `crystal` cho biết phiên bản hiện tại của Crystal được đã cài đặt. Module sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: +Module `crystal` cho biết phiên bản hiện tại của Crystal được đã cài đặt. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: - Đường dẫn hiện tại chứa một tập tin `shard.yml` - Đường dẫn hiện tại chứa một tập tin `.cr` @@ -1601,7 +1604,7 @@ truncation_symbol = "" The `nim` module shows the currently installed version of Nim. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: -- The current directory contains a `nim.cfg` file +- Đường dẫn hiện tại chứa một tập tin `nim.cfg` - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -1677,7 +1680,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' The `nodejs` module shows the currently installed version of NodeJS. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: -- The current directory contains a `package.json` file +- Đường dẫn hiện tại chứa một tập tin `package.json` - The current directory contains a `.node-version` file - The current directory contains a `node_modules` directory - The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension @@ -1872,7 +1875,7 @@ format = "via [🦪 $version]($style) " The `php` module shows the currently installed version of PHP. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: -- The current directory contains a `composer.json` file +- Đường dẫn hiện tại chứa một tập tin `composer.json` - The current directory contains a `.php-version` file - The current directory contains a `.php` file @@ -1908,7 +1911,7 @@ format = "via [🔹 $version](147 bold) " The `purescript` module shows the currently installed version of PureScript version. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: -- The current directory contains a `spago.dhall` file +- Đường dẫn hiện tại chứa một tập tin `spago.dhall` - The current directory contains a \*.purs files ### Các tuỳ chọn @@ -1948,8 +1951,8 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: - The current directory contains a `.python-version` file -- The current directory contains a `requirements.txt` file -- The current directory contains a `pyproject.toml` file +- Đường dẫn hiện tại chứa một tập tin `requirements.txt` +- Đường dẫn hiện tại chứa một tập tin `pyproject.toml` - The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true) - The current directory contains a `Pipfile` file - Đường dẫn hiện tại chứa một tập tin `tox.ini` @@ -2156,6 +2159,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ::: +::: warning This module is not supported on elvish shell. ::: + ### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | @@ -2195,7 +2200,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" symbol = "🔴" -format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) ' +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false @@ -2382,6 +2387,40 @@ disabled = false show_always = true ``` +## Vagrant + +The `vagrant` module shows the currently installed version of Vagrant. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: + +- The current directory contains a `Vagrantfile` file + +### Các tuỳ chọn + +| Tuỳ chọn | Mặc định | Mô tả | +| ---------- | ------------------------------------ | --------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `style` | `"cyan bold"` | Kiểu cho module. | +| `disabled` | `false` | Disables the `Vagrant` module. | + +### Các biến + +| Biến | Ví dụ | Mô tả | +| --------- | ---------------- | -------------------------------- | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| symbol | | Giá trị ghi đè tuỳ chọn `symbol` | +| style\* | | Giá trị ghi đè của `style` | + +\*: Biến này có thể chỉ được sử dụng như một phần của style string + +### Ví dụ + +```toml +# ~/.config/starship.toml + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + ## Zig The `zig` module shows the currently installed version of Zig. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: diff --git a/docs/vi-VN/guide/README.md b/docs/vi-VN/guide/README.md index 66356f313..551a47e24 100644 --- a/docs/vi-VN/guide/README.md +++ b/docs/vi-VN/guide/README.md @@ -92,6 +92,13 @@ height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Thiếng Pháp" /> +   + Tiếng Việt

@@ -211,6 +218,17 @@ eval $(starship init ion) ``` + + #### Elvish + + **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + ## 🤝 Đóng góp Chúng tôi luôn luôn tìm kiếm những cộng tác viên ở **tất cả các các mức độ về kĩ năng**! Nếu bạn đang tìm kiếm cách dễ dàng để tham gia vào dự án, thử một [good issue đầu tiên](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/zh-CN/README.md b/docs/zh-CN/README.md index 9a27229af..336ceacbb 100644 --- a/docs/zh-CN/README.md +++ b/docs/zh-CN/README.md @@ -110,3 +110,16 @@ description: Starship is the minimal, blazing fast, and extremely customizable p eval $(starship init ion) ``` + + #### Elvish + + ::: warning Only elvish v0.15 or higher is supported. ::: + + Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/zh-CN/config/README.md b/docs/zh-CN/config/README.md index a43ec41aa..546123b23 100644 --- a/docs/zh-CN/config/README.md +++ b/docs/zh-CN/config/README.md @@ -209,6 +209,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -371,6 +372,8 @@ style = "bold yellow" By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). +::: warning `error_symbol` is not supported on elvish shell. ::: + ### 配置项 | Option | 默认值 | 描述 | @@ -1601,7 +1604,7 @@ truncation_symbol = "" The `nim` module shows the currently installed version of Nim. 此组件将在符合以下任意条件之一时显示： -- The current directory contains a `nim.cfg` file +- 当前目录包含一个 `nim.cfg` 文件 - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -1908,7 +1911,7 @@ format = "via [🔹 $version](147 bold) " The `purescript` module shows the currently installed version of PureScript version. 此组件将在符合以下任意条件之一时显示： -- The current directory contains a `spago.dhall` file +- 当前目录包含一个 `spago.dhall` 文件 - The current directory contains a \*.purs files ### 配置项 @@ -2156,6 +2159,8 @@ The `status` module displays the exit code of the previous command. The module w ::: +::: warning This module is not supported on elvish shell. ::: + ### 配置项 | Option | 默认值 | 描述 | @@ -2195,7 +2200,7 @@ The `status` module displays the exit code of the previous command. The module w [status] style = "bg:blue" symbol = "🔴" -format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) ' +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false @@ -2238,7 +2243,7 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +`terraform` 组件显示当前选定的 terraform 工作区和版本。 ::: tip @@ -2293,7 +2298,7 @@ format = "[🏎💨 $workspace]($style) " ## Time -The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. +`time` 组件显示当前的 **本地** 时间。 `format` 字段值会提供给 [`chrono`](https://crates.io/crates/chrono) crate 用来控制时间显示方式。 请参阅 [chrono strftime 文档](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) 以了解可用格式选项。 ::: tip @@ -2313,7 +2318,7 @@ The `time` module shows the current **local** time. The `format` configuration v | `disabled` | `true` | 禁用 `time` 组件。 | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | -If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. +If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. 否则，其默认值为 `"%T"`。 Manually setting `time_format` will override the `use_12hr` setting. ### Variables @@ -2339,7 +2344,7 @@ time_range = "10:00:00-14:00:00" ## Username -The `username` module shows active user's username. 此组件将在符合以下任意条件之一时显示： +`username` 组件显示当前活跃的用户名。 此组件将在符合以下任意条件之一时显示： - 当前用户是 root - 当前用户与登录用户不相同 @@ -2382,6 +2387,40 @@ disabled = false show_always = true ``` +## Vagrant + +The `vagrant` module shows the currently installed version of Vagrant. 此组件将在符合以下任意条件之一时显示： + +- The current directory contains a `Vagrantfile` file + +### 配置项 + +| Option | 默认值 | 描述 | +| ---------- | ------------------------------------ | --------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `style` | `"cyan bold"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `Vagrant` module. | + +### Variables + +| 字段 | 示例 | 描述 | +| --------- | ---------------- | ------------------------ | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| symbol | | `symbol`对应值 | +| style\* | | `style`对应值 | + +\*: This variable can only be used as a part of a style string + +### 示例 + +```toml +# ~/.config/starship.toml + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + ## Zig The `zig` module shows the currently installed version of Zig. 此组件将在符合以下任意条件之一时显示： diff --git a/docs/zh-CN/guide/README.md b/docs/zh-CN/guide/README.md index 303ce8ccc..6ccaf3e6c 100644 --- a/docs/zh-CN/guide/README.md +++ b/docs/zh-CN/guide/README.md @@ -92,6 +92,13 @@ height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Français" /> +   + Tiếng Việt

@@ -211,6 +218,17 @@ eval $(starship init ion) ``` + + #### Elvish + + **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + ## 🤝 贡献 我们一直在寻找贡献者！你都可以参与贡献 ** 不论你的技能如何 **。 如果您希望快速为项目作出贡献，请尝试解决 [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)。 diff --git a/docs/zh-TW/README.md b/docs/zh-TW/README.md index e49ee500b..10da9cda6 100644 --- a/docs/zh-TW/README.md +++ b/docs/zh-TW/README.md @@ -110,3 +110,16 @@ description: Starship is the minimal, blazing fast, and extremely customizable p eval $(starship init ion) ``` + + #### Elvish + + ::: warning Only elvish v0.15 or higher is supported. ::: + + Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/zh-TW/config/README.md b/docs/zh-TW/config/README.md index 8764de52e..fb20f59d2 100644 --- a/docs/zh-TW/config/README.md +++ b/docs/zh-TW/config/README.md @@ -209,6 +209,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -371,6 +372,8 @@ style = "bold yellow" By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). +::: warning `error_symbol` is not supported on elvish shell. ::: + ### 選項 | Option | 預設 | 說明 | @@ -1601,7 +1604,7 @@ truncation_symbol = "" The `nim` module shows the currently installed version of Nim. 這個模組在下列其中一個條件達成時顯示： -- The current directory contains a `nim.cfg` file +- 現在資料夾中包含一個 `nim.cfg` 檔案 - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -1872,7 +1875,7 @@ format = "via [🦪 $version]($style) " The `php` module shows the currently installed version of PHP. 這個模組在下列其中一個條件達成時顯示： -- The current directory contains a `composer.json` file +- 現在資料夾中包含一個 `composer.json` 檔案 - The current directory contains a `.php-version` file - The current directory contains a `.php` file @@ -1908,7 +1911,7 @@ format = "via [🔹 $version](147 bold) " The `purescript` module shows the currently installed version of PureScript version. 這個模組在下列其中一個條件達成時顯示： -- The current directory contains a `spago.dhall` file +- 現在資料夾中包含一個 `spago.dhall` 檔案 - The current directory contains a \*.purs files ### 選項 @@ -2156,6 +2159,8 @@ The `status` module displays the exit code of the previous command. The module w ::: +::: warning This module is not supported on elvish shell. ::: + ### 選項 | Option | 預設 | 說明 | @@ -2195,7 +2200,7 @@ The `status` module displays the exit code of the previous command. The module w [status] style = "bg:blue" symbol = "🔴" -format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) ' +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false @@ -2382,6 +2387,40 @@ disabled = false show_always = true ``` +## Vagrant + +The `vagrant` module shows the currently installed version of Vagrant. 這個模組在下列其中一個條件達成時顯示： + +- The current directory contains a `Vagrantfile` file + +### 選項 + +| Option | 預設 | 說明 | +| ---------- | ------------------------------------ | --------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `style` | `"cyan bold"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `Vagrant` module. | + +### Variables + +| 變數 | 範例 | 說明 | +| --------- | ---------------- | ------------------------------------ | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +\*: This variable can only be used as a part of a style string + +### 範例 + +```toml +# ~/.config/starship.toml + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + ## Zig The `zig` module shows the currently installed version of Zig. 這個模組在下列其中一個條件達成時顯示： diff --git a/docs/zh-TW/guide/README.md b/docs/zh-TW/guide/README.md index 8a7897e2e..a3aa0d891 100644 --- a/docs/zh-TW/guide/README.md +++ b/docs/zh-TW/guide/README.md @@ -92,6 +92,13 @@ height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Français" /> +   + Tiếng Việt

@@ -211,6 +218,17 @@ eval $(starship init ion) ``` + + #### Elvish + + **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + ## 🤝 貢獻 我們歡迎具有**各式各樣能力**的貢獻者！ 如果你正在尋找容易加入的方法，試試看標註為「[good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)」的 issue。