diff --git a/docs/ar-SA/config/README.md b/docs/ar-SA/config/README.md index cb488c9f..2c432f89 100644 --- a/docs/ar-SA/config/README.md +++ b/docs/ar-SA/config/README.md @@ -3,7 +3,7 @@ To get started configuring starship, create the following file: `~/.config/starship.toml`. ```sh -mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml +mkdir -p ~/.config && touch ~/.config/starship.toml ``` All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: @@ -49,9 +49,9 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ### Terminology -**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project. +**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project. -**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of NodeJS. +**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js. By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix. @@ -384,7 +384,7 @@ The character will tell you whether the last command was successful or not. It c - changing color (`red`/`green`) - changing shape (`❯`/`✖`) -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). +By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). ::: warning `error_symbol` is not supported on elvish shell. ::: @@ -437,22 +437,23 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met: +The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met: - The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeCache.txt` file ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `cmake` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"△ "` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `cmake` module. | ### Variables @@ -555,22 +556,23 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met: +The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `shard.yml` file - The current directory contains a `.cr` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | --------------------------------------------------------- | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | -| `style` | `"bold red"` | The style for the module. | -| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | -| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `crystal` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `"bold red"` | The style for the module. | +| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | +| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `disabled` | `false` | Disables the `crystal` module. | ### Variables @@ -593,7 +595,7 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory @@ -601,15 +603,16 @@ The `dart` module shows the currently installed version of Dart. By default the ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | -| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `dart` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | +| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. | +| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `dart` module. | ### Variables @@ -632,20 +635,21 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of Deno. By default the module will be shown if any of the following conditions are met: +The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"green bold"` | The style for the module. | -| `disabled` | `false` | Disables the `deno` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"green bold"` | The style for the module. | +| `disabled` | `false` | Disables the `deno` module. | ### Variables @@ -764,7 +768,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -786,16 +790,17 @@ The module will also show the Target Framework Moniker ( ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager. @@ -1949,7 +1965,7 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file @@ -1959,15 +1975,16 @@ The `perl` module shows the currently installed version of Perl. By default the ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | -| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | -| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | -| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 149"` | The style for the module. | -| `disabled` | `false` | Disables the `perl` module. | +| Option | Default | Description | **** | +| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- | +| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | +| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | +| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | | +| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | | +| `detect_folders` | `[]` | Which folders should trigger this module. | | +| `style` | `"bold 149"` | The style for the module. | | +| `disabled` | `false` | Disables the `perl` module. | | ### Variables @@ -1988,7 +2005,7 @@ format = "via [🦪 $version]($style) " ## PHP -The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `composer.json` file - The current directory contains a `.php-version` file @@ -1996,15 +2013,16 @@ The `php` module shows the currently installed version of PHP. By default the mo ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | -| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | -| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"147 bold"` | The style for the module. | -| `disabled` | `false` | Disables the `php` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | +| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"147 bold"` | The style for the module. | +| `disabled` | `false` | Disables the `php` module. | ### Variables @@ -2027,22 +2045,23 @@ format = "via [🔹 $version](147 bold) " ## PureScript -The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: - The current directory contains a `spago.dhall` file - The current directory contains a file with the `.purs` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | -| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold white"` | The style for the module. | -| `disabled` | `false` | Disables the `purescript` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | +| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold white"` | The style for the module. | +| `disabled` | `false` | Disables the `purescript` module. | ### Variables @@ -2065,7 +2084,7 @@ format = "via [$symbol$version](bold white)" ## Python -The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. @@ -2092,7 +2111,7 @@ By default the module will be shown if any of the following conditions are met: | `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | -| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | +| `detect_extensions` | `["py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2143,7 +2162,7 @@ detect_extensions = [] ## Red -By default the `red` module shows the currently installed version of Red. The module will be shown if any of the following conditions are met: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a file with `.red` or `.reds` extension @@ -2181,7 +2200,7 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Gemfile` file - The current directory contains a `.ruby-version` file @@ -2221,7 +2240,7 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Cargo.toml` file - The current directory contains a file with the `.rs` extension @@ -2260,7 +2279,7 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension @@ -2268,15 +2287,16 @@ The `scala` module shows the currently installed version of Scala. By default th ### Options -| Option | Default | Description | -| ------------------- | ---------------------------------------- | ------------------------------------------------- | -| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | -| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | -| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | -| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | -| `style` | `"red dimmed"` | The style for the module. | -| `disabled` | `false` | Disables the `scala` module. | +| Option | Default | Description | +| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `style` | `"red dimmed"` | The style for the module. | +| `disabled` | `false` | Disables the `scala` module. | ### Variables @@ -2309,17 +2329,18 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ### Options -| Option | Default | Description | -| ---------------------- | ------------ | --------------------------------------------- | -| `bash_indicator` | `bsh` | A format string used to represent bash. | -| `fish_indicator` | `fsh` | A format string used to represent fish. | -| `zsh_indicator` | `zsh` | A format string used to represent zsh. | -| `powershell_indicator` | `psh` | A format string used to represent powershell. | -| `ion_indicator` | `ion` | A format string used to represent ion. | -| `elvish_indicator` | `esh` | A format string used to represent elvish. | -| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | -| `format` | `$indicator` | The format for the module. | -| `disabled` | `true` | Disables the `shell` module. | +| Option | Default | Description | +| ---------------------- | ------------ | ------------------------------------------------------------ | +| `bash_indicator` | `bsh` | A format string used to represent bash. | +| `fish_indicator` | `fsh` | A format string used to represent fish. | +| `zsh_indicator` | `zsh` | A format string used to represent zsh. | +| `powershell_indicator` | `psh` | A format string used to represent powershell. | +| `ion_indicator` | `ion` | A format string used to represent ion. | +| `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | +| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `format` | `$indicator` | The format for the module. | +| `disabled` | `true` | Disables the `shell` module. | ### Variables @@ -2335,6 +2356,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [shell] fish_indicator = "" powershell_indicator = "_" +unknown_indicator = "mystery shell" disabled = false ``` @@ -2376,7 +2398,7 @@ threshold = 3 ## Singularity -The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Options @@ -2391,7 +2413,7 @@ The `singularity` module shows the current singularity image, if inside a contai | Variable | Example | Description | | --------- | ------------ | ------------------------------------ | -| env | `centos.img` | The current singularity image | +| env | `centos.img` | The current Singularity image | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2465,22 +2487,23 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | -| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 202"` | The style for the module. | -| `disabled` | `false` | Disables the `swift` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | +| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold 202"` | The style for the module. | +| `disabled` | `false` | Disables the `swift` module. | ### Variables @@ -2503,11 +2526,11 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: 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). +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-terraform-version). ::: @@ -2518,22 +2541,23 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | -| `symbol` | `"💠"` | A format string shown before the terraform workspace. | -| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | -| `style` | `"bold 105"` | The style for the module. | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | +| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | +| `style` | `"bold 105"` | The style for the module. | +| `disabled` | `false` | Disables the `terraform` module. | ### Variables | Variable | Example | Description | | --------- | ---------- | ------------------------------------ | | version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current terraform workspace | +| workspace | `default` | The current Terraform workspace | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2541,7 +2565,7 @@ By default the module will be shown if any of the following conditions are met: ### Example -#### With Version +#### With Terraform Version ```toml # ~/.config/starship.toml @@ -2550,7 +2574,7 @@ By default the module will be shown if any of the following conditions are met: format = "[🏎💨 $version$workspace]($style) " ``` -#### Without version +#### Without Terraform version ```toml # ~/.config/starship.toml @@ -2652,21 +2676,22 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default 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. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"cyan bold"` | The style for the module. | -| `disabled` | `false` | Disables the `vagrant` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2689,7 +2714,7 @@ format = "via [⍱ $version](bold white) " ## VCSH -The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### Options @@ -2721,21 +2746,22 @@ format = "[🆅 $repo](bold blue) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `.zig` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | -| `style` | `"bold yellow"` | The style for the module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `zig` module. | -| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `false` | Disables the `zig` module. | +| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables diff --git a/docs/ckb-IR/config/README.md b/docs/ckb-IR/config/README.md index cb488c9f..2c432f89 100644 --- a/docs/ckb-IR/config/README.md +++ b/docs/ckb-IR/config/README.md @@ -3,7 +3,7 @@ To get started configuring starship, create the following file: `~/.config/starship.toml`. ```sh -mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml +mkdir -p ~/.config && touch ~/.config/starship.toml ``` All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: @@ -49,9 +49,9 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ### Terminology -**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project. +**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project. -**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of NodeJS. +**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js. By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix. @@ -384,7 +384,7 @@ The character will tell you whether the last command was successful or not. It c - changing color (`red`/`green`) - changing shape (`❯`/`✖`) -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). +By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). ::: warning `error_symbol` is not supported on elvish shell. ::: @@ -437,22 +437,23 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met: +The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met: - The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeCache.txt` file ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `cmake` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"△ "` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `cmake` module. | ### Variables @@ -555,22 +556,23 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met: +The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `shard.yml` file - The current directory contains a `.cr` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | --------------------------------------------------------- | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | -| `style` | `"bold red"` | The style for the module. | -| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | -| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `crystal` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `"bold red"` | The style for the module. | +| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | +| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `disabled` | `false` | Disables the `crystal` module. | ### Variables @@ -593,7 +595,7 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory @@ -601,15 +603,16 @@ The `dart` module shows the currently installed version of Dart. By default the ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | -| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `dart` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | +| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. | +| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `dart` module. | ### Variables @@ -632,20 +635,21 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of Deno. By default the module will be shown if any of the following conditions are met: +The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"green bold"` | The style for the module. | -| `disabled` | `false` | Disables the `deno` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"green bold"` | The style for the module. | +| `disabled` | `false` | Disables the `deno` module. | ### Variables @@ -764,7 +768,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -786,16 +790,17 @@ The module will also show the Target Framework Moniker ( ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager. @@ -1949,7 +1965,7 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file @@ -1959,15 +1975,16 @@ The `perl` module shows the currently installed version of Perl. By default the ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | -| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | -| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | -| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 149"` | The style for the module. | -| `disabled` | `false` | Disables the `perl` module. | +| Option | Default | Description | **** | +| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- | +| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | +| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | +| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | | +| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | | +| `detect_folders` | `[]` | Which folders should trigger this module. | | +| `style` | `"bold 149"` | The style for the module. | | +| `disabled` | `false` | Disables the `perl` module. | | ### Variables @@ -1988,7 +2005,7 @@ format = "via [🦪 $version]($style) " ## PHP -The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `composer.json` file - The current directory contains a `.php-version` file @@ -1996,15 +2013,16 @@ The `php` module shows the currently installed version of PHP. By default the mo ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | -| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | -| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"147 bold"` | The style for the module. | -| `disabled` | `false` | Disables the `php` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | +| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"147 bold"` | The style for the module. | +| `disabled` | `false` | Disables the `php` module. | ### Variables @@ -2027,22 +2045,23 @@ format = "via [🔹 $version](147 bold) " ## PureScript -The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: - The current directory contains a `spago.dhall` file - The current directory contains a file with the `.purs` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | -| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold white"` | The style for the module. | -| `disabled` | `false` | Disables the `purescript` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | +| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold white"` | The style for the module. | +| `disabled` | `false` | Disables the `purescript` module. | ### Variables @@ -2065,7 +2084,7 @@ format = "via [$symbol$version](bold white)" ## Python -The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. @@ -2092,7 +2111,7 @@ By default the module will be shown if any of the following conditions are met: | `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | -| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | +| `detect_extensions` | `["py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2143,7 +2162,7 @@ detect_extensions = [] ## Red -By default the `red` module shows the currently installed version of Red. The module will be shown if any of the following conditions are met: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a file with `.red` or `.reds` extension @@ -2181,7 +2200,7 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Gemfile` file - The current directory contains a `.ruby-version` file @@ -2221,7 +2240,7 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Cargo.toml` file - The current directory contains a file with the `.rs` extension @@ -2260,7 +2279,7 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension @@ -2268,15 +2287,16 @@ The `scala` module shows the currently installed version of Scala. By default th ### Options -| Option | Default | Description | -| ------------------- | ---------------------------------------- | ------------------------------------------------- | -| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | -| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | -| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | -| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | -| `style` | `"red dimmed"` | The style for the module. | -| `disabled` | `false` | Disables the `scala` module. | +| Option | Default | Description | +| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `style` | `"red dimmed"` | The style for the module. | +| `disabled` | `false` | Disables the `scala` module. | ### Variables @@ -2309,17 +2329,18 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ### Options -| Option | Default | Description | -| ---------------------- | ------------ | --------------------------------------------- | -| `bash_indicator` | `bsh` | A format string used to represent bash. | -| `fish_indicator` | `fsh` | A format string used to represent fish. | -| `zsh_indicator` | `zsh` | A format string used to represent zsh. | -| `powershell_indicator` | `psh` | A format string used to represent powershell. | -| `ion_indicator` | `ion` | A format string used to represent ion. | -| `elvish_indicator` | `esh` | A format string used to represent elvish. | -| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | -| `format` | `$indicator` | The format for the module. | -| `disabled` | `true` | Disables the `shell` module. | +| Option | Default | Description | +| ---------------------- | ------------ | ------------------------------------------------------------ | +| `bash_indicator` | `bsh` | A format string used to represent bash. | +| `fish_indicator` | `fsh` | A format string used to represent fish. | +| `zsh_indicator` | `zsh` | A format string used to represent zsh. | +| `powershell_indicator` | `psh` | A format string used to represent powershell. | +| `ion_indicator` | `ion` | A format string used to represent ion. | +| `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | +| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `format` | `$indicator` | The format for the module. | +| `disabled` | `true` | Disables the `shell` module. | ### Variables @@ -2335,6 +2356,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [shell] fish_indicator = "" powershell_indicator = "_" +unknown_indicator = "mystery shell" disabled = false ``` @@ -2376,7 +2398,7 @@ threshold = 3 ## Singularity -The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Options @@ -2391,7 +2413,7 @@ The `singularity` module shows the current singularity image, if inside a contai | Variable | Example | Description | | --------- | ------------ | ------------------------------------ | -| env | `centos.img` | The current singularity image | +| env | `centos.img` | The current Singularity image | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2465,22 +2487,23 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | -| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 202"` | The style for the module. | -| `disabled` | `false` | Disables the `swift` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | +| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold 202"` | The style for the module. | +| `disabled` | `false` | Disables the `swift` module. | ### Variables @@ -2503,11 +2526,11 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: 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). +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-terraform-version). ::: @@ -2518,22 +2541,23 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | -| `symbol` | `"💠"` | A format string shown before the terraform workspace. | -| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | -| `style` | `"bold 105"` | The style for the module. | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | +| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | +| `style` | `"bold 105"` | The style for the module. | +| `disabled` | `false` | Disables the `terraform` module. | ### Variables | Variable | Example | Description | | --------- | ---------- | ------------------------------------ | | version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current terraform workspace | +| workspace | `default` | The current Terraform workspace | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2541,7 +2565,7 @@ By default the module will be shown if any of the following conditions are met: ### Example -#### With Version +#### With Terraform Version ```toml # ~/.config/starship.toml @@ -2550,7 +2574,7 @@ By default the module will be shown if any of the following conditions are met: format = "[🏎💨 $version$workspace]($style) " ``` -#### Without version +#### Without Terraform version ```toml # ~/.config/starship.toml @@ -2652,21 +2676,22 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default 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. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"cyan bold"` | The style for the module. | -| `disabled` | `false` | Disables the `vagrant` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2689,7 +2714,7 @@ format = "via [⍱ $version](bold white) " ## VCSH -The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### Options @@ -2721,21 +2746,22 @@ format = "[🆅 $repo](bold blue) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `.zig` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | -| `style` | `"bold yellow"` | The style for the module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `zig` module. | -| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `false` | Disables the `zig` module. | +| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables diff --git a/docs/de-DE/advanced-config/README.md b/docs/de-DE/advanced-config/README.md index 006b0144..fc2ff258 100644 --- a/docs/de-DE/advanced-config/README.md +++ b/docs/de-DE/advanced-config/README.md @@ -81,7 +81,7 @@ Style-String sind Wortlisten, getrennt durch Leerzeichen. Die Wörter haben kein - `` - `none` -wobei `` eine Farbspezifikation ist (siehe unten). `fg:` and `` currently do the same thing, though this may change in the future. `inverted` swaps the background and foreground colors. The order of words in the string does not matter. +wobei `` eine Farbspezifikation ist (siehe unten). `fg:` and `` currently do the same thing, though this may change in the future. `inverted` swaps the background and foreground colors. Die Reihenfolge der Wörter in der Liste spielt keine Rolle. The `none` token overrides all other tokens in a string if it is not part of a `bg:` specifier, so that e.g. `fg:red none fg:blue` will still create a string with no styling. `bg:none` sets the background to the default color so `fg:red bg:none` is equivalent to `red` or `fg:red` and `bg:green fg:red bg:none` is also equivalent to `fg:red` or `red`. In der Zukunft könnte die Unterstützung von `none` in Verbindung mit anderen Tokens fallen gelassen werden. diff --git a/docs/de-DE/config/README.md b/docs/de-DE/config/README.md index 9b72ebe8..394adf91 100644 --- a/docs/de-DE/config/README.md +++ b/docs/de-DE/config/README.md @@ -3,7 +3,7 @@ Um mit der Konfiguration von Starship zu beginnen, musst du die folgende Datei erstellen: `~/.config/starship.toml`. ```sh -mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml +mkdir -p ~/.config && touch ~/.config/starship.toml ``` Die gesamte Konfiguration von Starship wird über diese [TOML](https://github.com/toml-lang/toml)-Datei durchgeführt: @@ -49,9 +49,9 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ### Terminologie -**Module**: Eine Komponente in der Konsole, die auf kontextualisierte Informationen des OS basiert. Zum Beispiel zeigt das Modul "nodejs" die Version von NodeJS, die derzeit auf Ihrem Computer installiert ist, wenn Ihr aktuelles Verzeichnis ein NodeJS-Projekt ist. +**Module**: Eine Komponente in der Konsole, die auf kontextualisierte Informationen des OS basiert. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project. -**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of NodeJS. +**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js. By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix. @@ -310,7 +310,7 @@ symbol = "🅰 " ## Akkustand -The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. +Das `battery` Modul zeigt, wie hoch der Akku des Geräts geladen ist und den aktuellen Ladestatus. Das Modul ist nur sichtbar, wenn der Akku des Geräts unter 10% geladen ist. ### Optionen @@ -338,7 +338,7 @@ discharging_symbol = "💀 " ### Anzeige des Akkustandes -The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). If no `display` is provided. Die Standardwerte sind folgende: +The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). Wenn `display` nicht angegeben ist. Die Standardwerte sind folgende: ```toml [[battery.display]] @@ -350,12 +350,12 @@ The default value for the `charging_symbol` and `discharging_symbol` option is r #### Optionen -The `display` option is an array of the following table. +Die `display`-Option beinhaltet ein Array mit den folgenden Werten. | Option | Standardwert | Beschreibung | | -------------------- | ------------ | --------------------------------------------------------------------------------------------------------- | -| `threshold` | `10` | The upper bound for the display option. | -| `style` | `bold red` | The style used if the display option is in use. | +| `threshold` | `10` | Der Schwellenwert zur Anzeige dieser Option. | +| `style` | `bold red` | Der Stil, der zur Anzeige dieser Option verwendet wird. | | `charging_symbol` | `-` | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. | | `discharging_symbol` | `-` | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. | @@ -377,14 +377,14 @@ discharging_symbol = 💦 ## Zeichen -The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. +Das `character` Modul zeigt ein Zeichen ( meistens einen Pfeil "❯") vor der Texteingabe an. -The character will tell you whether the last command was successful or not. It can do this in two ways: +Das Zeichen zeigt an ob der letzte Befehl erfolgreich war, oder einen Fehler erzeugt hat. It can do this in two ways: - changing color (`red`/`green`) - changing shape (`❯`/`✖`) -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). +By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). ::: warning `error_symbol` is not supported on elvish shell. ::: @@ -437,22 +437,23 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met: +The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met: - The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeCache.txt` file ### Optionen -| Option | Standardwert | Beschreibung | -| ------------------- | -------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | -| `style` | `"bold blue"` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `cmake` module. | +| Option | Standardwert | Beschreibung | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"△ "` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `"bold blue"` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `cmake` module. | ### Variables @@ -466,15 +467,15 @@ The `cmake` module shows the currently installed version of CMake. By default th ## Befehlsdauer -The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. +Das `cmd_duration` Modul zeigt an wie lange der letzte Befehl ausgeführt wurde. Das Modul wird nur angezeigt wenn der letzte Befehl länger als zwei Sekunden ausgeführt wurde. Mit der `min_time` Option kann die Zeit eingestellt werden ab der `cmd_duration` angezeigt wird. -::: warning Do not hook the DEBUG trap in Bash +::: warning Nicht die DEBUG-trap in der Bash hooken -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. +Ist `bash` die Konsole der Wahl, dann nicht die `DEBUG`-trap nach der Ausführung von `eval $(starship init $0)` hooken, andernfalls **wird** dieses Modul unweigerlich untergehen. ::: -Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. +Bash Nutzer, die eine "preexec" ähnliche Funktion benötigen, können [rcaloras bash_preexec Framework](https://github.com/rcaloras/bash-preexec) verwenden. Definieren Sie einfach die Arrays `preexec_functions` und `precmd_functions` bevor sie `eval $(starship init $0)` ausführen, und fahren Sie dann wie gewohnt fort. ### Optionen @@ -488,7 +489,7 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec | `show_notifications` | `false` | Show desktop notifications when command completes. | | `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). | -::: tip +::: Tipp Showing desktop notifications requires starship to be built with `rust-notify` support. You check if your starship supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `true`. @@ -515,11 +516,11 @@ format = "underwent [$duration](bold yellow)" ## Conda -The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. +Das `conda`-Modul zeigt dessen aktuelle Umgebung an, sofern `$CONDA_DEFAULT_ENV` gesetzt ist. -::: tip +::: Tipp -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. +Hinweis: Dies unterdrückt nicht conda's eigenen Prompt-Modifikator, sie können jedoch conda mit `conda config --set changeps1 False` konfigurieren, um die Ausgabe von conda selbst auszuschalten. ::: @@ -555,22 +556,23 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met: +The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: - Das aktuelle Verzeichnis enthält eine `shard.yml`-Datei - The current directory contains a `.cr` file ### Optionen -| Option | Standardwert | Beschreibung | -| ------------------- | ------------------------------------ | --------------------------------------------------------- | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | -| `style` | `"bold red"` | Stil für dieses Modul. | -| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | -| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `crystal` module. | +| Option | Standardwert | Beschreibung | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `"bold red"` | Stil für dieses Modul. | +| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | +| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `disabled` | `false` | Disables the `crystal` module. | ### Variables @@ -593,7 +595,7 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory @@ -601,15 +603,16 @@ The `dart` module shows the currently installed version of Dart. By default the ### Optionen -| Option | Standardwert | Beschreibung | -| ------------------- | ------------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | -| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | -| `style` | `"bold blue"` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `dart` module. | +| Option | Standardwert | Beschreibung | +| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | +| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. | +| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | +| `style` | `"bold blue"` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `dart` module. | ### Variables @@ -632,20 +635,21 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of Deno. By default the module will be shown if any of the following conditions are met: +The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file ### Optionen -| Option | Standardwert | Beschreibung | -| ------------------- | -------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"green bold"` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `deno` module. | +| Option | Standardwert | Beschreibung | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"green bold"` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `deno` module. | ### Variables @@ -666,7 +670,7 @@ format = "via [🦕 $version](green bold) " ## Verzeichnis -The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. +Das `directory` -Modul zeigt den Pfad zu Ihrem aktuellen Verzeichnis an, abgeschnitten auf drei übergeordnete Ordner. Your directory will also be truncated to the root of the git repo that you're currently in. When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. @@ -676,18 +680,18 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | Option | Standardwert | Beschreibung | | ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- | -| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | +| `truncation_length` | `3` | Die Anzahl der übergeordneten Ordner, die angezeigt werden. | | `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | | `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. | | `style` | `"bold cyan"` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `directory` module. | +| `disabled` | `false` | Deaktiviert das `directory`-Modul. | | `read_only` | `"🔒"` | The symbol indicating current directory is read only. | | `read_only_style` | `"red"` | The style for the read only symbol. | | `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | | `home_symbol` | `"~"` | The symbol indicating home directory. |
-This module has a few advanced configuration options that control how the directory is displayed. +Dieses Modul hat einige erweiterte Konfigurationsoptionen, welche die Darstellung von Verzeichnissen steuern. | Advanced Option | Standardwert | Beschreibung | | --------------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -764,7 +768,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -786,16 +790,17 @@ The module will also show the Target Framework Moniker ( ⚠️ Die angezeigte Version ist die des Pakets, dessen Quellcode im Verzeichnis liegt, nicht die des Paketmanagers. ### Optionen -| Option | Standardwert | Beschreibung | -| ----------------- | --------------------------------- | ---------------------------------------------------------- | -| `format` | `"is [$symbol$version]($style) "` | The format for the module. | -| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | -| `style` | `"bold 208"` | Stil für dieses Modul. | -| `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | Disables the `package` module. | +| Option | Standardwert | Beschreibung | +| ----------------- | --------------------------------- | --------------------------------------------------------- | +| `format` | `"is [$symbol$version]($style) "` | The format for the module. | +| `symbol` | `"📦 "` | Symbol das vor der Paketversion angezeigt wird. | +| `style` | `"bold 208"` | Stil für dieses Modul. | +| `display_private` | `false` | Enable displaying version for packages marked as private. | +| `disabled` | `false` | Deaktiviert das `package`-Modul. | ### Variables @@ -1949,7 +1965,7 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file @@ -1959,15 +1975,16 @@ The `perl` module shows the currently installed version of Perl. By default the ### Optionen -| Option | Standardwert | Beschreibung | -| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | -| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | -| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | -| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 149"` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `perl` module. | +| Option | Standardwert | Beschreibung | **** | +| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- | +| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | +| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | +| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | | +| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | | +| `detect_folders` | `[]` | Which folders should trigger this module. | | +| `style` | `"bold 149"` | Stil für dieses Modul. | | +| `disabled` | `false` | Disables the `perl` module. | | ### Variables @@ -1988,23 +2005,24 @@ format = "via [🦪 $version]($style) " ## PHP -The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: -- 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 - The current directory contains a `.php` extension ### Optionen -| Option | Standardwert | Beschreibung | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | -| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | -| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"147 bold"` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `php` module. | +| Option | Standardwert | Beschreibung | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐘 "` | Symbol das vor der PHP-Version angezeigt wird. | +| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | +| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"147 bold"` | Stil für dieses Modul. | +| `disabled` | `false` | Deaktiviert das `php`-Modul. | ### Variables @@ -2027,22 +2045,23 @@ format = "via [🔹 $version](147 bold) " ## PureScript -The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: -- The current directory contains a `spago.dhall` file +- Das aktuelle Verzeichnis enthält eine `spago.dhall`-Datei - The current directory contains a file with the `.purs` extension ### Optionen -| Option | Standardwert | Beschreibung | -| ------------------- | ------------------------------------ | ------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | -| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold white"` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `purescript` module. | +| Option | Standardwert | Beschreibung | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | +| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold white"` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `purescript` module. | ### Variables @@ -2065,21 +2084,21 @@ format = "via [$symbol$version](bold white)" ## Python -The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. By default the module will be shown if any of the following conditions are met: -- The current directory contains a `.python-version` file -- The current directory contains a `Pipfile` file +- Das aktuelle Verzeichnis enthält eine `.python-version`-Datei +- Das aktuelle Verzeichnis enthält eine `Pipfile`-Datei - The current directory contains a `__init__.py` file -- The current directory contains a `pyproject.toml` file -- The current directory contains a `requirements.txt` file -- The current directory contains a `setup.py` file -- The current directory contains a `tox.ini` file -- The current directory contains a file with the `.py` extension. -- A virtual environment is currently activated +- Das aktuelle Verzeichnis enthält eine `pyproject.toml`-Datei +- Das aktuelle Verzeichnis enthält eine `requirements.txt`-Datei +- Das aktuelle Verzeichnis enthält eine `setup.py`-Datei +- Das aktuelle Verzeichnis enthält eine `tox.ini`-Datei +- Das aktuelle Verzeichnis enthält eine Datei mit der `.py`-Erweiterung. +- Ein virtualenv ist momentan aktiv ### Optionen @@ -2089,15 +2108,15 @@ By default the module will be shown if any of the following conditions are met: | `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | Stil für dieses Modul. | -| `pyenv_version_name` | `false` | Use pyenv to get Python version | +| `pyenv_version_name` | `false` | Verwende `pyenv` um die Python-Versionzu beziehen. | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | -| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | +| `detect_extensions` | `["py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | -| `disabled` | `false` | Disables the `python` module. | +| `disabled` | `false` | Deaktiviert das `python`-Modul. | -::: tip +::: Tipp The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. @@ -2143,7 +2162,7 @@ detect_extensions = [] ## Red -By default the `red` module shows the currently installed version of Red. The module will be shown if any of the following conditions are met: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: - The current directory contains a file with `.red` or `.reds` extension @@ -2181,11 +2200,11 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: -- The current directory contains a `Gemfile` file +- Das aktuelle Verzeichnis enthält eine `Gemfile`-Datei - The current directory contains a `.ruby-version` file -- The current directory contains a `.rb` file +- Das aktuelle Verzeichnis enthält eine `.rb`-Datei ### Optionen @@ -2198,7 +2217,7 @@ By default the `ruby` module shows the currently installed version of Ruby. The | `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold red"` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `ruby` module. | +| `disabled` | `false` | Deaktiviert das `ruby`-Modul. | ### Variables @@ -2221,10 +2240,10 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: -- The current directory contains a `Cargo.toml` file -- The current directory contains a file with the `.rs` extension +- Das aktuelle Verzeichnis enthält eine `Cargo.toml`-Datei +- Das aktuelle Verzeichnis enthält eine Datei mit der `.rs`-Erweiterung ### Optionen @@ -2237,7 +2256,7 @@ By default the `rust` module shows the currently installed version of Rust. The | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold red"` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `rust` module. | +| `disabled` | `false` | Deaktiviert das `rust`-Modul. | ### Variables @@ -2260,7 +2279,7 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension @@ -2268,15 +2287,16 @@ The `scala` module shows the currently installed version of Scala. By default th ### Optionen -| Option | Standardwert | Beschreibung | -| ------------------- | ---------------------------------------- | ------------------------------------------------- | -| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | -| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | -| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | -| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | -| `style` | `"red dimmed"` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `scala` module. | +| Option | Standardwert | Beschreibung | +| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `style` | `"red dimmed"` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `scala` module. | ### Variables @@ -2301,25 +2321,26 @@ symbol = "🌟 " The `shell` module shows an indicator for currently used shell. -::: tip +::: Tipp -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. ::: ### Optionen -| Option | Standardwert | Beschreibung | -| ---------------------- | ------------ | --------------------------------------------- | -| `bash_indicator` | `bsh` | A format string used to represent bash. | -| `fish_indicator` | `fsh` | A format string used to represent fish. | -| `zsh_indicator` | `zsh` | A format string used to represent zsh. | -| `powershell_indicator` | `psh` | A format string used to represent powershell. | -| `ion_indicator` | `ion` | A format string used to represent ion. | -| `elvish_indicator` | `esh` | A format string used to represent elvish. | -| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | -| `format` | `$indicator` | The format for the module. | -| `disabled` | `true` | Disables the `shell` module. | +| Option | Standardwert | Beschreibung | +| ---------------------- | ------------ | ------------------------------------------------------------ | +| `bash_indicator` | `bsh` | A format string used to represent bash. | +| `fish_indicator` | `fsh` | A format string used to represent fish. | +| `zsh_indicator` | `zsh` | A format string used to represent zsh. | +| `powershell_indicator` | `psh` | A format string used to represent powershell. | +| `ion_indicator` | `ion` | A format string used to represent ion. | +| `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | +| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `format` | `$indicator` | The format for the module. | +| `disabled` | `true` | Disables the `shell` module. | ### Variables @@ -2335,6 +2356,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [shell] fish_indicator = "" powershell_indicator = "_" +unknown_indicator = "mystery shell" disabled = false ``` @@ -2376,7 +2398,7 @@ threshold = 3 ## Singularity -The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Optionen @@ -2391,7 +2413,7 @@ The `singularity` module shows the current singularity image, if inside a contai | Variable | Beispiel | Beschreibung | | --------- | ------------ | ------------------------------------ | -| env | `centos.img` | The current singularity image | +| env | `centos.img` | The current Singularity image | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2410,9 +2432,9 @@ format = '[📦 \[$env\]]($style) ' The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. -::: tip +::: Tipp -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. ::: @@ -2465,22 +2487,23 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension ### Optionen -| Option | Standardwert | Beschreibung | -| ------------------- | ------------------------------------ | ------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | -| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 202"` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `swift` module. | +| Option | Standardwert | Beschreibung | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | +| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold 202"` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `swift` module. | ### Variables @@ -2503,37 +2526,38 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. -::: tip +::: Tipp -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). +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-terraform-version). ::: By default the module will be shown if any of the following conditions are met: -- The current directory contains a `.terraform` folder +- Das aktuelle Verzeichnis enthält eine `.terraform`-Datei - Current directory contains a file with the `.tf` or `.hcl` extensions ### Optionen -| Option | Standardwert | Beschreibung | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | -| `symbol` | `"💠"` | A format string shown before the terraform workspace. | -| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | -| `style` | `"bold 105"` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | Standardwert | Beschreibung | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | +| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | +| `style` | `"bold 105"` | Stil für dieses Modul. | +| `disabled` | `false` | Deaktiviert das `terraform` Modul. | ### Variables | Variable | Beispiel | Beschreibung | | --------- | ---------- | ------------------------------------ | | version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current terraform workspace | +| workspace | `default` | The current Terraform workspace | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2541,7 +2565,7 @@ By default the module will be shown if any of the following conditions are met: ### Beispiel -#### With Version +#### With Terraform Version ```toml # ~/.config/starship.toml @@ -2550,7 +2574,7 @@ By default the module will be shown if any of the following conditions are met: format = "[🏎💨 $version$workspace]($style) " ``` -#### Without version +#### Without Terraform version ```toml # ~/.config/starship.toml @@ -2561,33 +2585,33 @@ 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. -::: tip +::: Tipp -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. ::: ### Optionen -| Option | Standardwert | Beschreibung | -| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `format` | `"at [$time]($style) "` | The format string for the module. | -| `use_12hr` | `false` | Enables 12 hour formatting | -| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | -| `style` | `"bold yellow"` | The style for the module time | -| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | -| `disabled` | `true` | Disables the `time` module. | -| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| Option | Standardwert | Beschreibung | +| ----------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `format` | `"at [$time]($style) "` | The format string for the module. | +| `use_12hr` | `false` | Aktiviert 12-Stunden-Format | +| `time_format` | siehe unten | Das Format zum Anzeigen der Uhrzeit in [chrono-Formatierung](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html). | +| `style` | `"bold yellow"` | Stil für dieses Modul | +| `utc_time_offset` | `"local"` | Verwendetes Zeitzonen-Offset. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | +| `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 | Variable | Beispiel | Beschreibung | | --------- | ---------- | ----------------------------------- | -| time | `13:08:10` | The current time. | +| zeit | `13:08:10` | The current time. | | style\* | | Mirrors the value of option `style` | \*: This variable can only be used as a part of a style string @@ -2607,14 +2631,14 @@ time_range = "10:00:00-14:00:00" ## Username -The `username` module shows active user's username. The module will be shown if any of the following conditions are met: +Das `username` Modul zeigt den Namen des aktiven Benutzers. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: -- The current user is root -- The current user isn't the same as the one that is logged in -- The user is currently connected as an SSH session -- The variable `show_always` is set to true +- Der aktuelle Benutzer ist root +- Der aktuelle Benutzer ist nicht der eingeloggte Benutzer +- Der Benutzer ist aktuell via SSH verbunden +- Die Variable `show_always` ist auf true gesetzt -::: tip +::: Tipp 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. @@ -2622,13 +2646,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### Optionen -| Option | Standardwert | Beschreibung | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `style_user` | `"bold yellow"` | The style used for non-root users. | -| `format` | `"[$user]($style) in "` | The format for the module. | -| `show_always` | `false` | Always shows the `username` module. | -| `disabled` | `false` | Disables the `username` module. | +| Option | Standardwert | Beschreibung | +| ------------- | ----------------------- | ---------------------------------------------- | +| `style_root` | `"bold red"` | Stil wenn der Benutzer unter root läuft. | +| `style_user` | `"bold yellow"` | Stil wenn der Benutzer nicht unter root läuft. | +| `format` | `"[$user]($style) in "` | The format for the module. | +| `show_always` | `false` | Immer das `username` Modul anzeigen. | +| `disabled` | `false` | Deavktiviert das `username` Modul. | ### Variables @@ -2652,21 +2676,22 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default the module will be shown if any of the following conditions are met: - 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. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"cyan bold"` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `vagrant` module. | +| Option | Standardwert | Beschreibung | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"cyan bold"` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2689,7 +2714,7 @@ format = "via [⍱ $version](bold white) " ## VCSH -The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### Optionen @@ -2721,21 +2746,22 @@ format = "[🆅 $repo](bold blue) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: - The current directory contains a `.zig` file ### Optionen -| Option | Standardwert | Beschreibung | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | -| `style` | `"bold yellow"` | Stil für dieses Modul. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `zig` module. | -| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | Standardwert | Beschreibung | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | +| `style` | `"bold yellow"` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `zig` module. | +| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables @@ -2767,19 +2793,19 @@ These modules will be shown if any of the following conditions are met: - The current directory contains a file whose extension is in `extensions` - The `when` command returns 0 -::: tip +::: Tipp Multiple custom modules can be defined by using a `.`. ::: -::: tip +::: Tipp 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. ::: -::: tip +::: Tipp [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! @@ -2787,19 +2813,19 @@ The order in which custom modules are shown can be individually set by including ### Optionen -| Option | Standardwert | Beschreibung | -| ------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | -| `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | -| `shell` | | [See below](#custom-command-shell) | -| `description` | `""` | The description of the module that is shown when running `starship explain`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | -| `symbol` | `""` | The symbol used before displaying the command output. | -| `style` | `"bold green"` | Stil für dieses Modul. | -| `format` | `"[$symbol($output )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables this `custom` module. | +| Option | Standardwert | Beschreibung | +| -------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | +| `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | +| `shell` | | [See below](#custom-command-shell) | +| `beschreibung` | `""` | The description of the module that is shown when running `starship explain`. | +| `files` | `[]` | The files that will be searched in the working directory for a match. | +| `directories` | `[]` | The directories that will be searched in the working directory for a match. | +| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | +| `symbol` | `""` | The symbol used before displaying the command output. | +| `style` | `"bold green"` | Stil für dieses Modul. | +| `format` | `"[$symbol($output )]($style)"` | The format for the module. | +| `disabled` | `false` | Disables this `custom` module. | ### Variables diff --git a/docs/es-ES/advanced-config/README.md b/docs/es-ES/advanced-config/README.md index 6455a71f..b5ca35af 100644 --- a/docs/es-ES/advanced-config/README.md +++ b/docs/es-ES/advanced-config/README.md @@ -81,7 +81,7 @@ Las cadenas de estilo son una lista de palabras, separadas por espacios en blanc - `` - `none` -donde `` es un especificador de color (discutido a continuación). `fg:` and `` currently do the same thing, though this may change in the future. `inverted` swaps the background and foreground colors. The order of words in the string does not matter. +donde `` es un especificador de color (discutido a continuación). `fg:` and `` currently do the same thing, though this may change in the future. `inverted` swaps the background and foreground colors. El orden de las palabras en la cadena no importa. El token `none` anula todos los demás tokens en una cadena si no es parte de un especificador `bg:`, de modo que por ejemplo `fg:red none fg:blue` creará una cadena sin ningún estilo. `bg:none` sets the background to the default color so `fg:red bg:none` is equivalent to `red` or `fg:red` and `bg:green fg:red bg:none` is also equivalent to `fg:red` or `red`. Puede convertirse en un error usar `none` junto con otros tokens en el futuro. diff --git a/docs/es-ES/config/README.md b/docs/es-ES/config/README.md index 7faece6a..88626d2c 100644 --- a/docs/es-ES/config/README.md +++ b/docs/es-ES/config/README.md @@ -3,7 +3,7 @@ Para comenzar a configurar Starship, crea el siguiente archivo: `~/.config/starship.toml`. ```sh -mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml +mkdir -p ~/.config && touch ~/.config/starship.toml ``` Toda la configuración de Starship se realiza en este archivo [TOML](https://github.com/toml-lang/toml): @@ -49,9 +49,9 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ### Terminología -**Módulo**: un componente en el promt que provee información basada en información contextual de tu sistema operativo. Por ejemplo, el módulo "nodejs" muestra la versión de NodeJS que tienes actualmente instalada en tu ordenador, si el directorio actual es un proyecto NodeJS. +**Módulo**: un componente en el promt que provee información basada en información contextual de tu sistema operativo. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project. -**Variable**: subcomponentes más pequeños que contienen información proporcionada por el módulo. Por ejemplo, la variable "version" en el módulo "nodejs" contiene la versión actual de NodeJS. +**Variable**: subcomponentes más pequeños que contienen información proporcionada por el módulo. For example, the "version" variable in the "nodejs" module contains the current version of Node.js. Por convención, la mayoría de los módulos tienen un prefijo del color por defecto de la terminal (por ejemplo, `vía` en "nodejs") y un espacio vacío como sufijo. @@ -142,12 +142,12 @@ Esta es la lista de opciones de configuración del prompt. ### Opciones -| Opción | Por defecto | Descripción | -| ----------------- | ---------------------------------- | ----------------------------------------------------------------------------- | -| `format` | [ver aquí](#default-prompt-format) | Configura el formato del prompt. | -| `scan_timeout` | `30` | Tiempo de espera tras el que Starship escanea los archivos (en milisegundos). | -| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). | -| `add_newline` | `true` | Inserts blank line between shell prompts. | +| Opción | Por defecto | Descripción | +| ----------------- | ---------------------------------- | ------------------------------------------------------------------------------ | +| `format` | [ver aquí](#default-prompt-format) | Configura el formato del prompt. | +| `scan_timeout` | `30` | Tiempo de espera tras el que Starship escanea los archivos (en milisegundos). | +| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). | +| `add_newline` | `true` | Inserta un línea en blanco entre las instrucciones del intérprete de comandos. | ### Ejemplo @@ -265,7 +265,7 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplos @@ -310,7 +310,7 @@ symbol = "🅰 " ## Battery -The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. +El módulo `battery` muestra la cantidad de batería y si se está cargando o no. El módulo es solo visible cuando la batería está por debajo del 10%. ### Opciones @@ -338,7 +338,7 @@ discharging_symbol = "💀 " ### Indicador de batería -The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). If no `display` is provided. El valor por defecto es el siguiente: +The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). Si no se provee ningún valor para `display` El valor por defecto es el siguiente: ```toml [[battery.display]] @@ -350,12 +350,12 @@ The default value for the `charging_symbol` and `discharging_symbol` option is r #### Opciones -The `display` option is an array of the following table. +La opción `display` es un array de la siguiente tabla. | Opción | Por defecto | Descripción | | -------------------- | ----------- | --------------------------------------------------------------------------------------------------------- | -| `threshold` | `10` | The upper bound for the display option. | -| `style` | `bold red` | The style used if the display option is in use. | +| `threshold` | `10` | El umbral para la opción de visualización. | +| `style` | `bold red` | El estilo usado cuando si la opción <0>display está activa. | | `charging_symbol` | `-` | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. | | `discharging_symbol` | `-` | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. | @@ -377,16 +377,16 @@ discharging_symbol = 💦 ## Character -The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. +El módulo `character` muestra un carácter (normalmente una flecha) tras el texto que introduces en el terminal. -The character will tell you whether the last command was successful or not. It can do this in two ways: +El carácter te dirá si el último comando funcionó o no. Se puede hacer de dos maneras: - Cambiando el color (`red`/`green`) - Cambiando la forma (`.`/`✖`) -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). +Por defecto sólo cambia el color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). -::: warning `error_symbol` is not supported on elvish shell. ::: +::: advertencia `error_symbol` no es compatible con el intérprete de comandos Elvish. ::: ### Opciones @@ -437,22 +437,23 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met: +The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). Por defecto el módulo se activará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `CMakeLists.txt` - El directorio actual contiene un archivo `CMakeCache.txt` ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | -------------------------------------- | ------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | -| `symbol` | `"△ "` | El símbolo usado antes de la versión de cmake. | -| `detect_extensions` | `[]` | Qué extensiones deben activar este módulo | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Qué nombres de archivo deben activar este módulo | -| `detect_folders` | `[]` | Qué carpetas deben activar este módulo | -| `style` | `"bold blue"` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `cmake`. | +| Opción | Por defecto | Descripción | +| ------------------- | -------------------------------------- | --------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"△ "` | El símbolo usado antes de la versión de cmake. | +| `detect_extensions` | `[]` | Qué extensiones deben activar este módulo | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Qué nombres de archivo deben activar este módulo | +| `detect_folders` | `[]` | Qué carpetas deben activar este módulo | +| `style` | `"bold blue"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `cmake`. | ### Variables @@ -462,19 +463,19 @@ The `cmake` module shows the currently installed version of CMake. By default th | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ## Tiempo de Ejecución -The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. +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. -::: warning Do not hook the DEBUG trap in Bash +::: warning No utilizar DEBUG en Bash -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. +Si estás usando Starship con `bash`, no uses `DEBUG` después de ejecutar `eval $(starship init $0)`, o el módulo **se romperá**. ::: -Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. +Los usuarios de bash que necesiten la funcionalidad como preexec pueden usar el [framework bash_preexec de rcaloras](https://github.com/rcaloras/bash-preexec). Basta con definir los arrays `preexec_functions` y `precmd_functions` antes de ejecutar `eval $(starship init $0)`, y luego proceder como siempre. ### Opciones @@ -488,9 +489,9 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec | `show_notifications` | `false` | Muestra notificaciones de escritorio cuando se complete el comando. | | `min_time_to_notify` | `45_000` | Duración mínima para mostrar el tiempo de ejecución (en milisegundos). | -::: tip +::: consejo -Showing desktop notifications requires starship to be built with `rust-notify` support. You check if your starship supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `true`. +Mostrar notificaciones de escritorio requiere que se construya starship con soporte de `rust-notify`. Comprueba si tu Starship soporta notificaciones ejecutando `STARSHIP_LOG=debug starship module cmd_duration -d 60000` cuando `show_notifications` está establecido en `true`. ::: @@ -501,7 +502,7 @@ Showing desktop notifications requires starship to be built with `rust-notify` s | duration | `16m40s` | El tiempo que tardó en ejecutar el comando | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -515,11 +516,11 @@ format = "underwent [$duration](bold yellow)" ## Conda -The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. +El módulo `conda` muestra el entorno conda actual, si `$CONDA_DEFAULT_ENV` está configurado. -::: tip +::: consejo -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. +Esto no modifica el propio símbolo de sistema de conda. En caso de querer suprimirlo, ejecuta `conda config --set changeps1 False`. ::: @@ -542,7 +543,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -555,22 +556,23 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -The `crystal` module shows the currently installed version of Crystal. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un fichero `shard.yml` - El directorio actual contiene un fichero `.cr` ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ------------------------------------ | ---------------------------------------------------- | -| `symbol` | `"🔮 "` | Símbolo usado antes de la versión de Crystal. | -| `style` | `"bold red"` | El estilo del módulo. | -| `detect_extensions` | `["cr"]` | Qué extensiones deberían activar este módulo. | -| `detect_files` | `["shard.yml"]` | Qué nombres de archivo deberían activar este módulo. | -| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | -| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | -| `disabled` | `false` | Deshabilita el módulo `crystal`. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | +| `symbol` | `"🔮 "` | Símbolo usado antes de la versión de Crystal. | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | +| `style` | `"bold red"` | El estilo del módulo. | +| `detect_extensions` | `["cr"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["shard.yml"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | +| `disabled` | `false` | Desactiva el módulo `crystal`. | ### Variables @@ -580,7 +582,7 @@ The `crystal` module shows the currently installed version of Crystal. Por defec | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -593,7 +595,7 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of Dart. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo con la extensión `.dart` - El directorio actual contiene un directorio `.dart_tool` @@ -601,15 +603,16 @@ The `dart` module shows the currently installed version of Dart. Por defecto, el ### 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 Dart | -| `detect_extensions` | `['dart']` | Qué extensiones deberían activar este módulo. | -| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Qué nombres de archivo deberían activar este módulo. | -| `detect_folders` | `[".dart_tool"]` | Qué carpetas deberían activar este módulo. | -| `style` | `"bold blue"` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `dart`. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🎯 "` | Una cadena de formato que representa el símbolo de Dart | +| `detect_extensions` | `["dart"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[".dart_tool"]` | Qué carpetas deberían activar este módulo. | +| `style` | `"bold blue"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `dart`. | ### Variables @@ -619,7 +622,7 @@ The `dart` module shows the currently installed version of Dart. Por defecto, el | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -632,20 +635,21 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of Deno. By default the module will be shown if any of the following conditions are met: +The `deno` module shows you your currently installed version of [Deno](https://deno.land/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `mod.ts`, `mod.js`, `deps.ts` o `deps.js` ### 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 Deno | -| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | -| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Qué nombres de archivo deberían activar este módulo. | -| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | -| `style` | `"green bold"` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `deno`. | +| Opción | Por defecto | Descripción | +| ------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🦕 "` | Una cadena de formato que representa el símbolo de Deno | +| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | +| `style` | `"green bold"` | El estilo del módulo. | +| `disabled` | `false` | Deshabilita el módulo `deno`. | ### Variables @@ -666,11 +670,11 @@ format = "via [🦕 $version](green bold) " ## Directory -The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. +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 te encuentres. -When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. +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. -For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. +Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repositorio y el valor de la opción es `1`. Ahora verás `~/D/N/nixpkgs/pkgs`, mientras que antes habría sido `nixpkgs/pkgs`. ### Opciones @@ -687,15 +691,15 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | `home_symbol` | `"~"` | El símbolo que indica el directorio personal. |
-This module has a few advanced configuration options that control how the directory is displayed. +Este módulo tiene algunas opciones avanzadas de configuración que controlan cómo se muestra el directorio. -| Opciones Avanzadas | Por defecto | Descripción | -| --------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `substitutions` | | A table of substitutions to be made to the path. | -| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | -| `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. | +| Opciones Avanzadas | Por defecto | Descripción | +| --------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `substitutions` | | Una tabla de sustituciones que se deben hacer a la ruta. | +| `fish_style_pwd_dir_length` | `0` | El número de caracteres a usar al aplicar la lógica de ruta pwd del intérprete de comandos de Fish. | +| `use_logical_path` | `true` | Si `true` renderiza la ruta lógica originada desde el intérprete de comandos a través de `PWD` o `--logical-path`. Si `false` en su lugar renderiza la ruta física del sistema de archivos con enlaces simbólicos resueltos. | -`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. +`substitutions` permite definir reemplazos arbitrarios para cadenas literales que ocurren en la ruta, por ejemplo prefijos largos de red o directorios de desarrollo (p. ej. Java). Ten en cuenta que esto desactivará el estilo PWD de fish. ```toml [directory.substitutions] @@ -703,7 +707,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an "src/com/long/java/path" = "mypath" ``` -`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`. +`fish_style_pwd_dir_length` interactúa con las opciones de truncamiento estándar de una manera que puede sorprenderse primero: si no es cero, los componentes de la ruta que normalmente se truncarían se muestran con esa cantidad de caracteres. Por ejemplo, la ruta `/built/this/city/on/rock/and/roll`, que normalmente se mostraría como `rock/and/roll`, se mostraría como `/b/t/c/o/rock/and/roll` con `fish_style_pwd_dir_length = 1`--los componentes de ruta que normalmente se eliminarían se muestran con un solo carácter. Para `fish_style_pwd_dir_length = 2`, sería `/bu/th/ci/on/rock/and/roll`.
@@ -714,7 +718,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | path | `"D:/Projects"` | La ruta del directorio actual | | style\* | `"black bold dimmed"` | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -728,7 +732,7 @@ truncation_symbol = "…/" ## Docker Context -The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `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 `por defecto`. ### Opciones @@ -751,7 +755,7 @@ The `docker_context` module shows the currently active [Docker context](https:// | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -764,9 +768,9 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. Si el SDK ha sido anclado en el directorio actual, se mostrará la versión fijada. De lo contrario, el módulo muestra la última versión instalada del SDK. -By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: +Por defecto, este módulo solo se mostrará en tu prompt cuando uno o más de de los siguientes archivos estén presentes en el directorio actual: - `global.json` - `project.json` @@ -778,24 +782,25 @@ By default this module will only be shown in your prompt when one or more of the - `*.fsproj` - `*.xproj` -You'll also need the .NET Core SDK installed in order to use it correctly. +También necesitarás tener instalado el SDK de .NET Core para poder usarlo correctamente. -Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. +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, puedes desactivar el mecanismo estableciendo `heuristic = false` en las opciones del módulo. -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +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. ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | El formato del módulo. | -| `symbol` | `".NET "` | El símbolo usado antes de mostrar la version de dotnet. | -| `heuristic` | `true` | Usa una detección de versiones más rápida para mantener la nave espacial veloz. | -| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Qué extensiones deberían activar este módulo. | -| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Qué nombres de archivo deberían activar este módulo. | -| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | -| `style` | `"bold blue"` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `dotnet`. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | El formato del módulo. | +| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | +| `symbol` | `".NET "` | Símbolo usado antes de mostrar la versión de .NET | +| `heuristic` | `true` | Usa una detección de versiones más rápida para mantener a starship veloz. | +| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | +| `style` | `"bold blue"` | El estilo del módulo. | +| `disabled` | `false` | Deshabilita el módulo `dotnet`. | ### Variables @@ -806,7 +811,7 @@ The module will also show the Target Framework Moniker ( ⚠️ La versión que se muestra es la del paquete cuyo código fuente está en tu directorio actual, no en tu gestor de paquetes. ### Opciones -| Opción | Por defecto | Descripción | -| ----------------- | --------------------------------- | ---------------------------------------------------------- | -| `format` | `"is [$symbol$version]($style) "` | El formato del módulo. | -| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | -| `style` | `"bold 208"` | El estilo del módulo. | -| `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | Disables the `package` module. | +| Opción | Por defecto | Descripción | +| ----------------- | --------------------------------- | -------------------------------------------------------------------------------- | +| `format` | `"is [$symbol$version]($style) "` | El formato del módulo. | +| `symbol` | `"📦 "` | El símbolo usado antes de mostrar la versión del paquete. | +| `style` | `"bold 208"` | El estilo del módulo. | +| `display_private` | `false` | Activar la visualización de la versión para los paquetes marcados como privados. | +| `disabled` | `false` | Desactiva el módulo `package`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v1.0.0` | The version of your package | +| version | `v1.0.0` | La versión de su paquete | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -1949,31 +1965,32 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of Perl. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- The current directory contains a `Makefile.PL` or `Build.PL` file -- The current directory contains a `cpanfile` or `cpanfile.snapshot` file -- The current directory contains a `META.json` file or `META.yml` file -- The current directory contains a `.perl-version` file -- The current directory contains a `.pl`, `.pm` or `.pod` +- El directorio actual contiene un archivo `Makefile.PL` o `Build.PL` +- El directorio actual contiene un archivo `cpanfile` o `cpanfile.snapshot` +- El directorio actual contiene un archivo `META.json` o `META.yml` +- El directorio actual contiene un archivo `.perl-version` +- El directorio actual contiene un `.pl`, `.pm` o `.pod` ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | La cadena de formato para el módulo. | -| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | -| `detect_extensions` | `["pl", "pm", "pod"]` | Qué extensiones deberían activar este módulo. | -| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Qué nombres de archivo deberían activar este módulo. | -| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | -| `style` | `"bold 149"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `perl` module. | +| Opción | Por defecto | Descripción | **** | +| ------------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ---- | +| `format` | `"via [$symbol($version )]($style)"` | La cadena de formato para el módulo. | | +| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | | +| `symbol` | `"🐪 "` | El símbolo usado antes de mostrar la versión de Perl | | +| `detect_extensions` | `["pl", "pm", "pod"]` | Qué extensiones deberían activar este módulo. | | +| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Qué nombres de archivo deberían activar este módulo. | | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | +| `style` | `"bold 149"` | El estilo del módulo. | | +| `disabled` | `false` | Desactiva el módulo `perl`. | | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | -------------------------------------- | -| version | `v5.26.1` | The version of `perl` | +| version | `v5.26.1` | La versión de `perl` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -1988,33 +2005,34 @@ format = "via [🦪 $version]($style) " ## PHP -The `php` module shows the currently installed version of PHP. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- The current directory contains a `composer.json` file -- The current directory contains a `.php-version` file -- The current directory contains a `.php` extension +- El directorio actual contiene un archivo `composer.json` +- El directorio actual contiene un archivo `.php-version` +- El directorio actual contiene una extensión `.php` ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | -| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | -| `detect_extensions` | `["php"]` | Qué extensiones deberían activar este módulo. | -| `detect_files` | `["composer.json", ".php-version"]` | Qué nombres de archivo deberían activar este módulo. | -| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | -| `style` | `"147 bold"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `php` module. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐘 "` | El símbolo usado antes de mostrar la versión de PHP. | +| `detect_extensions` | `["php"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["composer.json", ".php-version"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | +| `style` | `"147 bold"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `php`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v7.3.8` | The version of `php` | +| version | `v7.3.8` | La versión de `php` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -2027,32 +2045,33 @@ format = "via [🔹 $version](147 bold) " ## PureScript -The `purescript` module shows the currently installed version of PureScript version. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- The current directory contains a `spago.dhall` file -- The current directory contains a file with the `.purs` extension +- El directorio actual contiene un archivo `spago.dhall` +- El directorio actual contiene un archivo con la extensión `.purs` ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ------------------------------------ | ------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | -| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Qué extensiones deberían activar este módulo. | -| `detect_files` | `["spago.dhall"]` | Qué nombres de archivo deberían activar este módulo. | -| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | -| `style` | `"bold white"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `purescript` module. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"<=> "` | El símbolo usado antes de mostrar la versión de PureScript. | +| `detect_extensions` | `["purs"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["spago.dhall"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | +| `style` | `"bold white"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `purescript`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `0.13.5` | The version of `purescript` | +| version | `0.13.5` | La versión de `purescript` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -2065,21 +2084,21 @@ format = "via [$symbol$version](bold white)" ## Python -The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. -If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. +Si `pyenv_version_name` se establece en `true`, mostrará el nombre de la versión de pyenv. De lo contrario, se mostrará el número de versión de `python --version`. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- The current directory contains a `.python-version` file -- The current directory contains a `Pipfile` file -- The current directory contains a `__init__.py` file -- The current directory contains a `pyproject.toml` file -- The current directory contains a `requirements.txt` file -- The current directory contains a `setup.py` file -- The current directory contains a `tox.ini` file -- The current directory contains a file with the `.py` extension. -- A virtual environment is currently activated +- El directorio actual contiene un archivo `.python-version` +- El directorio actual contiene un archivo `Pipfile` +- El directorio actual contiene un archivo `__init__.py` +- El directorio actual contiene un archivo `pyproject.toml` +- El directorio actual contiene un archivo `requirements.txt` +- El directorio actual contiene un archivo `setup.py` +- El directorio actual contiene un archivo `tox.ini` +- El directorio actual contiene un archivo con la extensión `.py`. +- Un entorno virtual está activado actualmente ### Opciones @@ -2087,33 +2106,33 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes | -------------------- | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | El formato del módulo. | | `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🐍 "` | A format string representing the symbol of Python | +| `symbol` | `"🐍 "` | Una cadena de formato que representa el símbolo de Python | | `style` | `"yellow bold"` | El estilo del módulo. | -| `pyenv_version_name` | `false` | Use pyenv to get Python version | -| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | -| `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | -| `detect_extensions` | `[".py"]` | Qué extensiones deben activar este módulo | +| `pyenv_version_name` | `false` | Usar pyenv para obtener la versión de Python | +| `pyenv_prefix` | `pyenv` | Prefijo antes de mostrar la versión de pyenv sólo se utiliza si se utiliza pyenv | +| `python_binary` | `["python", "python3, "python2"]` | Configura los binarios de python que Starship debería ejecutar al obtener la versión. | +| `detect_extensions` | `["py"]` | Qué extensiones deben activar este módulo | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Qué nombres de archivo deben activar este módulo | | `detect_folders` | `[]` | Qué carpetas deben activar este módulo | -| `disabled` | `false` | Disables the `python` module. | +| `disabled` | `false` | Desactiva el módulo `python`. | -::: tip +::: consejo -The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. +La variable `python_binary` acepta una cadena o una lista de cadenas. Starship intentará ejecutar cada binario hasta que obtenga un resultado. Ten en cuenta que sólo puedes cambiar el binario que Starship ejecuta para obtener la versión de Python no los argumentos que se utilizan. -The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `"python3"` will hide any Python version 2, see example below. +Los valores por defecto y el orden para `python_binary` fue elegido para identificar primero la versión de Python en un entorno virtualenv/conda (que actualmente añade un `python`, no importa si apunta a `pithon3` o `pithon2`). Esto tiene el efecto secundario que si todavía tienes un sistema de Python 2 instalado, puede ser recogido antes de cualquier Python 3 (al menos en las Distros de Linux que siempre enlazan `/usr/bin/python` a Python 2). Si ya no trabajas con Python 2 pero no puedes removerlo del sistema, cambiando esto a `"python3"` ocultará cualquier versión de Python 2, ver ejemplo a continuación. ::: ### Variables -| Variable | Ejemplo | Descripción | -| ------------ | --------------- | ------------------------------------------ | -| version | `"v3.8.1"` | The version of `python` | -| symbol | `"🐍 "` | Refleja el valor de la opción `symbol` | -| style | `"yellow bold"` | Refleja el valor de la opción `style` | -| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | -| virtualenv | `"venv"` | The current `virtualenv` name | +| Variable | Ejemplo | Descripción | +| ------------ | --------------- | ------------------------------------------- | +| version | `"v3.8.1"` | La versión de `python` | +| symbol | `"🐍 "` | Refleja el valor de la opción `symbol` | +| style | `"yellow bold"` | Refleja el valor de la opción `style` | +| pyenv_prefix | `"pyenv "` | Ordena el valor de la opción `pyenv_prefix` | +| virtualenv | `"venv"` | El nombre actual del `virtualenv` | ### Ejemplo @@ -2129,7 +2148,7 @@ pyenv_version_name = true # ~/.config/starship.toml [python] -# Only use the `python3` binary to get the version. +# Solo usa el binario `python3` para obtener la versión. python_binary = "python3" ``` @@ -2137,13 +2156,13 @@ python_binary = "python3" # ~/.config/starship.toml [python] -# Don't trigger for files with the py extension +# No se dispara con archivos con extensión py detect_extensions = [] ``` ## Red -By default the `red` module shows the currently installed version of Red. The module will be shown if any of the following conditions are met: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: - The current directory contains a file with `.red` or `.reds` extension @@ -2168,7 +2187,7 @@ By default the `red` module shows the currently installed version of Red. The mo | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -2181,11 +2200,11 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- The current directory contains a `Gemfile` file -- The current directory contains a `.ruby-version` file -- The current directory contains a `.rb` file +- El directorio actual contiene un archivo `Gemfile` +- El directorio actual contiene un archivo `.ruby-version` +- El directorio actual contiene un archivo `.rb` ### Opciones @@ -2193,22 +2212,22 @@ By default the `ruby` module shows the currently installed version of Ruby. The | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | +| `symbol` | `"💎 "` | Una cadena de formato que representa el símbolo de Ruby. | | `detect_extensions` | `["rb"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["Gemfile", ".ruby-version"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold red"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `ruby` module. | +| `disabled` | `false` | Desactiva el módulo `ruby`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v2.5.1` | The version of `ruby` | +| version | `v2.5.1` | La versión de `ruby` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -2221,10 +2240,10 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- The current directory contains a `Cargo.toml` file -- The current directory contains a file with the `.rs` extension +- El directorio actual contiene un archivo `Cargo.toml` +- El directorio actual contiene un archivo con la extensión `.rs` ### Opciones @@ -2232,22 +2251,22 @@ By default the `rust` module shows the currently installed version of Rust. The | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | +| `symbol` | `"🦀 "` | Una cadena de formato que representa el símbolo de Rust | | `detect_extensions` | `["rs"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["Cargo.toml"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold red"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `rust` module. | +| `disabled` | `false` | Desactiva el módulo `rust`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ----------------- | -------------------------------------- | -| version | `v1.43.0-nightly` | The version of `rustc` | +| version | `v1.43.0-nightly` | La versión de `rustc` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -2260,33 +2279,34 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of Scala. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file -- The current directory contains a file with the `.scala` or `.sbt` extension -- The current directory contains a directory named `.metals` +- El directorio actual contiene un archivo `build.sbt`, `.scalaenv` o `.sbtenv` +- El directorio actual contiene un archivo con la extensión `.scala` o `.sbt` +- El directorio actual contiene un directorio llamado `.metals` ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ---------------------------------------- | ---------------------------------------------------- | -| `format` | `"via [${symbol}(${version} )]($style)"` | El formato del módulo. | -| `detect_extensions` | `["sbt", "scala"]` | Qué extensiones deberían activar este módulo. | -| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Qué nombres de archivo deberían activar este módulo. | -| `detect_folders` | `[".metals"]` | Qué carpetas deberían activar estos módulos. | -| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | -| `style` | `"red dimmed"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `scala` module. | +| Opción | Por defecto | Descripción | +| ------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | El formato del módulo. | +| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["sbt", "scala"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[".metals"]` | Qué carpetas deberían activar estos módulos. | +| `symbol` | `"🆂 "` | Una cadena de formato que representa el símbolo de Scala. | +| `style` | `"red dimmed"` | El estilo del módulo. | +| `disabled` | `false` | Deshabilita el módulo `scala`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `2.13.5` | The version of `scala` | +| version | `2.13.5` | La versión de `scala` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -2299,33 +2319,34 @@ symbol = "🌟 " ## Shell -The `shell` module shows an indicator for currently used shell. +El módulo `shell` muestra un indicador para el intérprete de comandos actualmente utilizado. -::: tip +::: consejo -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` a `false` en tu archivo de configuración. ::: ### Opciones -| Opción | Por defecto | Descripción | -| ---------------------- | ------------ | --------------------------------------------- | -| `bash_indicator` | `bsh` | A format string used to represent bash. | -| `fish_indicator` | `fsh` | A format string used to represent fish. | -| `zsh_indicator` | `zsh` | A format string used to represent zsh. | -| `powershell_indicator` | `psh` | A format string used to represent powershell. | -| `ion_indicator` | `ion` | A format string used to represent ion. | -| `elvish_indicator` | `esh` | A format string used to represent elvish. | -| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | -| `format` | `$indicator` | El formato del módulo. | -| `disabled` | `true` | Disables the `shell` module. | +| Opción | Por defecto | Descripción | +| ---------------------- | ------------ | ------------------------------------------------------------ | +| `bash_indicator` | `bsh` | Una cadena de formato usada para representar Bash. | +| `fish_indicator` | `fsh` | Una cadena de formato usada para representar Fish. | +| `zsh_indicator` | `zsh` | Una cadena de formato usada para representar Zsh. | +| `powershell_indicator` | `psh` | Una cadena de formato usada para representar Powershell. | +| `ion_indicator` | `ion` | Una cadena de formato usada para representar Ion. | +| `elvish_indicator` | `esh` | Una cadena de formato usada para representar Elvish. | +| `tcsh_indicator` | `tsh` | Una cadena de formato usada para representar tcsh. | +| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `format` | `$indicator` | El formato del módulo. | +| `disabled` | `true` | Deshabilita el módulo `shell`. | ### Variables -| Variable | Por defecto | Descripción | -| --------- | ----------- | ---------------------------------------------------------- | -| indicator | | Mirrors the value of `indicator` for currently used shell. | +| Variable | Por defecto | Descripción | +| --------- | ----------- | ------------------------------------------------------------------------------------ | +| indicator | | Ordena el valor de `indicator` para el intérprete de comandos actualmente utilizado. | ### Ejemplos @@ -2335,33 +2356,34 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [shell] fish_indicator = "" powershell_indicator = "_" +unknown_indicator = "mystery shell" disabled = false ``` ## SHLVL -The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. +El módulo `shlvl` muestra la variable de entorno actual `SHLVL` ("nivel de shell"), si está establecido en un número y alcanza o supera el umbral especificado. ### Opciones -| Opción | Por defecto | Descripción | -| ----------- | ---------------------------- | ------------------------------------------------------------- | -| `threshold` | `2` | Display threshold. | -| `format` | `"[$symbol$shlvl]($style) "` | El formato del módulo. | -| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | -| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | -| `style` | `"bold yellow"` | El estilo del módulo. | -| `disabled` | `true` | Disables the `shlvl` module. | +| Opción | Por defecto | Descripción | +| ----------- | ---------------------------- | ----------------------------------------------------------------- | +| `threshold` | `2` | Mostrar umbral. | +| `format` | `"[$symbol$shlvl]($style) "` | El formato del módulo. | +| `symbol` | `"↕️ "` | El símbolo utilizado para representar el `SHLVL`. | +| `repeat` | `false` | Hace que el `symbol` se repita con la cantidad actual de `SHLVL`. | +| `style` | `"bold yellow"` | El estilo del módulo. | +| `disabled` | `true` | Deshabilita el módulo `shlvl`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------- | -------------------------------------- | -| shlvl | `3` | The current value of `SHLVL` | +| shlvl | `3` | El valor actual de `SHLVL` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -2376,26 +2398,26 @@ threshold = 3 ## Singularity -The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | -------------------------------- | ------------------------------------------------ | -| `format` | `'[$symbol\[$env\]]($style) '` | El formato del módulo. | -| `symbol` | `""` | A format string displayed before the image name. | -| `style` | `"bold dimmed blue"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `singularity` module. | +| Opción | Por defecto | Descripción | +| ---------- | -------------------------------- | ------------------------------------------------------------------- | +| `format` | `'[$symbol\[$env\]]($style) '` | El formato del módulo. | +| `symbol` | `""` | Una cadena de formato que se muestra antes del nombre de la imagen. | +| `style` | `"bold dimmed blue"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `singularity`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------------ | -------------------------------------- | -| env | `centos.img` | The current singularity image | +| env | `centos.img` | The current Singularity image | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -2408,45 +2430,45 @@ format = '[📦 \[$env\]]($style) ' ## Status -The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. +El módulo `status` muestra el código de salida del comando anterior. El módulo se mostrará sólo si el código de salida no es `0`. -::: tip +::: consejo -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` a `false` en tu archivo de configuración. ::: -::: warning This module is not supported on elvish shell. ::: +::: advertencia Este módulo no es compatible con el intérprete de comandos Elvish. ::: ### Opciones -| Opción | Por defecto | Descripción | -| ----------------------- | ----------------------------- | ---------------------------------------------------- | -| `format` | `"[$symbol$status]($style) "` | The format of the module | -| `symbol` | `"✖"` | The symbol displayed on program error | -| `not_executable_symbol` | `"🚫"` | The symbol displayed when file isn't executable | -| `not_found_symbol` | `"🔍"` | The symbol displayed when the command can't be found | -| `sigint_symbol` | `"🧱"` | The symbol displayed on SIGINT (Ctrl + c) | -| `signal_symbol` | `"⚡"` | The symbol displayed on any signal | -| `style` | `"bold red"` | El estilo del módulo. | -| `recognize_signal_code` | `true` | Enable signal mapping from exit code | -| `map_symbol` | `false` | Enable symbols mapping from exit code | -| `disabled` | `true` | Disables the `status` module. | +| Opción | Por defecto | Descripción | +| ----------------------- | ----------------------------- | ------------------------------------------------------ | +| `format` | `"[$symbol$status]($style) "` | El formato del módulo | +| `symbol` | `"✖"` | El símbolo mostrado en error del programa | +| `not_executable_symbol` | `"🚫"` | El símbolo mostrado cuando el archivo no es ejecutable | +| `not_found_symbol` | `"🔍"` | El símbolo mostrado cuando no se encuentra el comando | +| `sigint_symbol` | `"🧱"` | El símbolo mostrado en SIGINT (Ctrl + c) | +| `signal_symbol` | `"⚡"` | El símbolo mostrado en cualquier señal | +| `style` | `"bold red"` | El estilo del módulo. | +| `recognize_signal_code` | `true` | Activar mapeo de señales desde el código de salida | +| `map_symbol` | `false` | Activar mapeo de símbolos desde el código de salida | +| `disabled` | `true` | Desactiva el módulo `status`. | ### Variables -| Variable | Ejemplo | Descripción | -| -------------- | ------- | -------------------------------------------------------------------- | -| status | `127` | The exit code of the last command | -| int | `127` | The exit code of the last command | -| common_meaning | `ERROR` | Meaning of the code if not a signal | -| signal_number | `9` | Signal number corresponding to the exit code, only if signalled | -| signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled | -| maybe_int | `7` | Contains the exit code number when no meaning has been found | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| -------------- | ------- | ------------------------------------------------------------------------------------ | +| status | `127` | El código de salida del último comando | +| int | `127` | El código de salida del último comando | +| common_meaning | `ERROR` | Comprobación del código si no es una señal | +| signal_number | `9` | Número de señal correspondiente al código de salida, sólo si está señalizada | +| signal_name | `KILL` | Nombre de la señal correspondiente al código de salida, sólo si está señalizada | +| maybe_int | `7` | Contiene el número de código de salida cuando no se ha encontrado ningún significado | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -2465,32 +2487,33 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- The current directory contains a `Package.swift` file -- The current directory contains a file with the `.swift` extension +- El directorio actual contiene un archivo `Package.swift` +- El directorio actual contiene un archivo con la extensión `.swift` ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ------------------------------------ | ---------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | -| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Qué extensiones deberían activar este módulo. | -| `detect_files` | `["Package.swift"]` | Qué nombres de archivo deberían activar este módulo. | -| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | -| `style` | `"bold 202"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `swift` module. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐦 "` | Una cadena de formato que representa el símbolo de Swift | +| `detect_extensions` | `["swift"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["Package.swift"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | +| `style` | `"bold 202"` | El estilo del módulo. | +| `disabled` | `false` | Deshabilita el módulo `swift`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v5.2.4` | The version of `swift` | +| version | `v5.2.4` | La versión de `swift` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -2503,45 +2526,46 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. -::: tip +::: consejo -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). +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. Si aún deseas activarlo, [sigue el ejemplo que se muestra a continuación](#with-terraform-version). ::: Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- The current directory contains a `.terraform` folder -- Current directory contains a file with the `.tf` or `.hcl` extensions +- El directorio actual contiene una carpeta `.terraform` +- El directorio actual contiene un archivo con las extensiones `.tf` o `.hcl` ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol$workspace]($style) "` | La cadena de formato para el módulo. | -| `symbol` | `"💠"` | A format string shown before the terraform workspace. | -| `detect_extensions` | `["tf", "hcl"]` | Qué extensiones deberían activar este módulo. | -| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | -| `detect_folders` | `[".terraform"]` | Qué carpetas deberían activar este módulo. | -| `style` | `"bold 105"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `terraform` module. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol$workspace]($style) "` | La cadena de formato para el módulo. | +| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💠"` | Una cadena de formato que se muestra antes del espacio de trabajo de terraform. | +| `detect_extensions` | `["tf", "hcl"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[".terraform"]` | Qué carpetas deberían activar este módulo. | +| `style` | `"bold 105"` | El estilo del módulo. | +| `disabled` | `false` | Deshabilita el módulo `de terraforma`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ---------- | -------------------------------------- | -| version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current terraform workspace | +| version | `v0.12.24` | La versión de `terraform` | +| workspace | `default` | The current Terraform workspace | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo -#### Con la versión +#### With Terraform Version ```toml # ~/.config/starship.toml @@ -2550,7 +2574,7 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes format = "[🏎💨 $version$workspace]($style) " ``` -#### Sin la versión +#### Without Terraform version ```toml # ~/.config/starship.toml @@ -2561,36 +2585,36 @@ 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 +::: consejo -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` a `false` en tu archivo de configuración. ::: ### Opciones -| Opción | Por defecto | Descripción | -| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `format` | `"at [$time]($style) "` | La cadena de formato para el módulo. | -| `use_12hr` | `false` | Enables 12 hour formatting | -| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | -| `style` | `"bold yellow"` | The style for the module time | -| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | -| `disabled` | `true` | Disables the `time` module. | -| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| Opción | Por defecto | Descripción | +| ----------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `"at [$time]($style) "` | La cadena de formato para el módulo. | +| `use_12hr` | `false` | Activa el formato de 12 horas | +| `time_format` | see below | La [cadena de formato de chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) utilizada para formatear la hora. | +| `style` | `"bold yellow"` | El estilo para la hora del módulo | +| `utc_time_offset` | `"local"` | Establece el desplazamiento UTC a utilizar. Rango de -24 < x < 24. Permite a los flotantes acomodar los desplazamientos de zona horaria de 30/45 minutos. | +| `disabled` | `true` | Desactiva el módulo `time`. | +| `time_range` | `"-"` | Establece el intervalo de tiempo durante el cual se mostrará el módulo. Las horas deben especificarse 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 | Variable | Ejemplo | Descripción | | --------- | ---------- | ------------------------------------- | -| time | `13:08:10` | The current time. | +| time | `13:08:10` | La hora actual. | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -2605,37 +2629,37 @@ utc_time_offset = "-5" time_range = "10:00:00-14:00:00" ``` -## Username +## Nombre de usuario -The `username` module shows active user's username. The module will be shown if any of the following conditions are met: +El módulo `username` muestra el nombre de usuario activo. El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- The current user is root -- The current user isn't the same as the one that is logged in -- The user is currently connected as an SSH session -- The variable `show_always` is set to true +- El usuario actual es root +- El usuario actual no es el mismo que el que está conectado +- El usuario está actualmente conectado como una sesión SSH +- La variable `show_always` se establece en true -::: tip +::: consejo -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. ::: ### Opciones -| Opción | Por defecto | Descripción | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `style_user` | `"bold yellow"` | The style used for non-root users. | -| `format` | `"[$user]($style) in "` | El formato del módulo. | -| `show_always` | `false` | Always shows the `username` module. | -| `disabled` | `false` | Disables the `username` module. | +| Opción | Por defecto | Descripción | +| ------------- | ----------------------- | ------------------------------------------ | +| `style_root` | `"bold red"` | El estilo usado cuando el usuario es root. | +| `style_user` | `"bold yellow"` | El estilo usado para usuarios no root. | +| `format` | `"[$user]($style) in "` | El formato del módulo. | +| `show_always` | `false` | Siempre muestra el módulo `username`. | +| `disabled` | `false` | Deshabilita el módulo `username`. | ### Variables -| Variable | Ejemplo | Descripción | -| -------- | ------------ | ------------------------------------------------------------------------------------------- | -| `style` | `"red bold"` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. | -| `user` | `"matchai"` | The currently logged-in user ID. | +| Variable | Ejemplo | Descripción | +| -------- | ------------ | --------------------------------------------------------------------------------------------------- | +| `style` | `"red bold"` | Refleja el valor de la opción `style_root` cuando root inició sesión y `style_user` por otra parte. | +| `user` | `"matchai"` | El ID de usuario conectado actualmente. | ### Ejemplo @@ -2652,31 +2676,32 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of Vagrant. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- The current directory contains a `Vagrantfile` file +- 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` | `"⍱ "` | A format string representing the symbol of Vagrant. | -| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | -| `detect_files` | `["Vagrantfile"]` | Qué nombres de archivo deberían activar este módulo. | -| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | -| `style` | `"cyan bold"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `vagrant` module. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"⍱ "` | Una cadena de formato que representa el símbolo de Vagrant. | +| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["Vagrantfile"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | +| `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` | The version of `Vagrant` | +| 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` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -2689,26 +2714,26 @@ format = "via [⍱ $version](bold white) " ## VCSH -The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. El módulo sólo se mostrará si un repositorio está actualmente en uso. ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | -------------------------------- | ------------------------------------------------------ | -| `symbol` | | The symbol used before displaying the repository name. | -| `style` | `"bold yellow"` | El estilo del módulo. | -| `format` | `"vcsh [$symbol$repo]($style) "` | El formato del módulo. | -| `disabled` | `false` | Disables the `vcsh` module. | +| Opción | Por defecto | Descripción | +| ---------- | -------------------------------- | ------------------------------------------------------------ | +| `symbol` | | El símbolo usado antes de mostrar el nombre del repositorio. | +| `style` | `"bold yellow"` | El estilo del módulo. | +| `format` | `"vcsh [$symbol$repo]($style) "` | El formato del módulo. | +| `disabled` | `false` | Deshabilita el módulo `vcsh`. | ### Variables -| Variable | Ejemplo | Descripción | -| --------- | ------------------------------------------- | -------------------------------------- | -| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | `black bold dimmed` | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| ----------- | ----------------------------------------------------------- | -------------------------------------- | +| repositorio | `dotfiles` si está en un repositorio VCSH nombrado dotfiles | El nombre del repositorio activo | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | `black bold dimmed` | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -2721,31 +2746,32 @@ format = "[🆅 $repo](bold blue) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- The current directory contains a `.zig` file +- El directorio actual contiene un archivo `.zig` ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | -| `style` | `"bold yellow"` | El estilo del módulo. | -| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | -| `disabled` | `false` | Disables the `zig` module. | -| `detect_extensions` | `["zig"]` | Qué extensiones deberían activar este módulo. | -| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | -| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `version_format` | `v{raw}` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"↯ "` | El símbolo usado antes de mostrar la versión de Zig. | +| `style` | `"bold yellow"` | El estilo del módulo. | +| `disabled` | `false` | Deshabilita el módulo `zig`. | +| `detect_extensions` | `["zig"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v0.6.0` | The version of `zig` | +| version | `v0.6.0` | La versión de `zig` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -2756,87 +2782,87 @@ By default the the `zig` module shows the currently installed version of Zig. Th symbol = "⚡️ " ``` -## Custom commands +## 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: -- The current directory contains a file whose name is in `files` -- The current directory contains a directory whose name is in `directories` -- The current directory contains a file whose extension is in `extensions` -- The `when` command returns 0 +- El directorio actual contiene un archivo cuyo nombre está en `files` +- El directorio actual contiene un directorio cuyo nombre está en `directories` +- El directorio actual contiene un archivo cuya extensión está en `extensions` +- El comando `when` devuelve 0 -::: tip +::: consejo -Multiple custom modules can be defined by using a `.`. +Múltiples módulos personalizados pueden definirse usando una `.`. ::: -::: tip +::: consejo -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 +::: consejo -[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 tiene un ejemplo interesante no cubierto allí, no dude en compartirlo allí! ::: ### Opciones -| Opción | Por defecto | Descripción | -| ------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | -| `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | -| `shell` | | [See below](#custom-command-shell) | -| `description` | `""` | The description of the module that is shown when running `starship explain`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | -| `symbol` | `""` | The symbol used before displaying the command output. | -| `style` | `"bold green"` | El estilo del módulo. | -| `format` | `"[$symbol($output )]($style)"` | El formato del módulo. | -| `disabled` | `false` | Disables this `custom` module. | +| Opción | Por defecto | Descripción | +| ------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | +| `command` | | El comando cuya salida debe ser impresa. El comando se pasará en stdin al intérprete de comandos. | +| `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` | Deshabilita este `módulo` personalizado. | ### Variables -| Variable | Descripción | -| --------- | -------------------------------------- | -| output | The output of shell command in `shell` | -| symbol | Refleja el valor de la opción `symbol` | -| style\* | Refleja el valor de la opción `style` | +| Variable | Descripción | +| --------- | ----------------------------------------- | +| output | La salida del comando de shell en `shell` | +| symbol | Refleja el valor de la opción `symbol` | +| style\* | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo #### Comando personalizado del intérprete de comandos -`shell` accepts a non-empty list of strings, where: +`shell` acepta una lista no vacía de cadenas, donde: -- The first string is the path to the shell to use to execute the command. -- Other following arguments are passed to the shell. +- La primera cadena es la ruta al intérprete de comandos a usar para ejecutar el comando. +- Otros argumentos siguientes que 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 intérpretes de comandos y la adición adecuada de parámetros están actualmente implementados, pero es posible que no todos los intérpretes de comandos 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. ::: @@ -2846,8 +2872,8 @@ Automatic detection of shells and proper parameters addition are currently imple # ~/.config/starship.toml [custom.foo] -command = "echo foo" # shows output of command -files = ["foo"] # can specify filters +command = "echo foo" # muestra la salida del comando +files = ["foo"] # se pueden especificar filtros when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" diff --git a/docs/fr-FR/config/README.md b/docs/fr-FR/config/README.md index e90d6c13..0a5f0a56 100644 --- a/docs/fr-FR/config/README.md +++ b/docs/fr-FR/config/README.md @@ -3,7 +3,7 @@ Pour commencer à configurer starship, créez le fichier suivant : `~/.config/starship.toml`. ```sh -mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml +mkdir -p ~/.config && touch ~/.config/starship.toml ``` Toute la configuration de starship est faite dans ce fichier [TOML](https://github.com/toml-lang/toml): @@ -49,9 +49,9 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ### Terminologie -**Module**: Un composant dans l'invite donnant des informations basées sur des informations contextuelles à propos de votre Système d'Exploitation. Par exemple, le module "nodejs" montre la version de NodeJS qui est actuellement installée sur votre ordinateur, si votre répertoire actuel est un projet NodeJS. +**Module**: Un composant dans l'invite donnant des informations basées sur des informations contextuelles à propos de votre Système d'Exploitation. Par exemple, le module "nodejs" montre la version de Node.js qui est actuellement installée sur votre ordinateur, si votre répertoire actuel est un projet Node.js. -**Variable**: Petits sous-composants qui contiennent des informations fournies par le module. Par exemple, la variable "version" dans le module "nodejs" contient la version actuelle de NodeJS. +**Variable**: Petits sous-composants qui contiennent des informations fournies par le module. Par exemple, la variable "version" dans le module "nodejs" contient la version actuelle de Node.js. Par convention, la plupart des modules ont un préfixe de la couleur par défaut du terminal (par exemple `via` dans "nodejs") et un espace vide comme suffixe. @@ -384,7 +384,7 @@ Le caractère vous dira si la dernière commande a été réussie ou pas. Il y a - changement de couleur (`red`/`green`) - changement de forme (`❯`/`✖`) -Par défaut, seule la couleur change. Si vous désirez également changer sa forme, jetez un œil à [cet exemple](#with-custom-error-shape). +Par défaut, seule la couleur change. If you also want to change its shape take a look at [this example](#with-custom-error-shape). ::: warning `error_symbol` n'est pas supporté avec elvish. ::: @@ -437,22 +437,23 @@ vicmd_symbol = "[V](bold green) " ## CMake -Le module `cmake` affiche la version actuellement installée de CMake. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: +Le module `cmake` affiche la version actuellement installée de [CMake](https://cmake.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le répertoire actuel contient un fichier `CMakeLists.txt` - Le répertoire actuel contient un fichier ` CMakeCache.txt` ### Options -| Option | Défaut | Description | -| ------------------- | -------------------------------------- | ---------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format du module. | -| `symbol` | `"△ "` | Le symbole utilisé avant la version de cmake. | -| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Quels fichiers devraient activer ce module | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module | -| `style` | `"bold blue"` | Le style du module. | -| `disabled` | `false` | Désactive le module `cmake`. | +| Option | Défaut | Description | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format du module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"△ "` | Le symbole utilisé avant la version de cmake. | +| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Quels fichiers devraient activer ce module | +| `detect_folders` | `[]` | Quels dossiers devraient activer ce module | +| `style` | `"bold blue"` | Le style du module. | +| `disabled` | `false` | Désactive le module `cmake`. | ### Variables @@ -555,22 +556,23 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -Le module `crystal` affiche la version actuellement installée de Crystal. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: +Le module `crystal` affiche la version actuellement installée de [Crystal](https://crystal-lang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le répertoire courant contient un fichier `shard.yml` - Le répertoire courant contient un fichier `.cr` ### Options -| Option | Défaut | Description | -| ------------------------------------ | ------------------------------------ | ---------------------------------------------------------- | -| `symbol` | `"🔮 "` | Le symbole utilisé avant d'afficher la version de crystal. | -| `style` | `"bold green"` | Le style du module. | -| `detect_extensionsdetect_extensions` | `["cr"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["shard.yml"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | -| `format` | `"via [$symbol($version )]($style)"` | Format du module. | -| `disabled` | `false` | Désactive le module `crystal`. | +| Option | Défaut | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `symbol` | `"🔮 "` | Le symbole utilisé avant d'afficher la version de crystal. | +| `format` | `"via [$symbol($version )]($style)"` | Format du module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `"bold green"` | Le style du module. | +| `detect_extensions` | `["cr"]` | Quelles extensions devraient activer ce module. | +| `detect_files` | `["shard.yml"]` | Quels fichiers devraient activer ce module. | +| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | +| `disabled` | `false` | Désactive le module `crystal`. | ### Variables @@ -593,7 +595,7 @@ format = "via [✨ $version](bold blue) " ## Dart -Le module `dart` affiche la version actuellement installée de Dart. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: +Le module `dart` affiche la version actuellement installée de [Dart](https://dart.dev/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le répertoire courant contient un fichier `.dart` - Le répertoire courant contient un répertoire `.dart_tool` @@ -601,15 +603,16 @@ Le module `dart` affiche la version actuellement installée de Dart. Par défaut ### Options -| Option | Défaut | Description | -| ------------------- | ------------------------------------------------- | -------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format du module. | -| `symbol` | `"🎯 "` | Une chaîne de caractères représentant le symbole de Dart | -| `detect_extensions` | `['dart']` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[".dart_tool"]` | Quels dossiers devraient activer ce module. | -| `style` | `"bold blue"` | Le style du module. | -| `disabled` | `false` | Désactive le module `dart`. | +| Option | Défaut | Description | +| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format du module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🎯 "` | Une chaîne de caractères représentant le symbole de Dart | +| `detect_extensions` | `["dart"]` | Quelles extensions devraient activer ce module. | +| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Quels fichiers devraient activer ce module. | +| `detect_folders` | `[".dart_tool"]` | Quels dossiers devraient activer ce module. | +| `style` | `"bold blue"` | Le style du module. | +| `disabled` | `false` | Désactive le module `dart`. | ### Variables @@ -632,20 +635,21 @@ format = "via [🔰 $version](bold red) " ## Deno -Le module `deno` vous montre votre version de Deno actuellement installée. Par défaut, le module sera affiché si l'une des conditions suivantes est remplie : +Le module `deno` affiche la version actuellement installée de [Deno](https://deno.land/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le répertoire courant contient un fichier `mod.ts`, `mod.js`, `deps.ts` ou `deps.ts` ### Options -| Option | Défaut | Description | -| ------------------- | -------------------------------------------- | -------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format du module. | -| `symbol` | `"🦕 "` | Une chaîne de caractères représentant le symbole de Deno | -| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | -| `style` | `"green bold"` | Le style du module. | -| `disabled` | `false` | Désactive le module `deno`. | +| Option | Défaut | Description | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format du module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🦕 "` | Une chaîne de caractères représentant le symbole de Deno | +| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. | +| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Quels fichiers devraient activer ce module. | +| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | +| `style` | `"green bold"` | Le style du module. | +| `disabled` | `false` | Désactive le module `deno`. | ### Variables @@ -666,11 +670,11 @@ format = "via [🦕 $version](green bold) " ## Dossier -The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. +Le module `Dossier` montre le chemin vers votre répertoire courant, tronqué à trois dossiers parents. Votre répertoire sera également tronqué à la racine du repo git dans lequel vous vous trouvez actuellement. -When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. +Lorsque vous utilisez le style de pwd de fish, au lieu de cacher le chemin tronqué, vous verrez une abréviation du nom de chaque dossier, en fonction du nombre que vous avez utilisé comme valeur. -For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. +Par exemple, `~/Dev/Nix/nixpkgs/pkgs` où `nixpkgs` est la racine du repo, et l'option définie à `1`. Vous verrez maintenant `~/D/N/nixpkgs/pkgs`, alors que vous auriez vu `nixpkgs/pkgs` avant. ### Options @@ -687,7 +691,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | `home_symbol` | `"~"` | Le symbole indiquant le répertoire personnel. |
-This module has a few advanced configuration options that control how the directory is displayed. +Ce module possède quelques options de configuration avancées qui contrôlent l'affichage du répertoire. | Options avancées | Défaut | Description | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -695,7 +699,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | `fish_style_pwd_dir_length` | `0` | Le nombre de caractères à utiliser lors de l'application de la logique de troncature du pwd de fish. | | `use_logical_path` | `true` | Si `true` affiche le chemin logique issu du shell via `PWD` ou `--logical-path`. Si `false` renvoie plutôt le chemin du système de fichiers physique avec les liens symboliques résolus. | -`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. +`substitutions` vous permet de définir des remplacements arbitraires pour les chaînes littérales qui apparaissent dans le chemin, par exemple pour de longs préfixes de réseau ou des répertoires de développement (ex. Java). Notez que cela désactivera la PWD de style fish. ```toml [directory.substitutions] @@ -703,7 +707,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an "src/com/long/java/path" = "mypath" ``` -`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`. +`fish_style_pwd_dir_leng` interagit avec les options de troncature d'une manière qui peut être surprenante au début : si elle n'est pas nulle, les composantes du chemin qui seraient normalement tronquées sont affichées à la place avec autant de caractères. Par exemple, le chemin `/built/this/city/on/rock/and/roll`, qui devrait normalement être affiché comme `rock/and/roll`, sera affiché sous la forme de `/b/t/c/o/rock/and/roll` avec `fish_style_pwd_dir_length = 1`--les composants de chemin qui seraient normalement supprimés sont affichés avec un caractère unique. Pour `fish_style_pwd_dir_length = 2`, ce serait `/bu/th/ci/on/rock/and/roll`.
@@ -728,7 +732,7 @@ truncation_symbol = "…/" ## Contexte Docker -The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default`. +Le module `docker_context` affiche le [contexte Docker](https://docs.docker.com/engine/context/working-with-contexts/) actuellement actif s'il n'est pas réglé à `default`. ### Options @@ -764,9 +768,9 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. Si le SDK a été épinglé dans le répertoire courant, la version épinglée est affichée. Sinon, le module affiche la dernière version installée du SDK. -By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: +Par défaut, ce module ne sera affiché dans votre invite que lorsqu'un ou plusieurs des fichiers suivants sont présents dans le répertoire courant : - `global.json` - `project.json` @@ -778,9 +782,9 @@ By default this module will only be shown in your prompt when one or more of the - `*.fsproj` - `*.xproj` -You'll also need the .NET Core SDK installed in order to use it correctly. +Vous aurez également besoin du SDK .NET Core pour pouvoir l'utiliser correctement. -Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. +En interne, ce module utilise son propre mécanisme de détection de version. Généralement, il est deux fois plus rapide que d'exécuter `dotnet --version`, mais il peut afficher une version incorrecte si votre projet .NET a une arborescence inhabituelle. Si la précision est plus importante que la vitesse, vous pouvez désactiver le mécanisme en définissant `heuristic = false` dans les options du module. The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. @@ -789,6 +793,7 @@ The module will also show the Target Framework Moniker ( ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager. @@ -1949,7 +1965,7 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of Perl. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file @@ -1959,15 +1975,16 @@ The `perl` module shows the currently installed version of Perl. Par défaut le ### Options -| Option | Défaut | Description | -| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | -| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | -| `detect_extensions` | `["pl", "pm", "pod"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | -| `style` | `"bold 149"` | Le style du module. | -| `disabled` | `false` | Disables the `perl` module. | +| Option | Défaut | Description | **** | +| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- | +| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | +| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | +| `detect_extensions` | `["pl", "pm", "pod"]` | Quelles extensions devraient activer ce module. | | +| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Quels fichiers devraient activer ce module. | | +| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | | +| `style` | `"bold 149"` | Le style du module. | | +| `disabled` | `false` | Disables the `perl` module. | | ### Variables @@ -1988,23 +2005,24 @@ format = "via [🦪 $version]($style) " ## PHP -The `php` module shows the currently installed version of PHP. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). Par défaut le module sera activé si au moins l'une des conditions suivantes 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` extension ### Options -| Option | Défaut | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format du module. | -| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | -| `detect_extensions` | `["php"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["composer.json", ".php-version"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | -| `style` | `"147 bold"` | Le style du module. | -| `disabled` | `false` | Disables the `php` module. | +| Option | Défaut | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format du module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `detect_extensions` | `["php"]` | Quelles extensions devraient activer ce module. | +| `detect_files` | `["composer.json", ".php-version"]` | Quels fichiers devraient activer ce module. | +| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | +| `style` | `"147 bold"` | Le style du module. | +| `disabled` | `false` | Disables the `php` module. | ### Variables @@ -2027,22 +2045,23 @@ format = "via [🔹 $version](147 bold) " ## PureScript -The `purescript` module shows the currently installed version of PureScript version. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: -- The current directory contains a `spago.dhall` file +- Le répertoire courant contient un fichier `spago.dhall` - The current directory contains a file with the `.purs` extension ### Options -| Option | Défaut | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | Format du module. | -| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["spago.dhall"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | -| `style` | `"bold white"` | Le style du module. | -| `disabled` | `false` | Disables the `purescript` module. | +| Option | Défaut | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format du module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"<=> "` | Le symbole utilisé avant d'afficher la version de PureScript. | +| `detect_extensions` | `["purs"]` | Quelles extensions devraient activer ce module. | +| `detect_files` | `["spago.dhall"]` | Quels fichiers devraient activer ce module. | +| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | +| `style` | `"bold white"` | Le style du module. | +| `disabled` | `false` | Désactive le module `purescript`. | ### Variables @@ -2065,7 +2084,7 @@ format = "via [$symbol$version](bold white)" ## Python -The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. @@ -2074,10 +2093,10 @@ Par défaut le module sera activé si au moins l'une des conditions suivantes es - The current directory contains a `.python-version` file - The current directory contains a `Pipfile` file - The current directory contains a `__init__.py` file -- The current directory contains a `pyproject.toml` file -- The current directory contains a `requirements.txt` file -- The current directory contains a `setup.py` file -- The current directory contains a `tox.ini` file +- Le répertoire courant contient un fichier `pyproject.toml` +- Le répertoire courant contient un fichier `requirements.txt` +- Le répertoire courant contient un fichier `setup.py` +- Le répertoire courant contient un fichier `tox.ini` - The current directory contains a file with the `.py` extension. - A virtual environment is currently activated @@ -2092,7 +2111,7 @@ Par défaut le module sera activé si au moins l'une des conditions suivantes es | `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | -| `detect_extensions` | `[".py"]` | Quelles extensions devraient activer ce module | +| `detect_extensions` | `["py"]` | Quelles extensions devraient activer ce module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Quels fichiers devraient activer ce module | | `detect_folders` | `[]` | Quels dossiers devraient activer ce module | | `disabled` | `false` | Disables the `python` module. | @@ -2143,7 +2162,7 @@ detect_extensions = [] ## Red -By default the `red` module shows the currently installed version of Red. The module will be shown if any of the following conditions are met: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). Le module est affiché si l'une de ces conditions est remplie : - The current directory contains a file with `.red` or `.reds` extension @@ -2181,7 +2200,7 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). Le module est affiché si l'une de ces conditions est remplie : - The current directory contains a `Gemfile` file - The current directory contains a `.ruby-version` file @@ -2221,7 +2240,7 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). Le module est affiché si l'une de ces conditions est remplie : - The current directory contains a `Cargo.toml` file - The current directory contains a file with the `.rs` extension @@ -2260,7 +2279,7 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of Scala. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension @@ -2268,15 +2287,16 @@ The `scala` module shows the currently installed version of Scala. Par défaut l ### Options -| Option | Défaut | Description | -| ------------------- | ---------------------------------------- | ------------------------------------------------- | -| `format` | `"via [${symbol}(${version} )]($style)"` | Format du module. | -| `detect_extensions` | `["sbt", "scala"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | -| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | -| `style` | `"red dimmed"` | Le style du module. | -| `disabled` | `false` | Disables the `scala` module. | +| Option | Défaut | Description | +| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | Format du module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["sbt", "scala"]` | Quelles extensions devraient activer ce module. | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Quels fichiers devraient activer ce module. | +| `detect_folders` | `[".metals"]` | Quels dossiers devraient activer ce module. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `style` | `"red dimmed"` | Le style du module. | +| `disabled` | `false` | Disables the `scala` module. | ### Variables @@ -2303,23 +2323,24 @@ The `shell` module shows an indicator for currently used shell. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. ::: ### Options -| Option | Défaut | Description | -| ---------------------- | ------------ | --------------------------------------------- | -| `bash_indicator` | `bsh` | A format string used to represent bash. | -| `fish_indicator` | `fsh` | A format string used to represent fish. | -| `zsh_indicator` | `zsh` | A format string used to represent zsh. | -| `powershell_indicator` | `psh` | A format string used to represent powershell. | -| `ion_indicator` | `ion` | A format string used to represent ion. | -| `elvish_indicator` | `esh` | A format string used to represent elvish. | -| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | -| `format` | `$indicator` | Format du module. | -| `disabled` | `true` | Disables the `shell` module. | +| Option | Défaut | Description | +| ---------------------- | ------------ | ------------------------------------------------------------ | +| `bash_indicator` | `bsh` | A format string used to represent bash. | +| `fish_indicator` | `fsh` | A format string used to represent fish. | +| `zsh_indicator` | `zsh` | A format string used to represent zsh. | +| `powershell_indicator` | `psh` | A format string used to represent powershell. | +| `ion_indicator` | `ion` | A format string used to represent ion. | +| `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | +| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `format` | `$indicator` | Format du module. | +| `disabled` | `true` | Disables the `shell` module. | ### Variables @@ -2335,6 +2356,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [shell] fish_indicator = "" powershell_indicator = "_" +unknown_indicator = "mystery shell" disabled = false ``` @@ -2376,7 +2398,7 @@ threshold = 3 ## Singularity -The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Options @@ -2391,7 +2413,7 @@ The `singularity` module shows the current singularity image, if inside a contai | Variable | Exemple | Description | | --------- | ------------ | -------------------------------------- | -| env | `centos.img` | The current singularity image | +| env | `centos.img` | The current Singularity image | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2412,7 +2434,7 @@ The `status` module displays the exit code of the previous command. The module w ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. ::: @@ -2465,22 +2487,23 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). Le module est affiché si l'une de ces conditions est remplie : - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension ### Options -| Option | Défaut | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | Format du module. | -| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["Package.swift"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | -| `style` | `"bold 202"` | Le style du module. | -| `disabled` | `false` | Disables the `swift` module. | +| Option | Défaut | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format du module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `detect_extensions` | `["swift"]` | Quelles extensions devraient activer ce module. | +| `detect_files` | `["Package.swift"]` | Quels fichiers devraient activer ce module. | +| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | +| `style` | `"bold 202"` | Le style du module. | +| `disabled` | `false` | Disables the `swift` module. | ### Variables @@ -2503,11 +2526,11 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: 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). +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-terraform-version). ::: @@ -2518,22 +2541,23 @@ Par défaut le module sera activé si au moins l'une des conditions suivantes es ### Options -| Option | Défaut | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | -| `symbol` | `"💠"` | A format string shown before the terraform workspace. | -| `detect_extensions` | `["tf", "hcl"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `[]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[".terraform"]` | Quels dossiers devraient activer ce module. | -| `style` | `"bold 105"` | Le style du module. | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | Défaut | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | +| `detect_extensions` | `["tf", "hcl"]` | Quelles extensions devraient activer ce module. | +| `detect_files` | `[]` | Quels fichiers devraient activer ce module. | +| `detect_folders` | `[".terraform"]` | Quels dossiers devraient activer ce module. | +| `style` | `"bold 105"` | Le style du module. | +| `disabled` | `false` | Disables the `terraform` module. | ### Variables | Variable | Exemple | Description | | --------- | ---------- | -------------------------------------- | | version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current terraform workspace | +| workspace | `default` | The current Terraform workspace | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2541,7 +2565,7 @@ Par défaut le module sera activé si au moins l'une des conditions suivantes es ### Exemple -#### With Version +#### With Terraform Version ```toml # ~/.config/starship.toml @@ -2550,7 +2574,7 @@ Par défaut le module sera activé si au moins l'une des conditions suivantes es format = "[🏎💨 $version$workspace]($style) " ``` -#### Without version +#### Without Terraform version ```toml # ~/.config/starship.toml @@ -2561,33 +2585,33 @@ format = "[🏎💨 $workspace]($style) " ## Date et Heure -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 -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. ::: ### Options -| Option | Défaut | Description | -| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `format` | `"at [$time]($style) "` | The format string for the module. | -| `use_12hr` | `false` | Enables 12 hour formatting | -| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | -| `style` | `"bold yellow"` | The style for the module time | -| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | -| `disabled` | `true` | Disables the `time` module. | -| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| Option | Défaut | Description | +| ----------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `format` | `"at [$time]($style) "` | The format string for the module. | +| `use_12hr` | `false` | Activer le format 12h | +| `time_format` | voir plus bas | Le [format chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) utilisé pour formater l'heure. | +| `style` | `"bold yellow"` | Le style utilisé par le module | +| `utc_time_offset` | `"local"` | Définir le décalage horaire UTC à utiliser. Range from -24 < x < 24. Accepte des nombres décimaux pour s'adapter aux décalages de 30/45 minutes. | +| `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 | Variable | Exemple | Description | | --------- | ---------- | ------------------------------------- | -| time | `13:08:10` | The current time. | +| temps | `13:08:10` | The current time. | | 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 @@ -2605,14 +2629,14 @@ utc_time_offset = "-5" time_range = "10:00:00-14:00:00" ``` -## Username +## Nom d'utilisateur -The `username` module shows active user's username. The module will be shown if any of the following conditions are met: +Le module `username` affiche le nom d'utilisateur de l'utilisateur actif. Le module est affiché si l'une de ces conditions est remplie : -- The current user is root -- The current user isn't the same as the one that is logged in -- The user is currently connected as an SSH session -- The variable `show_always` is set to true +- L'utilisateur courant est root +- L'utilisateur courant est différent de celui connecté +- L'utilisateur est actuellement connecté à une session SSH +- La variable `show_always` a comme valeur true ::: tip @@ -2622,13 +2646,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### Options -| Option | Défaut | Description | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold green"` | The style used when the user is root. | -| `style_user` | `"bold yellow"` | The style used for non-root users. | -| `format` | `"[$user]($style) in "` | Format du module. | -| `show_always` | `false` | Always shows the `username` module. | -| `disabled` | `false` | Disables the `username` module. | +| Option | Défaut | Description | +| ------------- | ----------------------- | ------------------------------------------------ | +| `style_root` | `"bold green"` | Le style utilisé quand l'utilisateur est root. | +| `style_user` | `"bold yellow"` | Le style utilisé pour les utilisateurs non-root. | +| `format` | `"[$user]($style) in "` | Format du module. | +| `show_always` | `false` | Toujours afficher le module `username`. | +| `disabled` | `false` | Désactiver le module `username`. | ### Variables @@ -2652,21 +2676,22 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of Vagrant. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). Par défaut le module sera activé si au moins l'une des conditions suivantes 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. | -| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["Vagrantfile"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | -| `style` | `"cyan bold"` | Le style du module. | -| `disabled` | `false` | Disables the `vagrant` module. | +| Option | Défaut | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format du module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. | +| `detect_files` | `["Vagrantfile"]` | Quels fichiers devraient activer ce module. | +| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | +| `style` | `"cyan bold"` | Le style du module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2689,7 +2714,7 @@ format = "via [⍱ $version](bold white) " ## VCSH -The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### Options @@ -2721,21 +2746,22 @@ format = "[🆅 $repo](bold blue) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). Le module est affiché si l'une de ces conditions est remplie : - The current directory contains a `.zig` file ### Options -| Option | Défaut | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | -| `style` | `"bold yellow"` | Le style du module. | -| `format` | `"via [$symbol($version )]($style)"` | Format du module. | -| `disabled` | `false` | Disables the `zig` module. | -| `detect_extensions` | `["zig"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `[]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | +| Option | Défaut | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format du module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | +| `style` | `"bold yellow"` | Le style du module. | +| `disabled` | `false` | Disables the `zig` module. | +| `detect_extensions` | `["zig"]` | Quelles extensions devraient activer ce module. | +| `detect_files` | `[]` | Quels fichiers devraient activer ce module. | +| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | ### Variables @@ -2813,9 +2839,9 @@ 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ù: -- The first string is the path to the shell to use to execute the command. +- 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. If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows. diff --git a/docs/it-IT/README.md b/docs/it-IT/README.md index 0f0a9ce5..45eea455 100644 --- a/docs/it-IT/README.md +++ b/docs/it-IT/README.md @@ -32,7 +32,7 @@ description: Starship è il prompt minimalista, super veloce ed estremamente per - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal. -### Quick Install +### Installazione Veloce 1. Installa il binario **starship**: diff --git a/docs/it-IT/advanced-config/README.md b/docs/it-IT/advanced-config/README.md index 74a154f5..c5892074 100644 --- a/docs/it-IT/advanced-config/README.md +++ b/docs/it-IT/advanced-config/README.md @@ -81,7 +81,7 @@ Le stringhe di stile sono un elenco di parole, separate da spazi bianchi. Le par - `` - `none` -dove `` è un colore specifico (discusso in seguito). `fg:` and `` currently do the same thing, though this may change in the future. `inverted` swaps the background and foreground colors. The order of words in the string does not matter. +dove `` è un colore specifico (discusso in seguito). `fg:` and `` currently do the same thing, though this may change in the future. `inverted` swaps the background and foreground colors. L'ordine delle parole nella stringa non conta. Il token `none` sovrascrive tutti gli altri token in una stringa se non fa parte di uno specificatore `bg:`, così ad esempio `fg:red none fg:blue` creerà una stringa senza stile. `bg:none` sets the background to the default color so `fg:red bg:none` is equivalent to `red` or `fg:red` and `bg:green fg:red bg:none` is also equivalent to `fg:red` or `red`. Potrà diventare un errore usare `nessuno` in combinazione con altri token in futuro. diff --git a/docs/it-IT/config/README.md b/docs/it-IT/config/README.md index 1004f925..b9503b90 100644 --- a/docs/it-IT/config/README.md +++ b/docs/it-IT/config/README.md @@ -3,7 +3,7 @@ To get started configuring starship, create the following file: `~/.config/starship.toml`. ```sh -mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml +mkdir -p ~/.config && touch ~/.config/starship.toml ``` All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: @@ -49,9 +49,9 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ### Terminology -**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project. +**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project. -**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of NodeJS. +**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js. By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix. @@ -384,7 +384,7 @@ The character will tell you whether the last command was successful or not. It c - changing color (`red`/`green`) - changing shape (`❯`/`✖`) -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). +By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). ::: warning `error_symbol` is not supported on elvish shell. ::: @@ -437,22 +437,23 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met: +The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met: - The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeCache.txt` file ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `cmake` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"△ "` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `cmake` module. | ### Variables @@ -555,22 +556,23 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met: +The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `shard.yml` file - The current directory contains a `.cr` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | --------------------------------------------------------- | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | -| `style` | `"bold red"` | The style for the module. | -| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | -| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `crystal` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `"bold red"` | The style for the module. | +| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | +| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `disabled` | `false` | Disables the `crystal` module. | ### Variables @@ -593,7 +595,7 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory @@ -601,15 +603,16 @@ The `dart` module shows the currently installed version of Dart. By default the ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | -| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `dart` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | +| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. | +| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `dart` module. | ### Variables @@ -632,20 +635,21 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of Deno. By default the module will be shown if any of the following conditions are met: +The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"green bold"` | The style for the module. | -| `disabled` | `false` | Disables the `deno` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"green bold"` | The style for the module. | +| `disabled` | `false` | Disables the `deno` module. | ### Variables @@ -764,7 +768,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -786,16 +790,17 @@ The module will also show the Target Framework Moniker ( ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager. @@ -1949,7 +1965,7 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file @@ -1959,15 +1975,16 @@ The `perl` module shows the currently installed version of Perl. By default the ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | -| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | -| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | -| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 149"` | The style for the module. | -| `disabled` | `false` | Disables the `perl` module. | +| Option | Default | Description | **** | +| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- | +| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | +| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | +| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | | +| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | | +| `detect_folders` | `[]` | Which folders should trigger this module. | | +| `style` | `"bold 149"` | The style for the module. | | +| `disabled` | `false` | Disables the `perl` module. | | ### Variables @@ -1988,7 +2005,7 @@ format = "via [🦪 $version]($style) " ## PHP -The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `composer.json` file - The current directory contains a `.php-version` file @@ -1996,15 +2013,16 @@ The `php` module shows the currently installed version of PHP. By default the mo ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | -| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | -| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"147 bold"` | The style for the module. | -| `disabled` | `false` | Disables the `php` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | +| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"147 bold"` | The style for the module. | +| `disabled` | `false` | Disables the `php` module. | ### Variables @@ -2027,22 +2045,23 @@ format = "via [🔹 $version](147 bold) " ## PureScript -The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: - The current directory contains a `spago.dhall` file - The current directory contains a file with the `.purs` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | -| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold white"` | The style for the module. | -| `disabled` | `false` | Disables the `purescript` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | +| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold white"` | The style for the module. | +| `disabled` | `false` | Disables the `purescript` module. | ### Variables @@ -2065,7 +2084,7 @@ format = "via [$symbol$version](bold white)" ## Python -The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. @@ -2092,7 +2111,7 @@ By default the module will be shown if any of the following conditions are met: | `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | -| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | +| `detect_extensions` | `["py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2143,7 +2162,7 @@ detect_extensions = [] ## Red -By default the `red` module shows the currently installed version of Red. The module will be shown if any of the following conditions are met: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a file with `.red` or `.reds` extension @@ -2181,7 +2200,7 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Gemfile` file - The current directory contains a `.ruby-version` file @@ -2221,7 +2240,7 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Cargo.toml` file - The current directory contains a file with the `.rs` extension @@ -2260,7 +2279,7 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension @@ -2268,15 +2287,16 @@ The `scala` module shows the currently installed version of Scala. By default th ### Options -| Option | Default | Description | -| ------------------- | ---------------------------------------- | ------------------------------------------------- | -| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | -| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | -| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | -| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | -| `style` | `"red dimmed"` | The style for the module. | -| `disabled` | `false` | Disables the `scala` module. | +| Option | Default | Description | +| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `style` | `"red dimmed"` | The style for the module. | +| `disabled` | `false` | Disables the `scala` module. | ### Variables @@ -2309,17 +2329,18 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ### Options -| Option | Default | Description | -| ---------------------- | ------------ | --------------------------------------------- | -| `bash_indicator` | `bsh` | A format string used to represent bash. | -| `fish_indicator` | `fsh` | A format string used to represent fish. | -| `zsh_indicator` | `zsh` | A format string used to represent zsh. | -| `powershell_indicator` | `psh` | A format string used to represent powershell. | -| `ion_indicator` | `ion` | A format string used to represent ion. | -| `elvish_indicator` | `esh` | A format string used to represent elvish. | -| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | -| `format` | `$indicator` | The format for the module. | -| `disabled` | `true` | Disables the `shell` module. | +| Option | Default | Description | +| ---------------------- | ------------ | ------------------------------------------------------------ | +| `bash_indicator` | `bsh` | A format string used to represent bash. | +| `fish_indicator` | `fsh` | A format string used to represent fish. | +| `zsh_indicator` | `zsh` | A format string used to represent zsh. | +| `powershell_indicator` | `psh` | A format string used to represent powershell. | +| `ion_indicator` | `ion` | A format string used to represent ion. | +| `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | +| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `format` | `$indicator` | The format for the module. | +| `disabled` | `true` | Disables the `shell` module. | ### Variables @@ -2335,6 +2356,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [shell] fish_indicator = "" powershell_indicator = "_" +unknown_indicator = "mystery shell" disabled = false ``` @@ -2376,7 +2398,7 @@ threshold = 3 ## Singolarità -The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Options @@ -2391,7 +2413,7 @@ The `singularity` module shows the current singularity image, if inside a contai | Variable | Example | Description | | --------- | ------------ | ------------------------------------ | -| env | `centos.img` | The current singularity image | +| env | `centos.img` | The current Singularity image | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2465,22 +2487,23 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | -| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 202"` | The style for the module. | -| `disabled` | `false` | Disables the `swift` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | +| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold 202"` | The style for the module. | +| `disabled` | `false` | Disables the `swift` module. | ### Variables @@ -2503,11 +2526,11 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: 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). +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-terraform-version). ::: @@ -2518,22 +2541,23 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | -| `symbol` | `"💠"` | A format string shown before the terraform workspace. | -| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | -| `style` | `"bold 105"` | The style for the module. | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | +| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | +| `style` | `"bold 105"` | The style for the module. | +| `disabled` | `false` | Disables the `terraform` module. | ### Variables | Variable | Example | Description | | --------- | ---------- | ------------------------------------ | | version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current terraform workspace | +| workspace | `default` | The current Terraform workspace | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2541,7 +2565,7 @@ By default the module will be shown if any of the following conditions are met: ### Example -#### With Version +#### With Terraform Version ```toml # ~/.config/starship.toml @@ -2550,7 +2574,7 @@ By default the module will be shown if any of the following conditions are met: format = "[🏎💨 $version$workspace]($style) " ``` -#### Without version +#### Without Terraform version ```toml # ~/.config/starship.toml @@ -2652,21 +2676,22 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default 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. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"cyan bold"` | The style for the module. | -| `disabled` | `false` | Disables the `vagrant` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2689,7 +2714,7 @@ format = "via [⍱ $version](bold white) " ## VCSH -The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### Options @@ -2721,21 +2746,22 @@ format = "[🆅 $repo](bold blue) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `.zig` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | -| `style` | `"bold yellow"` | The style for the module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `zig` module. | -| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `false` | Disables the `zig` module. | +| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables diff --git a/docs/ja-JP/README.md b/docs/ja-JP/README.md index 706c7b76..2ab10517 100644 --- a/docs/ja-JP/README.md +++ b/docs/ja-JP/README.md @@ -32,7 +32,7 @@ description: Starship はミニマルで、非常に高速で、カスタマイ - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal. -### Quick Install +### クイックインストール 1. **Starship** のバイナリをインストール diff --git a/docs/ja-JP/advanced-config/README.md b/docs/ja-JP/advanced-config/README.md index 685cde1d..b4980514 100644 --- a/docs/ja-JP/advanced-config/README.md +++ b/docs/ja-JP/advanced-config/README.md @@ -81,7 +81,7 @@ starship_precmd_user_func="set_win_title" - `` - `none` -ここで、 `` は色を指定します（以下で述べます）。 `fg:` and `` currently do the same thing, though this may change in the future. `inverted` swaps the background and foreground colors. The order of words in the string does not matter. +ここで、 `` は色を指定します（以下で述べます）。 `fg:` and `` currently do the same thing, though this may change in the future. `inverted` swaps the background and foreground colors. 文字列中の単語の順序は関係ありません。 `none` トークンは、文字列中の`bg:` 指定子の一部でない場合、他のすべてのトークンをオーバーライドします。そのため、たとえば、`fg:red none fg:blue` と指定した場合、スタイルなしの文字列が作られます。 `bg:none` sets the background to the default color so `fg:red bg:none` is equivalent to `red` or `fg:red` and `bg:green fg:red bg:none` is also equivalent to `fg:red` or `red`. 将来 `none` を他の単語と一緒に使用することはエラーになるかもしれません。 diff --git a/docs/ja-JP/config/README.md b/docs/ja-JP/config/README.md index e80ca51c..1bae32c2 100644 --- a/docs/ja-JP/config/README.md +++ b/docs/ja-JP/config/README.md @@ -3,7 +3,7 @@ Starshipの設定を開始するには、`~/.config/starship.toml` ファイルを作成します。 ```sh -mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml +mkdir -p ~/.config && touch ~/.config/starship.toml ``` Starshipのすべての設定は、この[TOML](https://github.com/toml-lang/toml)ファイルで行われます。 @@ -49,9 +49,9 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ### 用語 -**モジュール**: OSのコンテキスト情報に基づいて情報を提供するプロンプト内のコンポーネントです。 たとえば、現在のディレクトリがNodeJSプロジェクトである場合、「nodejs」モジュールは、現在コンピューターにインストールされているNodeJSのバージョンを表示します。 +**モジュール**: OSのコンテキスト情報に基づいて情報を提供するプロンプト内のコンポーネントです。 For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project. -**変数**: モジュールが提供する情報を含むサブコンポーネントを小さくする。 例えば、"nodejs" モジュール内の "version" 変数には、NodeJS の現在のバージョンが含まれています。 +**変数**: モジュールが提供する情報を含むサブコンポーネントを小さくする。 For example, the "version" variable in the "nodejs" module contains the current version of Node.js. 慣例により、ほとんどのモジュールにはデフォルトの端末色の接頭辞（「nodejs」の`via` など）と接尾辞として空のスペースがあります。 @@ -147,7 +147,7 @@ format = ''' | `format` | [link](#default-prompt-format) | プロンプトの形式を設定します。 | | `scan_timeout` | `30` | ファイルをスキャンする際のタイムアウト時間 (milliseconds) です。 | | `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). | -| `add_newline` | `true` | Inserts blank line between shell prompts. | +| `add_newline` | `true` | シェルプロンプトの間に空行を挿入します。 | ### 設定例 @@ -266,7 +266,7 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -311,7 +311,7 @@ symbol = "🅰 " ## バッテリー -The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. +`battery`モジュールは、デバイスのバッテリー残量と現在の充電状態を示します。 モジュールは、デバイスのバッテリー残量が10％未満の場合にのみ表示されます。 ### オプション @@ -339,7 +339,7 @@ discharging_symbol = "💀 " ### バッテリーの表示 -The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). If no `display` is provided. デフォルトは次のとおりです。 +The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). `display` が提供されない場合、 デフォルトは次のとおりです。 ```toml [[battery.display]] @@ -351,12 +351,12 @@ The default value for the `charging_symbol` and `discharging_symbol` option is r #### オプション -The `display` option is an array of the following table. +`display`オプションは、次の表の通りです。 | オプション | デフォルト | 説明 | | -------------------- | ---------- | --------------------------------------------------------------------------------------------------------- | -| `threshold` | `10` | The upper bound for the display option. | -| `style` | `bold red` | The style used if the display option is in use. | +| `threshold` | `10` | バッテリーが表示される上限です。 | +| `style` | `bold red` | displayオプションが使用されている場合のスタイルです。 | | `charging_symbol` | `-` | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. | | `discharging_symbol` | `-` | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. | @@ -378,16 +378,16 @@ discharging_symbol = 💦 ## 文字 -The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. +`character`モジュールは、端末でテキストが入力される場所の横に文字（通常は矢印）を表示します。 -The character will tell you whether the last command was successful or not. It can do this in two ways: +文字は、最後のコマンドが成功したかどうかを示します。 表し方は下記の2つです。 - 色の変更 (`赤`/`緑`) - プロンプトの表示の変更 (`❯`/`✖`) -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). +デフォルトでは、色だけが変更されます。 If you also want to change its shape take a look at [this example](#with-custom-error-shape). -::: warning `error_symbol` is not supported on elvish shell. ::: +::: warning `error_symbol` はelvishシェルではサポートされていません。 ::: ### オプション @@ -438,22 +438,23 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met: +The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). デフォルトでは次のいずれかの条件が満たされると、モジュールがアクティブになります。 - カレントディレクトリに `CMakeLists.txt` ファイルが含まれている - カレントディレクトリに `CMakeCache.txt` ファイルが含まれている ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | -------------------------------------- | ------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | -| `symbol` | `"△ "` | cmakeのバージョンの前に使用される記号 | -| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `style` | `"bold blue"` | モジュールのスタイルです。 | -| `disabled` | `false` | `cmake`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"△ "` | cmakeのバージョンの前に使用される記号 | +| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `"bold blue"` | モジュールのスタイルです。 | +| `disabled` | `false` | `cmake`モジュールを無効にします。 | ### 変数 @@ -463,19 +464,19 @@ The `cmake` module shows the currently installed version of CMake. By default th | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ## コマンド実行時間 -The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. +`cmd_duration`モジュールは、最後のコマンドの実行にかかった時間を示します。 モジュールが表示されるのは、コマンドが2秒以上かかった場合、または`min_time`値が存在する場合のみです。 -::: warning Do not hook the DEBUG trap in Bash +::: warning BashでDEBUGトラップをhookしない -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. +`bash`でStarshipを実行している場合、 `eval $(starship init $0)`実行した後に`DEBUG`トラップをフックしないでください。そうしないと、このモジュールが**おそらくですが**壊れます。 ::: -Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. +preexecのような機能を必要とするBashユーザーは、 [rcalorasのbash_preexecフレームワーク](https://github.com/rcaloras/bash-preexec)を使用できます。 `eval $(starship init $0)` を実行する前に、`preexec_functions`、および`precmd_functions`定義するだけで、通常どおり続行します。 ### オプション @@ -491,7 +492,7 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec ::: tip -Showing desktop notifications requires starship to be built with `rust-notify` support. You check if your starship supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `true`. +デスクトップ通知を表示するには、 `rust-notify` をサポートしているstarshipをビルドする必要があります。 `show_notifications` が `true` となっている状態で `STARSHIP_LOG=debug starship module cmd_duration -d 60000` を実行することにより、starshipが通知をサポートしているかを確認することができます。 ::: @@ -502,7 +503,7 @@ Showing desktop notifications requires starship to be built with `rust-notify` s | duration | `16m40s` | コマンドの実行時間 | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -516,11 +517,11 @@ format = "underwent [$duration](bold yellow)" ## Conda -The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. +`$CONDA_DEFAULT_ENV`が設定されている場合、`conda`モジュールは現在のcondaの環境を表示します。 ::: tip -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. +Note: これはconda自身の プロンプト修飾子 を抑制しません。`conda config --set changeps1 False` で実行することができます。 ::: @@ -543,7 +544,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -556,22 +557,23 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -The `crystal` module shows the currently installed version of Crystal. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`shard.yml`ファイルが含まれている - カレントディレクトリに`.cr`の拡張子のファイルが含まれている ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------ | ------------------------------ | -| `symbol` | `"🔮 "` | Crystalのバージョンを表示する前に使用される記号です。 | -| `style` | `"bold red"` | モジュールのスタイルです。 | -| `detect_extensions` | `["cr"]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `["shard.yml"]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | -| `disabled` | `false` | `crystal`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `symbol` | `"🔮 "` | Crystalのバージョンを表示する前に使用される記号です。 | +| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `"bold red"` | モジュールのスタイルです。 | +| `detect_extensions` | `["cr"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `["shard.yml"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `disabled` | `false` | `crystal`モジュールを無効にします。 | ### 変数 @@ -581,7 +583,7 @@ The `crystal` module shows the currently installed version of Crystal. デフォ | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -594,7 +596,7 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of Dart. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory @@ -602,15 +604,16 @@ The `dart` module shows the currently installed version of Dart. デフォルト ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------------------- | ------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | -| `symbol` | `"🎯 "` | Dartのシンボルを表すフォーマット文字列 | -| `detect_extensions` | `['dart']` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[".dart_tool"]` | どのフォルダーがこのモジュールをアクティブにするか | -| `style` | `"bold blue"` | モジュールのスタイルです。 | -| `disabled` | `false` | `dart`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🎯 "` | Dartのシンボルを表すフォーマット文字列 | +| `detect_extensions` | `["dart"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[".dart_tool"]` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `"bold blue"` | モジュールのスタイルです。 | +| `disabled` | `false` | `dart`モジュールを無効にします。 | ### 変数 @@ -620,7 +623,7 @@ The `dart` module shows the currently installed version of Dart. デフォルト | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -633,20 +636,21 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of Deno. By default the module will be shown if any of the following conditions are met: +The `deno` module shows you your currently installed version of [Deno](https://deno.land/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | -------------------------------------------- | --------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | -| `symbol` | `"🦕 "` | Dart のシンボルを表すフォーマット文字列 | -| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `style` | `"green bold"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `deno` module. | +| オプション | デフォルト | 説明 | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🦕 "` | Dart のシンボルを表すフォーマット文字列 | +| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `"green bold"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `deno` module. | ### 変数 @@ -667,33 +671,33 @@ format = "via [🦕 $version](green bold) " ## Directory -The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. +`directory`モジュールには、現在のディレクトリへのパスが表示され、3つの親フォルダは切り捨てられます。 ディレクトリは、現在のgitリポジトリであるとルートとなります。 -When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. +fishスタイルのpwdオプションを使用すると、切り捨てられたパスを非表示にする代わりに、オプションで有効にした番号に基づいて各ディレクトリの短縮名が表示されます。 -For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. +例として、`~/Dev/Nix/nixpkgs/pkgs`で、`nixpkgs`がリポジトリルートであり、オプションが`1`に設定されている場合を挙げます。 以前は`nixpkgs/pkgs`でしたが、`~/D/N/nixpkgs/pkgs`が表示されます。 ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- | -| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | -| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | -| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | moduleのフォーマットです。 | -| `style` | `"bold cyan"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `directory` module. | -| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | -| `read_only_style` | `"red"` | The style for the read only symbol. | -| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | -| `home_symbol` | `"~"` | The symbol indicating home directory. | +| オプション | デフォルト | 説明 | +| ------------------- | -------------------------------------------------- | ----------------------------------------------------- | +| `truncation_length` | `3` | 現在のディレクトリを切り捨てる親フォルダーの数です。 | +| `truncate_to_repo` | `true` | 現在いるgitリポジトリのルートに切り捨てるかどうかです。 | +| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | moduleのフォーマットです。 | +| `style` | `"bold cyan"` | モジュールのスタイルです。 | +| `disabled` | `false` | `directory`モジュールを無効にします。 | +| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | +| `read_only_style` | `"red"` | The style for the read only symbol. | +| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | +| `home_symbol` | `"~"` | The symbol indicating home directory. |
-This module has a few advanced configuration options that control how the directory is displayed. +このモジュールは、どのようにディレクトリを表示するかについての高度なオプションをいくつか持っています。 | Advanced Option | デフォルト | 説明 | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `substitutions` | | A table of substitutions to be made to the path. | -| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | +| `fish_style_pwd_dir_length` | `0` | fish shellのpwdパスロジックを適用するときに使用する文字数です。 | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. | `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. @@ -715,7 +719,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | path | `"D:/Projects"` | カレントディレクトリのパス | | style\* | `"black bold dimmed"` | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -729,7 +733,7 @@ truncation_symbol = "…/" ## Docker Context -The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default`. +`docker_context`モジュールは、 [Dockerコンテキスト](https://docs.docker.com/engine/context/working-with-contexts/)が`デフォルト`に設定されていない場合、現在アクティブな <1>Dockerコンテキストを表示します。 ### オプション @@ -742,7 +746,7 @@ The `docker_context` module shows the currently active [Docker context](https:// | `detect_files` | `The format for the module.` | Which filenames should trigger this module (needs `only_with_files` to be true). | | `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). | | `style` | `"blue bold"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `docker_context` module. | +| `disabled` | `false` | `docker_context`モジュールを無効にします。 | ### 変数 @@ -752,7 +756,7 @@ The `docker_context` module shows the currently active [Docker context](https:// | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -765,7 +769,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. もし SDKは現在のディレクトリに固定されているのであれば、その固定されたバージョンが表示されます。 それ以外の場合、モジュール SDKの最新のインストールバージョンを示します。 By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -781,22 +785,23 @@ By default this module will only be shown in your prompt when one or more of the You'll also need the .NET Core SDK installed in order to use it correctly. -Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. +内部的に、このモジュールは自身のバージョン検知のメカニズムを利用します。 `dotnet --version` を実行するより2倍速く実行できますが、.NET project一般的でないディレクトリlayoutの場合は間違ったバージョンが示されてしまうことがあります。 速度よりも精度が重要な場合は、次の方法でメカニズムを無効にできます。 モジュールオプションで`heuristic = false `を設定します。 The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | moduleのフォーマットです。 | -| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. | -| `heuristic` | `true` | Use faster version detection to keep starship snappy. | -| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `style` | `"bold blue"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `dotnet` module. | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | moduleのフォーマットです。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `".NET "` | dotnetのバージョンを表示する前に使用される記号です。 | +| `heuristic` | `true` | より高速なバージョン検出を使用して、starshipの動作を維持します。 | +| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `"bold blue"` | モジュールのスタイルです。 | +| `disabled` | `false` | `dotnet`モジュールを無効にします。 | ### 変数 @@ -807,7 +812,7 @@ The module will also show the Target Framework Moniker (モジュールは、現在のシステムメモリとスワップ使用量を示します。

-By default the swap usage is displayed if the total system swap is non-zero. +

デフォルトでは、システムスワップの合計がゼロ以外の場合、スワップ使用量が表示されます。

-::: tip +

::: tip

-This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +

このモジュールはデフォルトで無効になっています。 +有効にするには、設定ファイルでdisabled`を`false`に設定します。 ::: ### オプション -| オプション | デフォルト | 説明 | -| ----------- | ----------------------------------------------- | -------------------------------------------------------- | -| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | -| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | moduleのフォーマットです。 | -| `symbol` | `"🐏"` | The symbol used before displaying the memory usage. | -| `style` | `"bold dimmed white"` | モジュールのスタイルです。 | -| `disabled` | `true` | Disables the `memory_usage` module. | +| オプション | デフォルト | 説明 | +| ----------- | ----------------------------------------------- | --------------------------- | +| `threshold` | `75` | この閾値を超えない限り、メモリ使用率は表示されません。 | +| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | moduleのフォーマットです。 | +| `symbol` | `"🐏"` | メモリ使用率を表示する前に使用される記号です。 | +| `style` | `"bold dimmed white"` | モジュールのスタイルです。 | +| `disabled` | `true` | `memory_usage`モジュールを無効にします。 | ### 変数 @@ -1662,9 +1677,9 @@ symbol = " " style = "bold dimmed green" ``` -## Mercurial Branch +## Mercurial ブランチ -The `hg_branch` module shows the active branch of the repo in your current directory. +` hg_branch `モジュールは、現在のディレクトリにあるリポジトリのアクティブなブランチを示します。 ### オプション @@ -1674,7 +1689,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc | `style` | `"bold purple"` | モジュールのスタイルです。 | | `format` | `"on [$symbol$branch]($style) "` | moduleのフォーマットです。 | | `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | -| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. | +| `truncation_symbol` | `"…"` | ブランチ名切り捨てられていることを示すための記号です。 | | `disabled` | `true` | Disables the `hg_branch` module. | ### 変数 @@ -1685,7 +1700,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -1700,24 +1715,25 @@ truncation_symbol = "" ## Nim -The `nim` module shows the currently installed version of Nim. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- 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 ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module | -| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | -| `detect_extensions` | `["nim", "nims", "nimble"]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `["nim.cfg"]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `style` | `"bold yellow"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `nim` module. | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | +| `detect_extensions` | `["nim", "nims", "nimble"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `["nim.cfg"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `"bold yellow"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `nim` module. | ### 変数 @@ -1727,7 +1743,7 @@ The `nim` module shows the currently installed version of Nim. デフォルト | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -1741,7 +1757,7 @@ symbol = "🎣 " ## Nix-shell -The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment. +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. このモジュールは、nixシェル環境内にあるときに表示されます。 ### オプション @@ -1752,7 +1768,7 @@ The `nix_shell` module shows the nix-shell environment. The module will be shown | `style` | `"bold blue"` | モジュールのスタイルです。 | | `impure_msg` | `"impure"` | A format string shown when the shell is impure. | | `pure_msg` | `"pure"` | A format string shown when the shell is pure. | -| `disabled` | `false` | Disables the `nix_shell` module. | +| `disabled` | `false` | `nix_shell`モジュールを無効にします。 | ### 変数 @@ -1763,7 +1779,7 @@ The `nix_shell` module shows the nix-shell environment. The module will be shown | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -1777,30 +1793,30 @@ pure_msg = "[pure shell](bold green)" format = 'via [☃️ $state( \($name\))](bold blue) ' ``` -## NodeJS +## Node.js -The `nodejs` module shows the currently installed version of NodeJS. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `package.json` file +- カレントディレクトリに`package.json`ファイルが含まれている - The current directory contains a `.node-version` file - The current directory contains a `.nvmrc` file -- The current directory contains a `node_modules` directory +- カレントディレクトリに`node_modules`ディレクトリが含まれている - The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension - The current directory contains a file with the `.ts` extension ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | -| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | A format string representing the symbol of NodeJS. | -| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `["package.json", ".node-version"]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `["node_modules"]` | どのフォルダーがこのモジュールをアクティブにするか | -| `style` | `"bold green"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `nodejs` module. | -| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the NodeJS version. | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | A format string representing the symbol of Node.js. | +| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `["package.json", ".node-version"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `["node_modules"]` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `"bold green"` | モジュールのスタイルです。 | +| `disabled` | `false` | `nodejs`モジュールを無効にします。 | +| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | ### 変数 @@ -1810,7 +1826,7 @@ The `nodejs` module shows the currently installed version of NodeJS. デフォ | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -1823,7 +1839,7 @@ format = "via [🤖 $version](bold green) " ## OCaml -The `ocaml` module shows the currently installed version of OCaml. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a `esy.lock` directory @@ -1834,17 +1850,18 @@ The `ocaml` module shows the currently installed version of OCaml. デフォル ### オプション -| オプション | デフォルト | 説明 | -| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------- | -| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. | -| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | -| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. | -| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. | -| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `["_opam", "esy.lock"]` | どのフォルダーがこのモジュールをアクティブにするか | -| `style` | `"bold yellow"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `ocaml` module. | +| オプション | デフォルト | 説明 | +| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | +| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. | +| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. | +| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `["_opam", "esy.lock"]` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `"bold yellow"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `ocaml` module. | ### 変数 @@ -1856,7 +1873,7 @@ The `ocaml` module shows the currently installed version of OCaml. デフォル | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -1889,7 +1906,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -1902,32 +1919,32 @@ style = "bold yellow" symbol = "☁️ " ``` -## Package Version +## パッケージのバージョン -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages. +`package`モジュールは、現在のディレクトリがパッケージのリポジトリである場合に表示され、現在のバージョンが表示されます。 The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages. -- **npm** – The `npm` package version is extracted from the `package.json` present in the current directory -- **cargo** – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory -- **poetry** – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory -- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory -- **gradle** – The `gradle` package version is extracted from the `build.gradle` present -- **julia** - The package version is extracted from the `Project.toml` present -- **mix** - The `mix` package version is extracted from the `mix.exs` present -- **helm** - The `helm` chart version is extracted from the `Chart.yaml` present -- **maven** - The `maven` package version is extracted from the `pom.xml` present -- **meson** - The `meson` package version is extracted from the `meson.build` present +- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory +- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory +- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory +- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory +- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present +- [**julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present +- [**mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present +- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present +- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present +- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present > ⚠️ 表示されるバージョンは、パッケージマネージャーではなく、ソースコードが現在のディレクトリにあるパッケージのバージョンです。 ### オプション -| オプション | デフォルト | 説明 | -| ----------------- | --------------------------------- | ---------------------------------------------------------- | -| `format` | `"is [$symbol$version]($style) "` | moduleのフォーマットです。 | -| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | -| `style` | `"bold 208"` | モジュールのスタイルです。 | -| `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | Disables the `package` module. | +| オプション | デフォルト | 説明 | +| ----------------- | --------------------------------- | --------------------------------------------------------- | +| `format` | `"is [$symbol$version]($style) "` | moduleのフォーマットです。 | +| `symbol` | `"📦 "` | パッケージのバージョンを表示する前に使用される記号です。 | +| `style` | `"bold 208"` | モジュールのスタイルです。 | +| `display_private` | `false` | Enable displaying version for packages marked as private. | +| `disabled` | `false` | `package` モジュールを無効にします。 | ### 変数 @@ -1937,7 +1954,7 @@ The `package` module is shown when the current directory is the repository for a | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -1950,7 +1967,7 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of Perl. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file @@ -1960,15 +1977,16 @@ The `perl` module shows the currently installed version of Perl. デフォルト ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | -| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | -| `detect_extensions` | `["pl", "pm", "pod"]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `style` | `"bold 149"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `perl` module. | +| オプション | デフォルト | 説明 | **** | +| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- | +| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | +| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | +| `detect_extensions` | `["pl", "pm", "pod"]` | どの拡張子がこのモジュールをアクティブにするか | | +| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | どのファイル名がこのモジュールをアクティブにするか | | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | +| `style` | `"bold 149"` | モジュールのスタイルです。 | | +| `disabled` | `false` | Disables the `perl` module. | | ### 変数 @@ -1989,23 +2007,24 @@ format = "via [🦪 $version]($style) " ## PHP -The `php` module shows the currently installed version of PHP. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `php` module shows the currently installed version of [PHP](https://www.php.net/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `composer.json` file +- カレントディレクトリに`composer.json`ファイルが含まれている - The current directory contains a `.php-version` file - The current directory contains a `.php` extension ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | -| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | -| `detect_extensions` | `["php"]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `["composer.json", ".php-version"]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `style` | `"147 bold"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `php` module. | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐘 "` | PHPのバージョンを表示する前に使用される記号です。 | +| `detect_extensions` | `["php"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `["composer.json", ".php-version"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `"147 bold"` | モジュールのスタイルです。 | +| `disabled` | `false` | `php`モジュールを無効にします。 | ### 変数 @@ -2015,7 +2034,7 @@ The `php` module shows the currently installed version of PHP. デフォルト | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -2028,22 +2047,23 @@ format = "via [🔹 $version](147 bold) " ## PureScript -The `purescript` module shows the currently installed version of PureScript version. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `spago.dhall` file +- カレントディレクトリに`spago.dhall`ファイルが含まれている - The current directory contains a file with the `.purs` extension ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------ | ------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | -| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `["spago.dhall"]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `style` | `"bold white"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `purescript` module. | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | +| `detect_extensions` | `["purs"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `["spago.dhall"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `"bold white"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `purescript` module. | ### 変数 @@ -2053,7 +2073,7 @@ The `purescript` module shows the currently installed version of PureScript vers | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -2066,21 +2086,21 @@ format = "via [$symbol$version](bold white)" ## Python -The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. -If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. +`pyenvversionname` が `true` に設定されている場合 、pyenv でのバージョン名が表示されます 。 そうでなければ、`python --version` を元にバージョン番号を表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `.python-version` file -- The current directory contains a `Pipfile` file +- カレントディレクトリに`.python-version`ファイルが含まれている +- カレントディレクトリに`Pipfile`ファイルが含まれている - The current directory contains a `__init__.py` file -- The current directory contains a `pyproject.toml` file -- The current directory contains a `requirements.txt` file -- The current directory contains a `setup.py` file -- The current directory contains a `tox.ini` file -- The current directory contains a file with the `.py` extension. -- A virtual environment is currently activated +- カレントディレクトリに`pyproject.toml`ファイルが含まれている +- カレントディレクトリに`requirements.txt`ファイルが含まれている +- カレントディレクトリに`setup.py`ファイルが含まれている +- カレントディレクトリに`tox.ini`ファイルが含まれている +- カレントディレクトリに`.py`の拡張子のファイルが含まれている. +- 仮想環境がアクティブである ### オプション @@ -2090,13 +2110,13 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name | `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | モジュールのスタイルです。 | -| `pyenv_version_name` | `false` | Use pyenv to get Python version | +| `pyenv_version_name` | `false` | pyenvを使用してPythonバージョンを取得します | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | -| `detect_extensions` | `[".py"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_extensions` | `["py"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `disabled` | `false` | Disables the `python` module. | +| `disabled` | `false` | `python`モジュールを無効にします。 | ::: tip @@ -2144,7 +2164,7 @@ detect_extensions = [] ## Red -By default the `red` module shows the currently installed version of Red. The module will be shown if any of the following conditions are met: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). 次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a file with `.red` or `.reds` extension @@ -2169,7 +2189,7 @@ By default the `red` module shows the currently installed version of Red. The mo | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -2182,11 +2202,11 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). 次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `Gemfile` file +- カレントディレクトリに`Gemfile`ファイルが含まれている - The current directory contains a `.ruby-version` file -- The current directory contains a `.rb` file +- カレントディレクトリに`.rb`の拡張子のファイルが含まれている ### オプション @@ -2199,7 +2219,7 @@ By default the `ruby` module shows the currently installed version of Ruby. The | `detect_files` | `["Gemfile", ".ruby-version"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `"bold red"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `ruby` module. | +| `disabled` | `false` | `ruby`モジュールを無効にします。 | ### 変数 @@ -2209,7 +2229,7 @@ By default the `ruby` module shows the currently installed version of Ruby. The | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -2222,10 +2242,10 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). 次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `Cargo.toml` file -- The current directory contains a file with the `.rs` extension +- カレントディレクトリに`Cargo.toml`ファイルが含まれている +- カレントディレクトリに`.rs`の拡張子のファイルが含まれている ### オプション @@ -2238,7 +2258,7 @@ By default the `rust` module shows the currently installed version of Rust. The | `detect_files` | `["Cargo.toml"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `"bold red"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `rust` module. | +| `disabled` | `false` | `rust`モジュールを無効にします。 | ### 変数 @@ -2248,7 +2268,7 @@ By default the `rust` module shows the currently installed version of Rust. The | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -2261,7 +2281,7 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of Scala. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension @@ -2269,15 +2289,16 @@ The `scala` module shows the currently installed version of Scala. デフォル ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ---------------------------------------- | ------------------------------------------------- | -| `format` | `"via [${symbol}(${version} )]($style)"` | moduleのフォーマットです。 | -| `detect_extensions` | `["sbt", "scala"]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | -| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | -| `style` | `"red dimmed"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `scala` module. | +| オプション | デフォルト | 説明 | +| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | moduleのフォーマットです。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["sbt", "scala"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[".metals"]` | どのフォルダーがこのモジュールをアクティブにするか | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `style` | `"red dimmed"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `scala` module. | ### 変数 @@ -2287,7 +2308,7 @@ The `scala` module shows the currently installed version of Scala. デフォル | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -2304,23 +2325,24 @@ The `shell` module shows an indicator for currently used shell. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 ::: ### オプション -| オプション | デフォルト | 説明 | -| ---------------------- | ------------ | --------------------------------------------- | -| `bash_indicator` | `bsh` | A format string used to represent bash. | -| `fish_indicator` | `fsh` | A format string used to represent fish. | -| `zsh_indicator` | `zsh` | A format string used to represent zsh. | -| `powershell_indicator` | `psh` | A format string used to represent powershell. | -| `ion_indicator` | `ion` | A format string used to represent ion. | -| `elvish_indicator` | `esh` | A format string used to represent elvish. | -| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | -| `format` | `$indicator` | moduleのフォーマットです。 | -| `disabled` | `true` | Disables the `shell` module. | +| オプション | デフォルト | 説明 | +| ---------------------- | ------------ | ------------------------------------------------------------ | +| `bash_indicator` | `bsh` | A format string used to represent bash. | +| `fish_indicator` | `fsh` | A format string used to represent fish. | +| `zsh_indicator` | `zsh` | A format string used to represent zsh. | +| `powershell_indicator` | `psh` | A format string used to represent powershell. | +| `ion_indicator` | `ion` | A format string used to represent ion. | +| `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | +| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `format` | `$indicator` | moduleのフォーマットです。 | +| `disabled` | `true` | Disables the `shell` module. | ### 変数 @@ -2336,6 +2358,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [shell] fish_indicator = "" powershell_indicator = "_" +unknown_indicator = "mystery shell" disabled = false ``` @@ -2362,7 +2385,7 @@ The `shlvl` module shows the current `SHLVL` ("shell level") environment variabl | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -2377,7 +2400,7 @@ threshold = 3 ## Singularity -The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### オプション @@ -2392,11 +2415,11 @@ The `singularity` module shows the current singularity image, if inside a contai | 変数 | 設定例 | 説明 | | --------- | ------------ | ----------------------------- | -| env | `centos.img` | The current singularity image | +| env | `centos.img` | The current Singularity image | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -2413,7 +2436,7 @@ The `status` module displays the exit code of the previous command. The module w ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 ::: @@ -2447,7 +2470,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -2466,22 +2489,23 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). 次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------ | ------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | -| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `["Package.swift"]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `style` | `"bold 202"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `swift` module. | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `detect_extensions` | `["swift"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `["Package.swift"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `"bold 202"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `swift` module. | ### 変数 @@ -2491,7 +2515,7 @@ By default the `swift` module shows the currently installed version of Swift. Th | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -2504,45 +2528,46 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: 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). +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-terraform-version). ::: デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `.terraform` folder +- カレントディレクトリに`.terraform`フォルダが含まれている - Current directory contains a file with the `.tf` or `.hcl` extensions ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | -| `symbol` | `"💠"` | A format string shown before the terraform workspace. | -| `detect_extensions` | `["tf", "hcl"]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[".terraform"]` | どのフォルダーがこのモジュールをアクティブにするか | -| `style` | `"bold 105"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `terraform` module. | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | +| `detect_extensions` | `["tf", "hcl"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[".terraform"]` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `"bold 105"` | モジュールのスタイルです。 | +| `disabled` | `false` | `terraform`モジュールを無効にします。 | ### 変数 | 変数 | 設定例 | 説明 | | --------- | ---------- | ------------------------------- | | version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current terraform workspace | +| workspace | `default` | The current Terraform workspace | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 -#### With Version +#### With Terraform Version ```toml # ~/.config/starship.toml @@ -2551,7 +2576,7 @@ By default the terraform version is not shown, since this is slow for current ve format = "[🏎💨 $version$workspace]($style) " ``` -#### Without version +#### Without Terraform version ```toml # ~/.config/starship.toml @@ -2562,36 +2587,36 @@ 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 -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 ::: ### オプション -| オプション | デフォルト | 説明 | -| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `format` | `"at [$time]($style) "` | The format string for the module. | -| `use_12hr` | `false` | Enables 12 hour formatting | -| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | -| `style` | `"bold yellow"` | The style for the module time | -| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | -| `disabled` | `true` | Disables the `time` module. | -| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| オプション | デフォルト | 説明 | +| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | +| `format` | `"at [$time]($style) "` | The format string for the module. | +| `use_12hr` | `false` | 12時間のフォーマットを有効にします。 | +| `time_format` | この表の下を参照してください | 時刻のフォーマットに使用される[クロノフォーマット文字列](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) です。 | +| `style` | `"bold yellow"` | モジュールのスタイルです。 | +| `utc_time_offset` | `"local"` | 使用するUTCオフセットを設定します。 Range from -24 < x < 24. フロートが30/45分のタイムゾーンオフセットに対応できるようにします。 | +| `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. ### 変数 | 変数 | 設定例 | 説明 | | --------- | ---------- | ---------------------- | -| time | `13:08:10` | The current time. | +| 時刻 | `13:08:10` | The current time. | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -2606,14 +2631,14 @@ utc_time_offset = "-5" time_range = "10:00:00-14:00:00" ``` -## Username +## ユーザー名 -The `username` module shows active user's username. The module will be shown if any of the following conditions are met: +`username`モジュールには、アクティブなユーザーのユーザー名が表示されます。 次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current user is root -- The current user isn't the same as the one that is logged in -- The user is currently connected as an SSH session -- The variable `show_always` is set to true +- カレントユーザーがroot +- カレントユーザーが、ログインしているユーザーとは異なる +- ユーザーがSSHセッションとして接続されている +- `show_always`変数がtrueに設定されている ::: tip @@ -2623,13 +2648,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### オプション -| オプション | デフォルト | 説明 | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `style_user` | `"bold yellow"` | The style used for non-root users. | -| `format` | `"[$user]($style) in "` | moduleのフォーマットです。 | -| `show_always` | `false` | Always shows the `username` module. | -| `disabled` | `false` | Disables the `username` module. | +| オプション | デフォルト | 説明 | +| ------------- | ----------------------- | ------------------------- | +| `style_root` | `"bold red"` | ユーザーがrootのときに使用されるスタイルです。 | +| `style_user` | `"bold yellow"` | 非rootユーザーに使用されるスタイルです。 | +| `format` | `"[$user]($style) in "` | moduleのフォーマットです。 | +| `show_always` | `false` | `username` モジュールを常に表示します。 | +| `disabled` | `false` | `username` モジュールを無効にします。 | ### 変数 @@ -2653,21 +2678,22 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of Vagrant. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `Vagrantfile` file ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------ | --------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | -| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | -| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `["Vagrantfile"]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `style` | `"cyan bold"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `vagrant` module. | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `["Vagrantfile"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `"cyan bold"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `vagrant` module. | ### 変数 @@ -2677,7 +2703,7 @@ The `vagrant` module shows the currently installed version of Vagrant. デフォ | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -2690,7 +2716,7 @@ format = "via [⍱ $version](bold white) " ## VCSH -The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### オプション @@ -2709,7 +2735,7 @@ The `vcsh` module displays the current active VCSH repository. The module will b | symbol | | オプション `記号` の値をミラーする | | style\* | `black bold dimmed` | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -2722,21 +2748,22 @@ format = "[🆅 $repo](bold blue) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). 次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `.zig` file ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | -| `style` | `"bold yellow"` | モジュールのスタイルです。 | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | -| `disabled` | `false` | Disables the `zig` module. | -| `detect_extensions` | `["zig"]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | +| `style` | `"bold yellow"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `zig` module. | +| `detect_extensions` | `["zig"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | ### 変数 @@ -2746,7 +2773,7 @@ By default the the `zig` module shows the currently installed version of Zig. Th | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます ### 設定例 @@ -2792,8 +2819,8 @@ The order in which custom modules are shown can be individually set by including | ------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | -| `shell` | | [See below](#custom-command-shell) | -| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `shell` | | [この表の下を参照してください](#custom-command-shell) | +| `説明` | `""` | The description of the module that is shown when running `starship explain`. | | `files` | `[]` | The files that will be searched in the working directory for a match. | | `directories` | `[]` | The directories that will be searched in the working directory for a match. | | `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | @@ -2810,7 +2837,7 @@ The order in which custom modules are shown can be individually set by including | symbol | オプション `記号` の値をミラーする | | style\* | オプション `style` の値をミラーする | -\*: This variable can only be used as a part of a style string +\*: この変数はスタイル文字列の一部としてのみ使用できます #### Custom command shell diff --git a/docs/ko-KR/README.md b/docs/ko-KR/README.md index ab08c561..5a8359a3 100644 --- a/docs/ko-KR/README.md +++ b/docs/ko-KR/README.md @@ -32,7 +32,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal. -### Quick Install +### 빠른 설치 1. **starship** 바이러니 설치: diff --git a/docs/ko-KR/config/README.md b/docs/ko-KR/config/README.md index cb488c9f..2c432f89 100644 --- a/docs/ko-KR/config/README.md +++ b/docs/ko-KR/config/README.md @@ -3,7 +3,7 @@ To get started configuring starship, create the following file: `~/.config/starship.toml`. ```sh -mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml +mkdir -p ~/.config && touch ~/.config/starship.toml ``` All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: @@ -49,9 +49,9 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ### Terminology -**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project. +**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project. -**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of NodeJS. +**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js. By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix. @@ -384,7 +384,7 @@ The character will tell you whether the last command was successful or not. It c - changing color (`red`/`green`) - changing shape (`❯`/`✖`) -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). +By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). ::: warning `error_symbol` is not supported on elvish shell. ::: @@ -437,22 +437,23 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met: +The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met: - The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeCache.txt` file ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `cmake` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"△ "` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `cmake` module. | ### Variables @@ -555,22 +556,23 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met: +The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `shard.yml` file - The current directory contains a `.cr` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | --------------------------------------------------------- | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | -| `style` | `"bold red"` | The style for the module. | -| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | -| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `crystal` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `"bold red"` | The style for the module. | +| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | +| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `disabled` | `false` | Disables the `crystal` module. | ### Variables @@ -593,7 +595,7 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory @@ -601,15 +603,16 @@ The `dart` module shows the currently installed version of Dart. By default the ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | -| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `dart` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | +| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. | +| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `dart` module. | ### Variables @@ -632,20 +635,21 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of Deno. By default the module will be shown if any of the following conditions are met: +The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"green bold"` | The style for the module. | -| `disabled` | `false` | Disables the `deno` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"green bold"` | The style for the module. | +| `disabled` | `false` | Disables the `deno` module. | ### Variables @@ -764,7 +768,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -786,16 +790,17 @@ The module will also show the Target Framework Moniker ( ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager. @@ -1949,7 +1965,7 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file @@ -1959,15 +1975,16 @@ The `perl` module shows the currently installed version of Perl. By default the ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | -| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | -| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | -| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 149"` | The style for the module. | -| `disabled` | `false` | Disables the `perl` module. | +| Option | Default | Description | **** | +| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- | +| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | +| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | +| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | | +| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | | +| `detect_folders` | `[]` | Which folders should trigger this module. | | +| `style` | `"bold 149"` | The style for the module. | | +| `disabled` | `false` | Disables the `perl` module. | | ### Variables @@ -1988,7 +2005,7 @@ format = "via [🦪 $version]($style) " ## PHP -The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `composer.json` file - The current directory contains a `.php-version` file @@ -1996,15 +2013,16 @@ The `php` module shows the currently installed version of PHP. By default the mo ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | -| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | -| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"147 bold"` | The style for the module. | -| `disabled` | `false` | Disables the `php` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | +| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"147 bold"` | The style for the module. | +| `disabled` | `false` | Disables the `php` module. | ### Variables @@ -2027,22 +2045,23 @@ format = "via [🔹 $version](147 bold) " ## PureScript -The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: - The current directory contains a `spago.dhall` file - The current directory contains a file with the `.purs` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | -| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold white"` | The style for the module. | -| `disabled` | `false` | Disables the `purescript` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | +| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold white"` | The style for the module. | +| `disabled` | `false` | Disables the `purescript` module. | ### Variables @@ -2065,7 +2084,7 @@ format = "via [$symbol$version](bold white)" ## Python -The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. @@ -2092,7 +2111,7 @@ By default the module will be shown if any of the following conditions are met: | `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | -| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | +| `detect_extensions` | `["py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2143,7 +2162,7 @@ detect_extensions = [] ## Red -By default the `red` module shows the currently installed version of Red. The module will be shown if any of the following conditions are met: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a file with `.red` or `.reds` extension @@ -2181,7 +2200,7 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Gemfile` file - The current directory contains a `.ruby-version` file @@ -2221,7 +2240,7 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Cargo.toml` file - The current directory contains a file with the `.rs` extension @@ -2260,7 +2279,7 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension @@ -2268,15 +2287,16 @@ The `scala` module shows the currently installed version of Scala. By default th ### Options -| Option | Default | Description | -| ------------------- | ---------------------------------------- | ------------------------------------------------- | -| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | -| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | -| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | -| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | -| `style` | `"red dimmed"` | The style for the module. | -| `disabled` | `false` | Disables the `scala` module. | +| Option | Default | Description | +| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `style` | `"red dimmed"` | The style for the module. | +| `disabled` | `false` | Disables the `scala` module. | ### Variables @@ -2309,17 +2329,18 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ### Options -| Option | Default | Description | -| ---------------------- | ------------ | --------------------------------------------- | -| `bash_indicator` | `bsh` | A format string used to represent bash. | -| `fish_indicator` | `fsh` | A format string used to represent fish. | -| `zsh_indicator` | `zsh` | A format string used to represent zsh. | -| `powershell_indicator` | `psh` | A format string used to represent powershell. | -| `ion_indicator` | `ion` | A format string used to represent ion. | -| `elvish_indicator` | `esh` | A format string used to represent elvish. | -| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | -| `format` | `$indicator` | The format for the module. | -| `disabled` | `true` | Disables the `shell` module. | +| Option | Default | Description | +| ---------------------- | ------------ | ------------------------------------------------------------ | +| `bash_indicator` | `bsh` | A format string used to represent bash. | +| `fish_indicator` | `fsh` | A format string used to represent fish. | +| `zsh_indicator` | `zsh` | A format string used to represent zsh. | +| `powershell_indicator` | `psh` | A format string used to represent powershell. | +| `ion_indicator` | `ion` | A format string used to represent ion. | +| `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | +| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `format` | `$indicator` | The format for the module. | +| `disabled` | `true` | Disables the `shell` module. | ### Variables @@ -2335,6 +2356,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [shell] fish_indicator = "" powershell_indicator = "_" +unknown_indicator = "mystery shell" disabled = false ``` @@ -2376,7 +2398,7 @@ threshold = 3 ## Singularity -The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Options @@ -2391,7 +2413,7 @@ The `singularity` module shows the current singularity image, if inside a contai | Variable | Example | Description | | --------- | ------------ | ------------------------------------ | -| env | `centos.img` | The current singularity image | +| env | `centos.img` | The current Singularity image | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2465,22 +2487,23 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | -| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 202"` | The style for the module. | -| `disabled` | `false` | Disables the `swift` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | +| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold 202"` | The style for the module. | +| `disabled` | `false` | Disables the `swift` module. | ### Variables @@ -2503,11 +2526,11 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: 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). +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-terraform-version). ::: @@ -2518,22 +2541,23 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | -| `symbol` | `"💠"` | A format string shown before the terraform workspace. | -| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | -| `style` | `"bold 105"` | The style for the module. | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | +| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | +| `style` | `"bold 105"` | The style for the module. | +| `disabled` | `false` | Disables the `terraform` module. | ### Variables | Variable | Example | Description | | --------- | ---------- | ------------------------------------ | | version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current terraform workspace | +| workspace | `default` | The current Terraform workspace | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2541,7 +2565,7 @@ By default the module will be shown if any of the following conditions are met: ### Example -#### With Version +#### With Terraform Version ```toml # ~/.config/starship.toml @@ -2550,7 +2574,7 @@ By default the module will be shown if any of the following conditions are met: format = "[🏎💨 $version$workspace]($style) " ``` -#### Without version +#### Without Terraform version ```toml # ~/.config/starship.toml @@ -2652,21 +2676,22 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default 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. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"cyan bold"` | The style for the module. | -| `disabled` | `false` | Disables the `vagrant` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2689,7 +2714,7 @@ format = "via [⍱ $version](bold white) " ## VCSH -The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### Options @@ -2721,21 +2746,22 @@ format = "[🆅 $repo](bold blue) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `.zig` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | -| `style` | `"bold yellow"` | The style for the module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `zig` module. | -| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `false` | Disables the `zig` module. | +| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables diff --git a/docs/nl-NL/config/README.md b/docs/nl-NL/config/README.md index cb488c9f..2c432f89 100644 --- a/docs/nl-NL/config/README.md +++ b/docs/nl-NL/config/README.md @@ -3,7 +3,7 @@ To get started configuring starship, create the following file: `~/.config/starship.toml`. ```sh -mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml +mkdir -p ~/.config && touch ~/.config/starship.toml ``` All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: @@ -49,9 +49,9 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ### Terminology -**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project. +**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project. -**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of NodeJS. +**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js. By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix. @@ -384,7 +384,7 @@ The character will tell you whether the last command was successful or not. It c - changing color (`red`/`green`) - changing shape (`❯`/`✖`) -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). +By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). ::: warning `error_symbol` is not supported on elvish shell. ::: @@ -437,22 +437,23 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met: +The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met: - The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeCache.txt` file ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `cmake` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"△ "` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `cmake` module. | ### Variables @@ -555,22 +556,23 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met: +The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `shard.yml` file - The current directory contains a `.cr` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | --------------------------------------------------------- | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | -| `style` | `"bold red"` | The style for the module. | -| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | -| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `crystal` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `"bold red"` | The style for the module. | +| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | +| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `disabled` | `false` | Disables the `crystal` module. | ### Variables @@ -593,7 +595,7 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory @@ -601,15 +603,16 @@ The `dart` module shows the currently installed version of Dart. By default the ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | -| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `dart` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | +| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. | +| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `dart` module. | ### Variables @@ -632,20 +635,21 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of Deno. By default the module will be shown if any of the following conditions are met: +The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"green bold"` | The style for the module. | -| `disabled` | `false` | Disables the `deno` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"green bold"` | The style for the module. | +| `disabled` | `false` | Disables the `deno` module. | ### Variables @@ -764,7 +768,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -786,16 +790,17 @@ The module will also show the Target Framework Moniker ( ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager. @@ -1949,7 +1965,7 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file @@ -1959,15 +1975,16 @@ The `perl` module shows the currently installed version of Perl. By default the ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | -| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | -| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | -| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 149"` | The style for the module. | -| `disabled` | `false` | Disables the `perl` module. | +| Option | Default | Description | **** | +| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- | +| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | +| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | +| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | | +| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | | +| `detect_folders` | `[]` | Which folders should trigger this module. | | +| `style` | `"bold 149"` | The style for the module. | | +| `disabled` | `false` | Disables the `perl` module. | | ### Variables @@ -1988,7 +2005,7 @@ format = "via [🦪 $version]($style) " ## PHP -The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `composer.json` file - The current directory contains a `.php-version` file @@ -1996,15 +2013,16 @@ The `php` module shows the currently installed version of PHP. By default the mo ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | -| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | -| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"147 bold"` | The style for the module. | -| `disabled` | `false` | Disables the `php` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | +| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"147 bold"` | The style for the module. | +| `disabled` | `false` | Disables the `php` module. | ### Variables @@ -2027,22 +2045,23 @@ format = "via [🔹 $version](147 bold) " ## PureScript -The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: - The current directory contains a `spago.dhall` file - The current directory contains a file with the `.purs` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | -| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold white"` | The style for the module. | -| `disabled` | `false` | Disables the `purescript` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | +| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold white"` | The style for the module. | +| `disabled` | `false` | Disables the `purescript` module. | ### Variables @@ -2065,7 +2084,7 @@ format = "via [$symbol$version](bold white)" ## Python -The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. @@ -2092,7 +2111,7 @@ By default the module will be shown if any of the following conditions are met: | `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | -| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | +| `detect_extensions` | `["py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2143,7 +2162,7 @@ detect_extensions = [] ## Red -By default the `red` module shows the currently installed version of Red. The module will be shown if any of the following conditions are met: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a file with `.red` or `.reds` extension @@ -2181,7 +2200,7 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Gemfile` file - The current directory contains a `.ruby-version` file @@ -2221,7 +2240,7 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Cargo.toml` file - The current directory contains a file with the `.rs` extension @@ -2260,7 +2279,7 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension @@ -2268,15 +2287,16 @@ The `scala` module shows the currently installed version of Scala. By default th ### Options -| Option | Default | Description | -| ------------------- | ---------------------------------------- | ------------------------------------------------- | -| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | -| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | -| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | -| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | -| `style` | `"red dimmed"` | The style for the module. | -| `disabled` | `false` | Disables the `scala` module. | +| Option | Default | Description | +| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `style` | `"red dimmed"` | The style for the module. | +| `disabled` | `false` | Disables the `scala` module. | ### Variables @@ -2309,17 +2329,18 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ### Options -| Option | Default | Description | -| ---------------------- | ------------ | --------------------------------------------- | -| `bash_indicator` | `bsh` | A format string used to represent bash. | -| `fish_indicator` | `fsh` | A format string used to represent fish. | -| `zsh_indicator` | `zsh` | A format string used to represent zsh. | -| `powershell_indicator` | `psh` | A format string used to represent powershell. | -| `ion_indicator` | `ion` | A format string used to represent ion. | -| `elvish_indicator` | `esh` | A format string used to represent elvish. | -| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | -| `format` | `$indicator` | The format for the module. | -| `disabled` | `true` | Disables the `shell` module. | +| Option | Default | Description | +| ---------------------- | ------------ | ------------------------------------------------------------ | +| `bash_indicator` | `bsh` | A format string used to represent bash. | +| `fish_indicator` | `fsh` | A format string used to represent fish. | +| `zsh_indicator` | `zsh` | A format string used to represent zsh. | +| `powershell_indicator` | `psh` | A format string used to represent powershell. | +| `ion_indicator` | `ion` | A format string used to represent ion. | +| `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | +| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `format` | `$indicator` | The format for the module. | +| `disabled` | `true` | Disables the `shell` module. | ### Variables @@ -2335,6 +2356,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [shell] fish_indicator = "" powershell_indicator = "_" +unknown_indicator = "mystery shell" disabled = false ``` @@ -2376,7 +2398,7 @@ threshold = 3 ## Singularity -The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Options @@ -2391,7 +2413,7 @@ The `singularity` module shows the current singularity image, if inside a contai | Variable | Example | Description | | --------- | ------------ | ------------------------------------ | -| env | `centos.img` | The current singularity image | +| env | `centos.img` | The current Singularity image | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2465,22 +2487,23 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | -| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 202"` | The style for the module. | -| `disabled` | `false` | Disables the `swift` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | +| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold 202"` | The style for the module. | +| `disabled` | `false` | Disables the `swift` module. | ### Variables @@ -2503,11 +2526,11 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: 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). +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-terraform-version). ::: @@ -2518,22 +2541,23 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | -| `symbol` | `"💠"` | A format string shown before the terraform workspace. | -| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | -| `style` | `"bold 105"` | The style for the module. | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | +| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | +| `style` | `"bold 105"` | The style for the module. | +| `disabled` | `false` | Disables the `terraform` module. | ### Variables | Variable | Example | Description | | --------- | ---------- | ------------------------------------ | | version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current terraform workspace | +| workspace | `default` | The current Terraform workspace | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2541,7 +2565,7 @@ By default the module will be shown if any of the following conditions are met: ### Example -#### With Version +#### With Terraform Version ```toml # ~/.config/starship.toml @@ -2550,7 +2574,7 @@ By default the module will be shown if any of the following conditions are met: format = "[🏎💨 $version$workspace]($style) " ``` -#### Without version +#### Without Terraform version ```toml # ~/.config/starship.toml @@ -2652,21 +2676,22 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default 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. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"cyan bold"` | The style for the module. | -| `disabled` | `false` | Disables the `vagrant` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2689,7 +2714,7 @@ format = "via [⍱ $version](bold white) " ## VCSH -The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### Options @@ -2721,21 +2746,22 @@ format = "[🆅 $repo](bold blue) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `.zig` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | -| `style` | `"bold yellow"` | The style for the module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `zig` module. | -| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `false` | Disables the `zig` module. | +| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables diff --git a/docs/pl-PL/config/README.md b/docs/pl-PL/config/README.md index cb488c9f..2c432f89 100644 --- a/docs/pl-PL/config/README.md +++ b/docs/pl-PL/config/README.md @@ -3,7 +3,7 @@ To get started configuring starship, create the following file: `~/.config/starship.toml`. ```sh -mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml +mkdir -p ~/.config && touch ~/.config/starship.toml ``` All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: @@ -49,9 +49,9 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ### Terminology -**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project. +**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project. -**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of NodeJS. +**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js. By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix. @@ -384,7 +384,7 @@ The character will tell you whether the last command was successful or not. It c - changing color (`red`/`green`) - changing shape (`❯`/`✖`) -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). +By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). ::: warning `error_symbol` is not supported on elvish shell. ::: @@ -437,22 +437,23 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met: +The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met: - The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeCache.txt` file ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `cmake` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"△ "` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `cmake` module. | ### Variables @@ -555,22 +556,23 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met: +The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `shard.yml` file - The current directory contains a `.cr` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | --------------------------------------------------------- | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | -| `style` | `"bold red"` | The style for the module. | -| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | -| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `crystal` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `"bold red"` | The style for the module. | +| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | +| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `disabled` | `false` | Disables the `crystal` module. | ### Variables @@ -593,7 +595,7 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory @@ -601,15 +603,16 @@ The `dart` module shows the currently installed version of Dart. By default the ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | -| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `dart` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | +| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. | +| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `dart` module. | ### Variables @@ -632,20 +635,21 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of Deno. By default the module will be shown if any of the following conditions are met: +The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"green bold"` | The style for the module. | -| `disabled` | `false` | Disables the `deno` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"green bold"` | The style for the module. | +| `disabled` | `false` | Disables the `deno` module. | ### Variables @@ -764,7 +768,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -786,16 +790,17 @@ The module will also show the Target Framework Moniker ( ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager. @@ -1949,7 +1965,7 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file @@ -1959,15 +1975,16 @@ The `perl` module shows the currently installed version of Perl. By default the ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | -| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | -| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | -| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 149"` | The style for the module. | -| `disabled` | `false` | Disables the `perl` module. | +| Option | Default | Description | **** | +| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- | +| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | +| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | +| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | | +| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | | +| `detect_folders` | `[]` | Which folders should trigger this module. | | +| `style` | `"bold 149"` | The style for the module. | | +| `disabled` | `false` | Disables the `perl` module. | | ### Variables @@ -1988,7 +2005,7 @@ format = "via [🦪 $version]($style) " ## PHP -The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `composer.json` file - The current directory contains a `.php-version` file @@ -1996,15 +2013,16 @@ The `php` module shows the currently installed version of PHP. By default the mo ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | -| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | -| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"147 bold"` | The style for the module. | -| `disabled` | `false` | Disables the `php` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | +| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"147 bold"` | The style for the module. | +| `disabled` | `false` | Disables the `php` module. | ### Variables @@ -2027,22 +2045,23 @@ format = "via [🔹 $version](147 bold) " ## PureScript -The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: - The current directory contains a `spago.dhall` file - The current directory contains a file with the `.purs` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | -| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold white"` | The style for the module. | -| `disabled` | `false` | Disables the `purescript` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | +| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold white"` | The style for the module. | +| `disabled` | `false` | Disables the `purescript` module. | ### Variables @@ -2065,7 +2084,7 @@ format = "via [$symbol$version](bold white)" ## Python -The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. @@ -2092,7 +2111,7 @@ By default the module will be shown if any of the following conditions are met: | `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | -| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | +| `detect_extensions` | `["py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2143,7 +2162,7 @@ detect_extensions = [] ## Red -By default the `red` module shows the currently installed version of Red. The module will be shown if any of the following conditions are met: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a file with `.red` or `.reds` extension @@ -2181,7 +2200,7 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Gemfile` file - The current directory contains a `.ruby-version` file @@ -2221,7 +2240,7 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Cargo.toml` file - The current directory contains a file with the `.rs` extension @@ -2260,7 +2279,7 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension @@ -2268,15 +2287,16 @@ The `scala` module shows the currently installed version of Scala. By default th ### Options -| Option | Default | Description | -| ------------------- | ---------------------------------------- | ------------------------------------------------- | -| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | -| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | -| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | -| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | -| `style` | `"red dimmed"` | The style for the module. | -| `disabled` | `false` | Disables the `scala` module. | +| Option | Default | Description | +| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `style` | `"red dimmed"` | The style for the module. | +| `disabled` | `false` | Disables the `scala` module. | ### Variables @@ -2309,17 +2329,18 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ### Options -| Option | Default | Description | -| ---------------------- | ------------ | --------------------------------------------- | -| `bash_indicator` | `bsh` | A format string used to represent bash. | -| `fish_indicator` | `fsh` | A format string used to represent fish. | -| `zsh_indicator` | `zsh` | A format string used to represent zsh. | -| `powershell_indicator` | `psh` | A format string used to represent powershell. | -| `ion_indicator` | `ion` | A format string used to represent ion. | -| `elvish_indicator` | `esh` | A format string used to represent elvish. | -| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | -| `format` | `$indicator` | The format for the module. | -| `disabled` | `true` | Disables the `shell` module. | +| Option | Default | Description | +| ---------------------- | ------------ | ------------------------------------------------------------ | +| `bash_indicator` | `bsh` | A format string used to represent bash. | +| `fish_indicator` | `fsh` | A format string used to represent fish. | +| `zsh_indicator` | `zsh` | A format string used to represent zsh. | +| `powershell_indicator` | `psh` | A format string used to represent powershell. | +| `ion_indicator` | `ion` | A format string used to represent ion. | +| `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | +| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `format` | `$indicator` | The format for the module. | +| `disabled` | `true` | Disables the `shell` module. | ### Variables @@ -2335,6 +2356,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [shell] fish_indicator = "" powershell_indicator = "_" +unknown_indicator = "mystery shell" disabled = false ``` @@ -2376,7 +2398,7 @@ threshold = 3 ## Singularity -The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Options @@ -2391,7 +2413,7 @@ The `singularity` module shows the current singularity image, if inside a contai | Variable | Example | Description | | --------- | ------------ | ------------------------------------ | -| env | `centos.img` | The current singularity image | +| env | `centos.img` | The current Singularity image | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2465,22 +2487,23 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | -| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 202"` | The style for the module. | -| `disabled` | `false` | Disables the `swift` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | +| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold 202"` | The style for the module. | +| `disabled` | `false` | Disables the `swift` module. | ### Variables @@ -2503,11 +2526,11 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: 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). +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-terraform-version). ::: @@ -2518,22 +2541,23 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | -| `symbol` | `"💠"` | A format string shown before the terraform workspace. | -| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | -| `style` | `"bold 105"` | The style for the module. | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | +| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | +| `style` | `"bold 105"` | The style for the module. | +| `disabled` | `false` | Disables the `terraform` module. | ### Variables | Variable | Example | Description | | --------- | ---------- | ------------------------------------ | | version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current terraform workspace | +| workspace | `default` | The current Terraform workspace | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2541,7 +2565,7 @@ By default the module will be shown if any of the following conditions are met: ### Example -#### With Version +#### With Terraform Version ```toml # ~/.config/starship.toml @@ -2550,7 +2574,7 @@ By default the module will be shown if any of the following conditions are met: format = "[🏎💨 $version$workspace]($style) " ``` -#### Without version +#### Without Terraform version ```toml # ~/.config/starship.toml @@ -2652,21 +2676,22 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default 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. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"cyan bold"` | The style for the module. | -| `disabled` | `false` | Disables the `vagrant` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2689,7 +2714,7 @@ format = "via [⍱ $version](bold white) " ## VCSH -The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### Options @@ -2721,21 +2746,22 @@ format = "[🆅 $repo](bold blue) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `.zig` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | -| `style` | `"bold yellow"` | The style for the module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `zig` module. | -| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `false` | Disables the `zig` module. | +| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables diff --git a/docs/pt-BR/README.md b/docs/pt-BR/README.md index 90ffe2b5..4109bef2 100644 --- a/docs/pt-BR/README.md +++ b/docs/pt-BR/README.md @@ -32,7 +32,7 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal. -### Quick Install +### Instalação 1. Instale o binário do **starship**: diff --git a/docs/pt-BR/config/README.md b/docs/pt-BR/config/README.md index e2059950..ad6def4e 100644 --- a/docs/pt-BR/config/README.md +++ b/docs/pt-BR/config/README.md @@ -3,7 +3,7 @@ Para começar a configurar a starship, crie o seguinte arquivo: `~/.config/starship.toml`. ```sh -mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml +mkdir -p ~/.config && touch ~/.config/starship.toml ``` Todas as configurações do starship são feitas neste arquivo [TOML](https://github.com/toml-lang/toml): @@ -49,9 +49,9 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ### Terminologia -**Módulo**: Um componente no prompt que fornece informações baseado no contexto do seu SO. Por exemplo, o módulo "nodejs" mostra a versão do NodeJS instalado no seu computador, se o diretório atual for um projeto NodeJS. +**Módulo**: Um componente no prompt que fornece informações baseado no contexto do seu SO. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project. -**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of NodeJS. +**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js. By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix. @@ -384,7 +384,7 @@ The character will tell you whether the last command was successful or not. It c - changing color (`red`/`green`) - changing shape (`❯`/`✖`) -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). +By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). ::: warning `error_symbol` is not supported on elvish shell. ::: @@ -437,22 +437,23 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met: +The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met: - The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeCache.txt` file ### Opções -| Option | Padrão | Descrição | -| ------------------- | -------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | -| `style` | `"bold blue"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `cmake` module. | +| Option | Padrão | Descrição | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"△ "` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `"bold blue"` | O estilo do módulo. | +| `disabled` | `false` | Disables the `cmake` module. | ### Variables @@ -468,7 +469,7 @@ The `cmake` module shows the currently installed version of CMake. By default th The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. -::: warning Do not hook the DEBUG trap in Bash +::: warning Não utilize o DEBUG-trap no Bash If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. @@ -555,22 +556,23 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met: +The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `shard.yml` file - The current directory contains a `.cr` file ### Opções -| Option | Padrão | Descrição | -| ------------------- | ------------------------------------ | --------------------------------------------------------- | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | -| `style` | `"bold red"` | O estilo do módulo. | -| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | -| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `crystal` module. | +| Option | Padrão | Descrição | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `"bold red"` | O estilo do módulo. | +| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | +| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `disabled` | `false` | Disables the `crystal` module. | ### Variables @@ -593,7 +595,7 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory @@ -601,15 +603,16 @@ The `dart` module shows the currently installed version of Dart. By default the ### 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 Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | -| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | -| `style` | `"bold blue"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `dart` module. | +| Option | Padrão | Descrição | +| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | +| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. | +| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | +| `style` | `"bold blue"` | O estilo do módulo. | +| `disabled` | `false` | Disables the `dart` module. | ### Variables @@ -632,20 +635,21 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of Deno. By default the module will be shown if any of the following conditions are met: +The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `mod.ts`, `mod.js`, `deps.ts` or `deps.js` 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 Deno | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"green bold"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `deno` module. | +| Option | Padrão | Descrição | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"green bold"` | O estilo do módulo. | +| `disabled` | `false` | Disables the `deno` module. | ### Variables @@ -764,7 +768,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -786,16 +790,17 @@ The module will also show the Target Framework Moniker ( ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager. @@ -1949,7 +1965,7 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file @@ -1959,15 +1975,16 @@ The `perl` module shows the currently installed version of Perl. By default the ### Opções -| Option | Padrão | Descrição | -| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | -| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | -| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | -| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 149"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `perl` module. | +| Option | Padrão | Descrição | **** | +| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- | +| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | +| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | +| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | | +| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | | +| `detect_folders` | `[]` | Which folders should trigger this module. | | +| `style` | `"bold 149"` | O estilo do módulo. | | +| `disabled` | `false` | Disables the `perl` module. | | ### Variables @@ -1988,7 +2005,7 @@ format = "via [🦪 $version]($style) " ## PHP -The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `composer.json` file - The current directory contains a `.php-version` file @@ -1996,15 +2013,16 @@ The `php` module shows the currently installed version of PHP. By default the mo ### Opções -| Option | Padrão | Descrição | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | -| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | -| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"147 bold"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `php` module. | +| Option | Padrão | Descrição | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | +| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"147 bold"` | O estilo do módulo. | +| `disabled` | `false` | Disables the `php` module. | ### Variables @@ -2027,22 +2045,23 @@ format = "via [🔹 $version](147 bold) " ## PureScript -The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: - The current directory contains a `spago.dhall` file - The current directory contains a file with the `.purs` extension ### Opções -| Option | Padrão | Descrição | -| ------------------- | ------------------------------------ | ------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | -| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold white"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `purescript` module. | +| Option | Padrão | Descrição | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | +| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold white"` | O estilo do módulo. | +| `disabled` | `false` | Disables the `purescript` module. | ### Variables @@ -2065,7 +2084,7 @@ format = "via [$symbol$version](bold white)" ## Python -The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. @@ -2092,7 +2111,7 @@ By default the module will be shown if any of the following conditions are met: | `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | -| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | +| `detect_extensions` | `["py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2143,7 +2162,7 @@ detect_extensions = [] ## Red -By default the `red` module shows the currently installed version of Red. The module will be shown if any of the following conditions are met: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a file with `.red` or `.reds` extension @@ -2181,7 +2200,7 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Gemfile` file - The current directory contains a `.ruby-version` file @@ -2221,7 +2240,7 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Cargo.toml` file - The current directory contains a file with the `.rs` extension @@ -2260,7 +2279,7 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension @@ -2268,15 +2287,16 @@ The `scala` module shows the currently installed version of Scala. By default th ### Opções -| Option | Padrão | Descrição | -| ------------------- | ---------------------------------------- | ------------------------------------------------- | -| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | -| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | -| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | -| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | -| `style` | `"red dimmed"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `scala` module. | +| Option | Padrão | Descrição | +| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `style` | `"red dimmed"` | O estilo do módulo. | +| `disabled` | `false` | Disables the `scala` module. | ### Variables @@ -2309,17 +2329,18 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ### Opções -| Option | Padrão | Descrição | -| ---------------------- | ------------ | --------------------------------------------- | -| `bash_indicator` | `bsh` | A format string used to represent bash. | -| `fish_indicator` | `fsh` | A format string used to represent fish. | -| `zsh_indicator` | `zsh` | A format string used to represent zsh. | -| `powershell_indicator` | `psh` | A format string used to represent powershell. | -| `ion_indicator` | `ion` | A format string used to represent ion. | -| `elvish_indicator` | `esh` | A format string used to represent elvish. | -| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | -| `format` | `$indicator` | The format for the module. | -| `disabled` | `true` | Disables the `shell` module. | +| Option | Padrão | Descrição | +| ---------------------- | ------------ | ------------------------------------------------------------ | +| `bash_indicator` | `bsh` | A format string used to represent bash. | +| `fish_indicator` | `fsh` | A format string used to represent fish. | +| `zsh_indicator` | `zsh` | A format string used to represent zsh. | +| `powershell_indicator` | `psh` | A format string used to represent powershell. | +| `ion_indicator` | `ion` | A format string used to represent ion. | +| `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | +| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `format` | `$indicator` | The format for the module. | +| `disabled` | `true` | Disables the `shell` module. | ### Variables @@ -2335,6 +2356,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [shell] fish_indicator = "" powershell_indicator = "_" +unknown_indicator = "mystery shell" disabled = false ``` @@ -2376,7 +2398,7 @@ threshold = 3 ## Singularity -The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Opções @@ -2391,7 +2413,7 @@ The `singularity` module shows the current singularity image, if inside a contai | Variável | Exemplo | Descrição | | --------- | ------------ | ------------------------------------ | -| env | `centos.img` | The current singularity image | +| env | `centos.img` | The current Singularity image | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2465,22 +2487,23 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension ### 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 Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | -| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 202"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `swift` module. | +| Option | Padrão | Descrição | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | +| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold 202"` | O estilo do módulo. | +| `disabled` | `false` | Disables the `swift` module. | ### Variables @@ -2503,11 +2526,11 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: 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). +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-terraform-version). ::: @@ -2518,22 +2541,23 @@ By default the module will be shown if any of the following conditions are met: ### Opções -| Option | Padrão | Descrição | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | -| `symbol` | `"💠"` | A format string shown before the terraform workspace. | -| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | -| `style` | `"bold 105"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | Padrão | Descrição | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | +| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | +| `style` | `"bold 105"` | O estilo do módulo. | +| `disabled` | `false` | Disables the `terraform` module. | ### Variables | Variável | Exemplo | Descrição | | --------- | ---------- | ------------------------------------ | | version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current terraform workspace | +| workspace | `default` | The current Terraform workspace | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2541,7 +2565,7 @@ By default the module will be shown if any of the following conditions are met: ### Exemplo -#### With Version +#### With Terraform Version ```toml # ~/.config/starship.toml @@ -2550,7 +2574,7 @@ By default the module will be shown if any of the following conditions are met: format = "[🏎💨 $version$workspace]($style) " ``` -#### Without version +#### Without Terraform version ```toml # ~/.config/starship.toml @@ -2652,21 +2676,22 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default 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. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"cyan bold"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `vagrant` module. | +| Option | Padrão | Descrição | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"cyan bold"` | O estilo do módulo. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2689,7 +2714,7 @@ format = "via [⍱ $version](bold white) " ## VCSH -The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### Opções @@ -2721,21 +2746,22 @@ format = "[🆅 $repo](bold blue) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `.zig` file ### Opções -| Option | Padrão | Descrição | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | -| `style` | `"bold yellow"` | O estilo do módulo. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `zig` module. | -| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | Padrão | Descrição | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | +| `style` | `"bold yellow"` | O estilo do módulo. | +| `disabled` | `false` | Disables the `zig` module. | +| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables @@ -2792,7 +2818,7 @@ The order in which custom modules are shown can be individually set by including | `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | | `shell` | | [See below](#custom-command-shell) | -| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `descrição` | `""` | The description of the module that is shown when running `starship explain`. | | `files` | `[]` | The files that will be searched in the working directory for a match. | | `directories` | `[]` | The directories that will be searched in the working directory for a match. | | `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | diff --git a/docs/pt-PT/config/README.md b/docs/pt-PT/config/README.md index cb488c9f..2c432f89 100644 --- a/docs/pt-PT/config/README.md +++ b/docs/pt-PT/config/README.md @@ -3,7 +3,7 @@ To get started configuring starship, create the following file: `~/.config/starship.toml`. ```sh -mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml +mkdir -p ~/.config && touch ~/.config/starship.toml ``` All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: @@ -49,9 +49,9 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ### Terminology -**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project. +**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project. -**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of NodeJS. +**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js. By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix. @@ -384,7 +384,7 @@ The character will tell you whether the last command was successful or not. It c - changing color (`red`/`green`) - changing shape (`❯`/`✖`) -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). +By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). ::: warning `error_symbol` is not supported on elvish shell. ::: @@ -437,22 +437,23 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met: +The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met: - The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeCache.txt` file ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `cmake` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"△ "` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `cmake` module. | ### Variables @@ -555,22 +556,23 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met: +The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `shard.yml` file - The current directory contains a `.cr` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | --------------------------------------------------------- | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | -| `style` | `"bold red"` | The style for the module. | -| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | -| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `crystal` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `"bold red"` | The style for the module. | +| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | +| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `disabled` | `false` | Disables the `crystal` module. | ### Variables @@ -593,7 +595,7 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory @@ -601,15 +603,16 @@ The `dart` module shows the currently installed version of Dart. By default the ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | -| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `dart` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | +| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. | +| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `dart` module. | ### Variables @@ -632,20 +635,21 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of Deno. By default the module will be shown if any of the following conditions are met: +The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"green bold"` | The style for the module. | -| `disabled` | `false` | Disables the `deno` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"green bold"` | The style for the module. | +| `disabled` | `false` | Disables the `deno` module. | ### Variables @@ -764,7 +768,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -786,16 +790,17 @@ The module will also show the Target Framework Moniker ( ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager. @@ -1949,7 +1965,7 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file @@ -1959,15 +1975,16 @@ The `perl` module shows the currently installed version of Perl. By default the ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | -| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | -| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | -| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 149"` | The style for the module. | -| `disabled` | `false` | Disables the `perl` module. | +| Option | Default | Description | **** | +| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- | +| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | +| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | +| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | | +| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | | +| `detect_folders` | `[]` | Which folders should trigger this module. | | +| `style` | `"bold 149"` | The style for the module. | | +| `disabled` | `false` | Disables the `perl` module. | | ### Variables @@ -1988,7 +2005,7 @@ format = "via [🦪 $version]($style) " ## PHP -The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `composer.json` file - The current directory contains a `.php-version` file @@ -1996,15 +2013,16 @@ The `php` module shows the currently installed version of PHP. By default the mo ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | -| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | -| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"147 bold"` | The style for the module. | -| `disabled` | `false` | Disables the `php` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | +| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"147 bold"` | The style for the module. | +| `disabled` | `false` | Disables the `php` module. | ### Variables @@ -2027,22 +2045,23 @@ format = "via [🔹 $version](147 bold) " ## PureScript -The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: - The current directory contains a `spago.dhall` file - The current directory contains a file with the `.purs` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | -| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold white"` | The style for the module. | -| `disabled` | `false` | Disables the `purescript` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | +| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold white"` | The style for the module. | +| `disabled` | `false` | Disables the `purescript` module. | ### Variables @@ -2065,7 +2084,7 @@ format = "via [$symbol$version](bold white)" ## Python -The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. @@ -2092,7 +2111,7 @@ By default the module will be shown if any of the following conditions are met: | `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | -| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | +| `detect_extensions` | `["py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2143,7 +2162,7 @@ detect_extensions = [] ## Red -By default the `red` module shows the currently installed version of Red. The module will be shown if any of the following conditions are met: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a file with `.red` or `.reds` extension @@ -2181,7 +2200,7 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Gemfile` file - The current directory contains a `.ruby-version` file @@ -2221,7 +2240,7 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Cargo.toml` file - The current directory contains a file with the `.rs` extension @@ -2260,7 +2279,7 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension @@ -2268,15 +2287,16 @@ The `scala` module shows the currently installed version of Scala. By default th ### Options -| Option | Default | Description | -| ------------------- | ---------------------------------------- | ------------------------------------------------- | -| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | -| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | -| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | -| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | -| `style` | `"red dimmed"` | The style for the module. | -| `disabled` | `false` | Disables the `scala` module. | +| Option | Default | Description | +| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `style` | `"red dimmed"` | The style for the module. | +| `disabled` | `false` | Disables the `scala` module. | ### Variables @@ -2309,17 +2329,18 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ### Options -| Option | Default | Description | -| ---------------------- | ------------ | --------------------------------------------- | -| `bash_indicator` | `bsh` | A format string used to represent bash. | -| `fish_indicator` | `fsh` | A format string used to represent fish. | -| `zsh_indicator` | `zsh` | A format string used to represent zsh. | -| `powershell_indicator` | `psh` | A format string used to represent powershell. | -| `ion_indicator` | `ion` | A format string used to represent ion. | -| `elvish_indicator` | `esh` | A format string used to represent elvish. | -| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | -| `format` | `$indicator` | The format for the module. | -| `disabled` | `true` | Disables the `shell` module. | +| Option | Default | Description | +| ---------------------- | ------------ | ------------------------------------------------------------ | +| `bash_indicator` | `bsh` | A format string used to represent bash. | +| `fish_indicator` | `fsh` | A format string used to represent fish. | +| `zsh_indicator` | `zsh` | A format string used to represent zsh. | +| `powershell_indicator` | `psh` | A format string used to represent powershell. | +| `ion_indicator` | `ion` | A format string used to represent ion. | +| `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | +| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `format` | `$indicator` | The format for the module. | +| `disabled` | `true` | Disables the `shell` module. | ### Variables @@ -2335,6 +2356,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [shell] fish_indicator = "" powershell_indicator = "_" +unknown_indicator = "mystery shell" disabled = false ``` @@ -2376,7 +2398,7 @@ threshold = 3 ## Singularity -The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Options @@ -2391,7 +2413,7 @@ The `singularity` module shows the current singularity image, if inside a contai | Variable | Example | Description | | --------- | ------------ | ------------------------------------ | -| env | `centos.img` | The current singularity image | +| env | `centos.img` | The current Singularity image | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2465,22 +2487,23 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | -| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 202"` | The style for the module. | -| `disabled` | `false` | Disables the `swift` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | +| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold 202"` | The style for the module. | +| `disabled` | `false` | Disables the `swift` module. | ### Variables @@ -2503,11 +2526,11 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: 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). +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-terraform-version). ::: @@ -2518,22 +2541,23 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | -| `symbol` | `"💠"` | A format string shown before the terraform workspace. | -| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | -| `style` | `"bold 105"` | The style for the module. | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | +| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | +| `style` | `"bold 105"` | The style for the module. | +| `disabled` | `false` | Disables the `terraform` module. | ### Variables | Variable | Example | Description | | --------- | ---------- | ------------------------------------ | | version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current terraform workspace | +| workspace | `default` | The current Terraform workspace | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2541,7 +2565,7 @@ By default the module will be shown if any of the following conditions are met: ### Example -#### With Version +#### With Terraform Version ```toml # ~/.config/starship.toml @@ -2550,7 +2574,7 @@ By default the module will be shown if any of the following conditions are met: format = "[🏎💨 $version$workspace]($style) " ``` -#### Without version +#### Without Terraform version ```toml # ~/.config/starship.toml @@ -2652,21 +2676,22 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default 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. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"cyan bold"` | The style for the module. | -| `disabled` | `false` | Disables the `vagrant` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2689,7 +2714,7 @@ format = "via [⍱ $version](bold white) " ## VCSH -The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### Options @@ -2721,21 +2746,22 @@ format = "[🆅 $repo](bold blue) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `.zig` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | -| `style` | `"bold yellow"` | The style for the module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `zig` module. | -| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `false` | Disables the `zig` module. | +| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables diff --git a/docs/ru-RU/README.md b/docs/ru-RU/README.md index 82a59556..9981798a 100644 --- a/docs/ru-RU/README.md +++ b/docs/ru-RU/README.md @@ -32,7 +32,7 @@ description: Starship - минимальная, быстрая и бесконе - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal. -### Quick Install +### Быстрая установка 1. Установите двоичный файл **starship**: diff --git a/docs/ru-RU/advanced-config/README.md b/docs/ru-RU/advanced-config/README.md index fdb3d3a4..830efdb1 100644 --- a/docs/ru-RU/advanced-config/README.md +++ b/docs/ru-RU/advanced-config/README.md @@ -81,7 +81,7 @@ starship_precmd_user_func="set_win_title" - `` - `none` -где `` является цветовым спецификатором (обсуждается ниже). `fg:` and `` currently do the same thing, though this may change in the future. `inverted` swaps the background and foreground colors. The order of words in the string does not matter. +где `` является цветовым спецификатором (обсуждается ниже). `fg:` and `` currently do the same thing, though this may change in the future. `inverted` swaps the background and foreground colors. Порядок слов в строке не имеет значения. Токен `none` переопределяет все остальные токены в строке, если он не является частью спецификатора `bg:` так, например, `fg:red none fg:blue` все равно создаст строку без стиля. `bg:none` sets the background to the default color so `fg:red bg:none` is equivalent to `red` or `fg:red` and `bg:green fg:red bg:none` is also equivalent to `fg:red` or `red`. Использование `none` в сочетании с другими токенами может стать ошибкой в будущем. diff --git a/docs/ru-RU/config/README.md b/docs/ru-RU/config/README.md index 041c82d3..490e0609 100644 --- a/docs/ru-RU/config/README.md +++ b/docs/ru-RU/config/README.md @@ -3,7 +3,7 @@ Чтобы начать конфигурацию Starship, создайте следующий файл: `~/.config/starship.toml`. ```sh -mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml +mkdir -p ~/.config && touch ~/.config/starship.toml ``` Вся конфигурация Starship выполняется в этом файле [TOML](https://github.com/toml-lang/toml): @@ -49,9 +49,9 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ### Терминология -**Модуль**: Компонент строки, дающий информацию на основе контекстной информации вашей ОС. Например, модуль "nodejs" показывает установленную версию NodeJS на вашем компьютере, если вы находитесь в директории проекта NodeJS. +**Модуль**: Компонент строки, дающий информацию на основе контекстной информации вашей ОС. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project. -**Variable**: Smaller sub-components that contain information provided by the module. Например, переменная "version" в модуле "nodejs" содержит текущую версию NodeJS. +**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js. По традициям, большинство модулей имеют префикс цвета терминала по умолчанию (например, `через` в "узлах") и пустое пространство как суффикс. @@ -265,7 +265,7 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Примеры @@ -310,7 +310,7 @@ symbol = "🅰 " ## Батарея -The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. +Модуль `battery` показывает насколько заряжена батарея девайса и статус зарядки на данный момент. Модуль виден только, если заряд батареи устройства меньше 10%. ### Опции @@ -338,7 +338,7 @@ discharging_symbol = "💀 " ### Отображение батареи -The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). If no `display` is provided. Значение по умолчанию: +The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). Если `display` не предоставлено. Значение по умолчанию: ```toml [[battery.display]] @@ -350,12 +350,12 @@ The default value for the `charging_symbol` and `discharging_symbol` option is r #### Опции -The `display` option is an array of the following table. +Опция `display` представляет собой массив следующей таблицы. | Параметр | По умолчанию | Описание | | -------------------- | ------------ | --------------------------------------------------------------------------------------------------------- | -| `threshold` | `10` | The upper bound for the display option. | -| `style` | `bold red` | The style used if the display option is in use. | +| `threshold` | `10` | Верхняя граница опции отображения. | +| `style` | `bold red` | Используемый стиль, если используется опция отображения. | | `charging_symbol` | `-` | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. | | `discharging_symbol` | `-` | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. | @@ -377,14 +377,14 @@ discharging_symbol = 💦 ## Символ -The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. +Модуль `character` показывает символ (обычно, стрелка) рядом с вводимым текстом в терминале. -The character will tell you whether the last command was successful or not. It can do this in two ways: +Символ показывает, была ли последняя команда успешной или нет. It can do this in two ways: - changing color (`red`/`green`) - changing shape (`❯`/`✖`) -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). +By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). ::: warning `error_symbol` is not supported on elvish shell. ::: @@ -437,22 +437,23 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met: +The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met: - The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeCache.txt` file ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | -------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | -| `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | -| `style` | `"bold blue"` | Стиль модуля. | -| `disabled` | `false` | Disables the `cmake` module. | +| Параметр | По умолчанию | Описание | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"△ "` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `"bold blue"` | Стиль модуля. | +| `disabled` | `false` | Disables the `cmake` module. | ### Переменные @@ -462,19 +463,19 @@ The `cmake` module shows the currently installed version of CMake. By default th | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ## Длительность команды -The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. +Модуль `cmd_duration` показывает время исполнения последней команды. Модуль будет показан только, если команда заняла более двух секунд, или если задан параметр `min_time`. -::: warning Do not hook the DEBUG trap in Bash +::: warning Не подключайте ловушку DEBUG к Bash -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. +Если вы испоьзуете Starship в `bash`, не подключайте ловушку `DEBUG` после запуска `eval $(starship init $0)`, иначе этот модуль сломается. ::: -Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. +Пользователи Bash, которым нужна функциональность, подобная preexec, могут использовать [фреймворк bash_preexec от rcaloras](https://github.com/rcaloras/bash-preexec). Просто определите массивы `preexec_functions` и `precmd_functions` перед запуском `eval $(starship init $0)`, а затем продолжайте нормально. ### Опции @@ -501,7 +502,7 @@ Showing desktop notifications requires starship to be built with `rust-notify` s | duration | `16m40s` | The time it took to execute the command | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -515,11 +516,11 @@ format = "underwent [$duration](bold yellow)" ## Конда -The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. +Модуль `conda` показывает текущее окружение conda, если `$CONDA_DEFAULT_ENV` присвоено значение. ::: tip -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. +Это не подавляет модификатор командной строки самой conda. Возможно, вы захотите запустить `conda config --set changeps1 False`. ::: @@ -542,7 +543,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -555,22 +556,23 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met: +The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: - Текущий каталог содержит файл `shard.yml` - Текущий каталог содержит файл `.cr` ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | ------------------------------------ | ------------------------------------------------------- | -| `symbol` | `"🔮 "` | Символ, используемый перед отображением версии crystal. | -| `style` | `"bold red"` | Стиль модуля. | -| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | -| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | -| `disabled` | `false` | Отключает модуль `crystal`. | +| Параметр | По умолчанию | Описание | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `symbol` | `"🔮 "` | Символ, используемый перед отображением версии crystal. | +| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `"bold red"` | Стиль модуля. | +| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | +| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `disabled` | `false` | Отключает модуль `crystal`. | ### Переменные @@ -580,7 +582,7 @@ The `crystal` module shows the currently installed version of Crystal. By defaul | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -593,7 +595,7 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory @@ -601,15 +603,16 @@ The `dart` module shows the currently installed version of Dart. By default the ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | ------------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | -| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | -| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | -| `style` | `"bold blue"` | Стиль модуля. | -| `disabled` | `false` | Disables the `dart` module. | +| Параметр | По умолчанию | Описание | +| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | +| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. | +| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | +| `style` | `"bold blue"` | Стиль модуля. | +| `disabled` | `false` | Disables the `dart` module. | ### Переменные @@ -619,7 +622,7 @@ The `dart` module shows the currently installed version of Dart. By default the | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -632,20 +635,21 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of Deno. By default the module will be shown if any of the following conditions are met: -- The current directory contains a `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file +The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: +- Текущий каталог содержит файл `mod.ts`, `mod.js`, `deps.ts` или `deps.js` ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | -------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | -| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"green bold"` | Стиль модуля. | -| `disabled` | `false` | Disables the `deno` module. | +| Параметр | По умолчанию | Описание | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"green bold"` | Стиль модуля. | +| `disabled` | `false` | Disables the `deno` module. | ### Переменные @@ -666,33 +670,33 @@ format = "via [🦕 $version](green bold) " ## Каталог -The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. +Модуль `directory` показывает путь к вашей текущей директории, усеченной до трех родительских папок. Ваш каталог также будет отсечен до корня git репозитория, в котором вы находитесь. -When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. +При использовании стиля оболочки fish, вместо скрытия усеченного каталога, вы увидите укороченное имя каталога, зависимое от числа символов вы установите для этой опции. -For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. +Например, возьмем `~/Dev/Nix/nixpkgs/pkgs` где `nixpkgs` является корневым репозиторием, и в опции установлено `1`. Вы увидите `~/D/N/nixpkgs/pkgs`, а до этого было бы `nixpkgs/pkgs`. ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- | -| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | -| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | -| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | Формат модуля. | -| `style` | `"bold cyan"` | Стиль модуля. | -| `disabled` | `false` | Disables the `directory` module. | -| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | -| `read_only_style` | `"red"` | The style for the read only symbol. | -| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | -| `home_symbol` | `"~"` | The symbol indicating home directory. | +| Параметр | По умолчанию | Описание | +| ------------------- | -------------------------------------------------- | ---------------------------------------------------------------------------- | +| `truncation_length` | `3` | Количество родительских папок, к которым должен быть усечен текущий каталог. | +| `truncate_to_repo` | `true` | Следует или нет обрезать до корня репозитория git, в котором вы находитесь. | +| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | Формат модуля. | +| `style` | `"bold cyan"` | Стиль модуля. | +| `disabled` | `false` | Отключает модуль `directory`. | +| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | +| `read_only_style` | `"red"` | The style for the read only symbol. | +| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | +| `home_symbol` | `"~"` | The symbol indicating home directory. |

-This module has a few advanced configuration options that control how the directory is displayed. +Этот модуль имеет несколько расширенных опций конфигурации, которые контролируют отображение каталога. | Advanced Option | По умолчанию | Описание | | --------------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `substitutions` | | A table of substitutions to be made to the path. | -| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | +| `fish_style_pwd_dir_length` | `0` | Количество символов, используемых при использовании логики создания пути из fish. | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. | `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. @@ -703,7 +707,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an "src/com/long/java/path" = "mypath" ``` -`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`. +`fish_style_pwd_dir_length` взаимодействует со стандартными параметрами усечения, которые могут сначала показаться странными: если он не равен нулю, элементы пути, который обычно усекается, вместо этого отображаются с указанным количеством символов. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
@@ -714,7 +718,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | path | `"D:/Projects"` | The current directory path | | style\* | `"black bold dimmed"` | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -726,9 +730,9 @@ truncation_length = 8 truncation_symbol = "…/" ``` -## Docker Context +## Контекст Docker -The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default`. +Модуль `docker_context` показывает текущий активный [контекст Docker](https://docs.docker.com/engine/context/working-with-contexts/), если он не установлен как `default`. ### Опции @@ -751,7 +755,7 @@ The `docker_context` module shows the currently active [Docker context](https:// | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -764,7 +768,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. Если SDK был закреплен в текущей директории, будет показана закрепленная версия. В противном случае модуль отображает последнюю установленную версию SDK. By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -780,22 +784,23 @@ By default this module will only be shown in your prompt when one or more of the You'll also need the .NET Core SDK installed in order to use it correctly. -Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. +Внутренне этот модуль использует свой собственный механизм определения версий. Обычно он в два раза быстрее, чем `dotnet --version`, но он может показывать неправильную версию, если ваш .NET проект имеет необычный формат каталога. Если точность важнее, чем скорость, вы можете отключить механизм опцией `heuristic = false` в настройках модуля. The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | Формат модуля. | -| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. | -| `heuristic` | `true` | Use faster version detection to keep starship snappy. | -| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. | -| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `style` | `"bold blue"` | Стиль модуля. | -| `disabled` | `false` | Disables the `dotnet` module. | +| Параметр | По умолчанию | Описание | +| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | Формат модуля. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `".NET "` | Символ перед отображением текущей версии dotnet. | +| `heuristic` | `true` | Использовать быстрое определение версии, для сохранения скорости. | +| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. | +| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold blue"` | Стиль модуля. | +| `disabled` | `false` | Отключает модуль `dotnet`. | ### Переменные @@ -806,7 +811,7 @@ The module will also show the Target Framework Moniker ( ⚠ Показана версия пакета, исходный код которого находится в текущем каталоге, а не в менеджере пакетов. ### Опции -| Параметр | По умолчанию | Описание | -| ----------------- | --------------------------------- | ---------------------------------------------------------- | -| `format` | `"is [$symbol$version]($style) "` | Формат модуля. | -| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | -| `style` | `"bold 208"` | Стиль модуля. | -| `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | Disables the `package` module. | +| Параметр | По умолчанию | Описание | +| ----------------- | --------------------------------- | --------------------------------------------------------- | +| `format` | `"is [$symbol$version]($style) "` | Формат модуля. | +| `symbol` | `"📦 "` | Символ, используемый перед отображением версии пакета. | +| `style` | `"bold 208"` | Стиль модуля. | +| `display_private` | `false` | Enable displaying version for packages marked as private. | +| `disabled` | `false` | Отключает модуль `package`. | ### Переменные @@ -1936,7 +1952,7 @@ The `package` module is shown when the current directory is the repository for a | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -1949,7 +1965,7 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file @@ -1959,15 +1975,16 @@ The `perl` module shows the currently installed version of Perl. By default the ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | -| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | -| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | -| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 149"` | Стиль модуля. | -| `disabled` | `false` | Disables the `perl` module. | +| Параметр | По умолчанию | Описание | **** | +| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- | +| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | +| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | +| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | | +| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | | +| `detect_folders` | `[]` | Which folders should trigger this module. | | +| `style` | `"bold 149"` | Стиль модуля. | | +| `disabled` | `false` | Disables the `perl` module. | | ### Переменные @@ -1988,23 +2005,24 @@ format = "via [🦪 $version]($style) " ## PHP -The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `composer.json` file -- The current directory contains a `.php-version` file +- Текущий каталог содержит файл `composer.json` +- Текущий каталог содержит файл `.php-version` - The current directory contains a `.php` extension ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | -| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | -| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | -| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"147 bold"` | Стиль модуля. | -| `disabled` | `false` | Disables the `php` module. | +| Параметр | По умолчанию | Описание | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐘 "` | Символ, используемый перед отображением версии PHP. | +| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | +| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"147 bold"` | Стиль модуля. | +| `disabled` | `false` | Отключает модуль `php`. | ### Переменные @@ -2014,7 +2032,7 @@ The `php` module shows the currently installed version of PHP. By default the mo | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -2027,22 +2045,23 @@ format = "via [🔹 $version](147 bold) " ## PureScript -The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: -- The current directory contains a `spago.dhall` file +- Текущий каталог содержит файл `spago.dhall` - The current directory contains a file with the `.purs` extension ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | ------------------------------------ | ------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | -| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | -| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold white"` | Стиль модуля. | -| `disabled` | `false` | Disables the `purescript` module. | +| Параметр | По умолчанию | Описание | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | +| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold white"` | Стиль модуля. | +| `disabled` | `false` | Disables the `purescript` module. | ### Переменные @@ -2052,7 +2071,7 @@ The `purescript` module shows the currently installed version of PureScript vers | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -2065,21 +2084,21 @@ format = "via [$symbol$version](bold white)" ## Python -The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. By default the module will be shown if any of the following conditions are met: -- The current directory contains a `.python-version` file -- The current directory contains a `Pipfile` file +- Текущий каталог содержит файл `.python-version` +- Текущий каталог содержит файл `Pipfile` - The current directory contains a `__init__.py` file -- The current directory contains a `pyproject.toml` file -- The current directory contains a `requirements.txt` file -- The current directory contains a `setup.py` file -- The current directory contains a `tox.ini` file -- The current directory contains a file with the `.py` extension. -- A virtual environment is currently activated +- Текущий каталог содержит файл `pyproject.toml` +- Текущий каталог содержит файл `requirements.txt` +- Текущий каталог содержит файл `setup.py` +- Текущий каталог содержит файл `tox.ini` +- Текущий каталог содержит файл с расширением `.py`. +- Виртуальная среда в данный момент активирована ### Опции @@ -2089,10 +2108,10 @@ By default the module will be shown if any of the following conditions are met: | `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | Стиль модуля. | -| `pyenv_version_name` | `false` | Use pyenv to get Python version | +| `pyenv_version_name` | `false` | Использовать pyenv для получения версии Python | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | -| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | +| `detect_extensions` | `["py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2143,7 +2162,7 @@ detect_extensions = [] ## Red -By default the `red` module shows the currently installed version of Red. The module will be shown if any of the following conditions are met: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). Модуль будет показан, если любое из следующих условий соблюдено: - The current directory contains a file with `.red` or `.reds` extension @@ -2168,7 +2187,7 @@ By default the `red` module shows the currently installed version of Red. The mo | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -2181,11 +2200,11 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). Модуль будет показан, если любое из следующих условий соблюдено: -- The current directory contains a `Gemfile` file -- The current directory contains a `.ruby-version` file -- The current directory contains a `.rb` file +- Текущий каталог содержит файл `Gemfile` +- Текущий каталог содержит файл `.ruby-version` +- Текущий каталог содержит файл `.rb` ### Опции @@ -2198,7 +2217,7 @@ By default the `ruby` module shows the currently installed version of Ruby. The | `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold red"` | Стиль модуля. | -| `disabled` | `false` | Disables the `ruby` module. | +| `disabled` | `false` | Отключает модуль `ruby`. | ### Переменные @@ -2208,7 +2227,7 @@ By default the `ruby` module shows the currently installed version of Ruby. The | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -2221,10 +2240,10 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). Модуль будет показан, если любое из следующих условий соблюдено: -- The current directory contains a `Cargo.toml` file -- The current directory contains a file with the `.rs` extension +- Текущий каталог содержит файл `Cargo.toml` +- Текущий каталог содержит файл с расширением `.rs` ### Опции @@ -2237,7 +2256,7 @@ By default the `rust` module shows the currently installed version of Rust. The | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold red"` | Стиль модуля. | -| `disabled` | `false` | Disables the `rust` module. | +| `disabled` | `false` | Отключает модуль `rust`. | ### Переменные @@ -2247,7 +2266,7 @@ By default the `rust` module shows the currently installed version of Rust. The | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -2260,7 +2279,7 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension @@ -2268,15 +2287,16 @@ The `scala` module shows the currently installed version of Scala. By default th ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | ---------------------------------------- | ------------------------------------------------- | -| `format` | `"via [${symbol}(${version} )]($style)"` | Формат модуля. | -| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | -| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | -| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | -| `style` | `"red dimmed"` | Стиль модуля. | -| `disabled` | `false` | Disables the `scala` module. | +| Параметр | По умолчанию | Описание | +| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | Формат модуля. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `style` | `"red dimmed"` | Стиль модуля. | +| `disabled` | `false` | Disables the `scala` module. | ### Переменные @@ -2286,7 +2306,7 @@ The `scala` module shows the currently installed version of Scala. By default th | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -2303,23 +2323,24 @@ The `shell` module shows an indicator for currently used shell. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. ::: ### Опции -| Параметр | По умолчанию | Описание | -| ---------------------- | ------------ | --------------------------------------------- | -| `bash_indicator` | `bsh` | A format string used to represent bash. | -| `fish_indicator` | `fsh` | A format string used to represent fish. | -| `zsh_indicator` | `zsh` | A format string used to represent zsh. | -| `powershell_indicator` | `psh` | A format string used to represent powershell. | -| `ion_indicator` | `ion` | A format string used to represent ion. | -| `elvish_indicator` | `esh` | A format string used to represent elvish. | -| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | -| `format` | `$indicator` | Формат модуля. | -| `disabled` | `true` | Disables the `shell` module. | +| Параметр | По умолчанию | Описание | +| ---------------------- | ------------ | ------------------------------------------------------------ | +| `bash_indicator` | `bsh` | A format string used to represent bash. | +| `fish_indicator` | `fsh` | A format string used to represent fish. | +| `zsh_indicator` | `zsh` | A format string used to represent zsh. | +| `powershell_indicator` | `psh` | A format string used to represent powershell. | +| `ion_indicator` | `ion` | A format string used to represent ion. | +| `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | +| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `format` | `$indicator` | Формат модуля. | +| `disabled` | `true` | Disables the `shell` module. | ### Переменные @@ -2335,6 +2356,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [shell] fish_indicator = "" powershell_indicator = "_" +unknown_indicator = "mystery shell" disabled = false ``` @@ -2361,7 +2383,7 @@ The `shlvl` module shows the current `SHLVL` ("shell level") environment variabl | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -2376,7 +2398,7 @@ threshold = 3 ## Singularity -The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Опции @@ -2391,11 +2413,11 @@ The `singularity` module shows the current singularity image, if inside a contai | Переменная | Пример | Описание | | ---------- | ------------ | ------------------------------------ | -| env | `centos.img` | The current singularity image | +| env | `centos.img` | The current Singularity image | | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -2412,7 +2434,7 @@ The `status` module displays the exit code of the previous command. The module w ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. ::: @@ -2446,7 +2468,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -2465,22 +2487,23 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). Модуль будет показан, если любое из следующих условий соблюдено: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | ------------------------------------ | ------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | -| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | -| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 202"` | Стиль модуля. | -| `disabled` | `false` | Disables the `swift` module. | +| Параметр | По умолчанию | Описание | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | +| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold 202"` | Стиль модуля. | +| `disabled` | `false` | Disables the `swift` module. | ### Переменные @@ -2490,7 +2513,7 @@ By default the `swift` module shows the currently installed version of Swift. Th | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -2503,45 +2526,46 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: 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). +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-terraform-version). ::: By default the module will be shown if any of the following conditions are met: -- The current directory contains a `.terraform` folder +- Текущий каталог содержит папку `.terraform` - Current directory contains a file with the `.tf` or `.hcl` extensions ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | -| `symbol` | `"💠"` | A format string shown before the terraform workspace. | -| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | -| `style` | `"bold 105"` | Стиль модуля. | -| `disabled` | `false` | Disables the `terraform` module. | +| Параметр | По умолчанию | Описание | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | +| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | +| `style` | `"bold 105"` | Стиль модуля. | +| `disabled` | `false` | Отключает модуль `terraform`. | ### Переменные | Переменная | Пример | Описание | | ---------- | ---------- | ------------------------------------ | | version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current terraform workspace | +| workspace | `default` | The current Terraform workspace | | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример -#### With Version +#### With Terraform Version ```toml # ~/.config/starship.toml @@ -2550,7 +2574,7 @@ By default the module will be shown if any of the following conditions are met: format = "[🏎💨 $version$workspace]($style) " ``` -#### Without version +#### Without Terraform version ```toml # ~/.config/starship.toml @@ -2561,36 +2585,36 @@ 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 -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. ::: ### Опции -| Параметр | По умолчанию | Описание | -| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `format` | `"at [$time]($style) "` | The format string for the module. | -| `use_12hr` | `false` | Enables 12 hour formatting | -| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | -| `style` | `"bold yellow"` | The style for the module time | -| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | -| `disabled` | `true` | Disables the `time` module. | -| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| Параметр | По умолчанию | Описание | +| ----------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `"at [$time]($style) "` | The format string for the module. | +| `use_12hr` | `false` | Включить 12-часовое форматирование | +| `time_format` | см. ниже | [Строка формата chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html), используемая для форматирования времени. | +| `style` | `"bold yellow"` | Стиль модуля времени | +| `utc_time_offset` | `"local"` | Устанавливает смещение UTC. Range from -24 < x < 24. Разрешает числам с плавающей точкой встраивать 30/45-минутное смещение временной зоны. | +| `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. ### Переменные | Переменная | Пример | Описание | | ---------- | ---------- | ----------------------------------- | -| time | `13:08:10` | The current time. | +| время | `13:08:10` | The current time. | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -2605,14 +2629,14 @@ utc_time_offset = "-5" time_range = "10:00:00-14:00:00" ``` -## Username +## Имя пользователя -The `username` module shows active user's username. The module will be shown if any of the following conditions are met: +Модуль `username` показывает имя текущего пользователя. Модуль будет показан, если любое из следующих условий соблюдено: -- The current user is root -- The current user isn't the same as the one that is logged in -- The user is currently connected as an SSH session -- The variable `show_always` is set to true +- Текущий пользователь - root +- Текущий пользователь отличается от залогиненного +- Пользователь подключен к SSH-сессии +- Переменная `show_always` равна true ::: tip @@ -2622,13 +2646,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### Опции -| Параметр | По умолчанию | Описание | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `style_user` | `"bold yellow"` | The style used for non-root users. | -| `format` | `"[$user]($style) in "` | Формат модуля. | -| `show_always` | `false` | Always shows the `username` module. | -| `disabled` | `false` | Disables the `username` module. | +| Параметр | По умолчанию | Описание | +| ------------- | ----------------------- | ------------------------------------------------------- | +| `style_root` | `"bold red"` | Стиль, используемый для пользователя root. | +| `style_user` | `"bold yellow"` | Стиль, используемый для всех пользователей, кроме root. | +| `format` | `"[$user]($style) in "` | Формат модуля. | +| `show_always` | `false` | Всегда показывать модуль `username`. | +| `disabled` | `false` | Отключает модуль `username`. | ### Переменные @@ -2652,21 +2676,22 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Vagrantfile` file ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | ------------------------------------ | --------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | -| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"cyan bold"` | Стиль модуля. | -| `disabled` | `false` | Disables the `vagrant` module. | +| Параметр | По умолчанию | Описание | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"cyan bold"` | Стиль модуля. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Переменные @@ -2676,7 +2701,7 @@ The `vagrant` module shows the currently installed version of Vagrant. By defaul | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -2689,7 +2714,7 @@ format = "via [⍱ $version](bold white) " ## VCSH -The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### Опции @@ -2708,7 +2733,7 @@ The `vcsh` module displays the current active VCSH repository. The module will b | symbol | | Отражает значение параметра `symbol` | | style\* | `black bold dimmed` | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -2721,21 +2746,22 @@ format = "[🆅 $repo](bold blue) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). Модуль будет показан, если любое из следующих условий соблюдено: - The current directory contains a `.zig` file ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | -| `style` | `"bold yellow"` | Стиль модуля. | -| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | -| `disabled` | `false` | Disables the `zig` module. | -| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Параметр | По умолчанию | Описание | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | +| `style` | `"bold yellow"` | Стиль модуля. | +| `disabled` | `false` | Disables the `zig` module. | +| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Переменные @@ -2745,7 +2771,7 @@ By default the the `zig` module shows the currently installed version of Zig. Th | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style ### Пример @@ -2792,7 +2818,7 @@ The order in which custom modules are shown can be individually set by including | `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | | `shell` | | [See below](#custom-command-shell) | -| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `описание` | `""` | The description of the module that is shown when running `starship explain`. | | `files` | `[]` | The files that will be searched in the working directory for a match. | | `directories` | `[]` | The directories that will be searched in the working directory for a match. | | `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | @@ -2809,7 +2835,7 @@ The order in which custom modules are shown can be individually set by including | symbol | Отражает значение параметра `symbol` | | style\* | Отражает значение параметра `style` | -\*: This variable can only be used as a part of a style string +\*: Эта переменная может использоваться только в качестве части строки style #### Custom command shell diff --git a/docs/tr-TR/README.md b/docs/tr-TR/README.md index 01b74b57..dd293bc2 100644 --- a/docs/tr-TR/README.md +++ b/docs/tr-TR/README.md @@ -28,7 +28,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p -### Prerequisites +### Ön koşullar - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal. diff --git a/docs/tr-TR/config/README.md b/docs/tr-TR/config/README.md index b3e5c834..267c5852 100644 --- a/docs/tr-TR/config/README.md +++ b/docs/tr-TR/config/README.md @@ -3,7 +3,7 @@ To get started configuring starship, create the following file: `~/.config/starship.toml`. ```sh -mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml +mkdir -p ~/.config && touch ~/.config/starship.toml ``` All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: @@ -49,9 +49,9 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ### Terminology -**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project. +**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project. -**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of NodeJS. +**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js. By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix. @@ -384,7 +384,7 @@ The character will tell you whether the last command was successful or not. It c - changing color (`red`/`green`) - changing shape (`❯`/`✖`) -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). +By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). ::: warning `error_symbol` is not supported on elvish shell. ::: @@ -437,22 +437,23 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met: +The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met: - The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeCache.txt` file ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `cmake` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"△ "` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `cmake` module. | ### Variables @@ -555,22 +556,23 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met: +The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `shard.yml` file - The current directory contains a `.cr` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | --------------------------------------------------------- | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | -| `style` | `"bold red"` | The style for the module. | -| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | -| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `crystal` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `"bold red"` | The style for the module. | +| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | +| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `disabled` | `false` | Disables the `crystal` module. | ### Variables @@ -593,7 +595,7 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory @@ -601,15 +603,16 @@ The `dart` module shows the currently installed version of Dart. By default the ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | -| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `dart` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | +| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. | +| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `dart` module. | ### Variables @@ -632,20 +635,21 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of Deno. By default the module will be shown if any of the following conditions are met: +The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"green bold"` | The style for the module. | -| `disabled` | `false` | Disables the `deno` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"green bold"` | The style for the module. | +| `disabled` | `false` | Disables the `deno` module. | ### Variables @@ -764,7 +768,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -786,16 +790,17 @@ The module will also show the Target Framework Moniker ( ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager. @@ -1949,7 +1965,7 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file @@ -1959,15 +1975,16 @@ The `perl` module shows the currently installed version of Perl. By default the ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | -| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | -| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | -| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 149"` | The style for the module. | -| `disabled` | `false` | Disables the `perl` module. | +| Option | Default | Description | **** | +| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- | +| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | +| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | +| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | | +| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | | +| `detect_folders` | `[]` | Which folders should trigger this module. | | +| `style` | `"bold 149"` | The style for the module. | | +| `disabled` | `false` | Disables the `perl` module. | | ### Variables @@ -1988,7 +2005,7 @@ format = "via [🦪 $version]($style) " ## PHP -The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `composer.json` file - The current directory contains a `.php-version` file @@ -1996,15 +2013,16 @@ The `php` module shows the currently installed version of PHP. By default the mo ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | -| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | -| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"147 bold"` | The style for the module. | -| `disabled` | `false` | Disables the `php` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | +| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"147 bold"` | The style for the module. | +| `disabled` | `false` | Disables the `php` module. | ### Variables @@ -2027,22 +2045,23 @@ format = "via [🔹 $version](147 bold) " ## PureScript -The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: - The current directory contains a `spago.dhall` file - The current directory contains a file with the `.purs` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | -| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold white"` | The style for the module. | -| `disabled` | `false` | Disables the `purescript` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | +| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold white"` | The style for the module. | +| `disabled` | `false` | Disables the `purescript` module. | ### Variables @@ -2065,7 +2084,7 @@ format = "via [$symbol$version](bold white)" ## Python -The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. @@ -2092,7 +2111,7 @@ By default the module will be shown if any of the following conditions are met: | `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | -| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | +| `detect_extensions` | `["py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | @@ -2143,7 +2162,7 @@ detect_extensions = [] ## Red -By default the `red` module shows the currently installed version of Red. The module will be shown if any of the following conditions are met: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a file with `.red` or `.reds` extension @@ -2181,7 +2200,7 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Gemfile` file - The current directory contains a `.ruby-version` file @@ -2221,7 +2240,7 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Cargo.toml` file - The current directory contains a file with the `.rs` extension @@ -2260,7 +2279,7 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension @@ -2268,15 +2287,16 @@ The `scala` module shows the currently installed version of Scala. By default th ### Options -| Option | Default | Description | -| ------------------- | ---------------------------------------- | ------------------------------------------------- | -| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | -| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | -| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | -| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | -| `style` | `"red dimmed"` | The style for the module. | -| `disabled` | `false` | Disables the `scala` module. | +| Option | Default | Description | +| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `style` | `"red dimmed"` | The style for the module. | +| `disabled` | `false` | Disables the `scala` module. | ### Variables @@ -2309,17 +2329,18 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ### Options -| Option | Default | Description | -| ---------------------- | ------------ | --------------------------------------------- | -| `bash_indicator` | `bsh` | A format string used to represent bash. | -| `fish_indicator` | `fsh` | A format string used to represent fish. | -| `zsh_indicator` | `zsh` | A format string used to represent zsh. | -| `powershell_indicator` | `psh` | A format string used to represent powershell. | -| `ion_indicator` | `ion` | A format string used to represent ion. | -| `elvish_indicator` | `esh` | A format string used to represent elvish. | -| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | -| `format` | `$indicator` | The format for the module. | -| `disabled` | `true` | Disables the `shell` module. | +| Option | Default | Description | +| ---------------------- | ------------ | ------------------------------------------------------------ | +| `bash_indicator` | `bsh` | A format string used to represent bash. | +| `fish_indicator` | `fsh` | A format string used to represent fish. | +| `zsh_indicator` | `zsh` | A format string used to represent zsh. | +| `powershell_indicator` | `psh` | A format string used to represent powershell. | +| `ion_indicator` | `ion` | A format string used to represent ion. | +| `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | +| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `format` | `$indicator` | The format for the module. | +| `disabled` | `true` | Disables the `shell` module. | ### Variables @@ -2335,6 +2356,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [shell] fish_indicator = "" powershell_indicator = "_" +unknown_indicator = "mystery shell" disabled = false ``` @@ -2376,7 +2398,7 @@ threshold = 3 ## Singularity -The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Options @@ -2391,7 +2413,7 @@ The `singularity` module shows the current singularity image, if inside a contai | Variable | Example | Description | | --------- | ------------ | ------------------------------------ | -| env | `centos.img` | The current singularity image | +| env | `centos.img` | The current Singularity image | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2465,22 +2487,23 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | -| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 202"` | The style for the module. | -| `disabled` | `false` | Disables the `swift` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | +| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold 202"` | The style for the module. | +| `disabled` | `false` | Disables the `swift` module. | ### Variables @@ -2503,11 +2526,11 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: 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). +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-terraform-version). ::: @@ -2518,22 +2541,23 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | -| `symbol` | `"💠"` | A format string shown before the terraform workspace. | -| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | -| `style` | `"bold 105"` | The style for the module. | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | +| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | +| `style` | `"bold 105"` | The style for the module. | +| `disabled` | `false` | Disables the `terraform` module. | ### Variables | Variable | Example | Description | | --------- | ---------- | ------------------------------------ | | version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current terraform workspace | +| workspace | `default` | The current Terraform workspace | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2541,7 +2565,7 @@ By default the module will be shown if any of the following conditions are met: ### Example -#### With Version +#### With Terraform Version ```toml # ~/.config/starship.toml @@ -2550,7 +2574,7 @@ By default the module will be shown if any of the following conditions are met: format = "[🏎💨 $version$workspace]($style) " ``` -#### Without version +#### Without Terraform version ```toml # ~/.config/starship.toml @@ -2652,21 +2676,22 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default 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. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"cyan bold"` | The style for the module. | -| `disabled` | `false` | Disables the `vagrant` module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2689,7 +2714,7 @@ format = "via [⍱ $version](bold white) " ## VCSH -The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### Options @@ -2721,21 +2746,22 @@ format = "[🆅 $repo](bold blue) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `.zig` file ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | -| `style` | `"bold yellow"` | The style for the module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `zig` module. | -| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `false` | Disables the `zig` module. | +| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables diff --git a/docs/tr-TR/guide/README.md b/docs/tr-TR/guide/README.md index 4d59303f..fef55d8b 100644 --- a/docs/tr-TR/guide/README.md +++ b/docs/tr-TR/guide/README.md @@ -141,7 +141,7 @@ ## 🚀 Installation -### Prerequisites +### Ön koşullar - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (for example, try the [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)). diff --git a/docs/vi-VN/README.md b/docs/vi-VN/README.md index d9c91323..de924fc7 100644 --- a/docs/vi-VN/README.md +++ b/docs/vi-VN/README.md @@ -32,7 +32,7 @@ description: Starship là prompt nhỏ, cực nhanh, và khả năng tuỳ biế - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal. -### Quick Install +### Cài đặt nhanh chóng 1. Cài đặt **starship** nhị phân: diff --git a/docs/vi-VN/advanced-config/README.md b/docs/vi-VN/advanced-config/README.md index c0e19899..67bfd221 100644 --- a/docs/vi-VN/advanced-config/README.md +++ b/docs/vi-VN/advanced-config/README.md @@ -81,7 +81,7 @@ Chuỗi kiểu là một danh sách các từ, được phân cách bởi khoả - `` - `none` -`` là một nơi quy định màu (được bàn luận ở phía dưới). `fg:` and `` currently do the same thing, though this may change in the future. `inverted` swaps the background and foreground colors. The order of words in the string does not matter. +`` là một nơi quy định màu (được bàn luận ở phía dưới). `fg:` and `` currently do the same thing, though this may change in the future. `inverted` swaps the background and foreground colors. Thứ tự các từ trong chuỗi là không quan trọng. Từ mã `none` ghi đè tất cả các từ mã khác trong chuỗi nếu nó không là một phần của `bg:` specifier, vậy nên `fg:red none fg:blue` sẽ vẫn tạo một chuỗi mà không có kiểu. `bg:none` sets the background to the default color so `fg:red bg:none` is equivalent to `red` or `fg:red` and `bg:green fg:red bg:none` is also equivalent to `fg:red` or `red`. Nó có thể trở thành một lỗi để sử dụng `none` trong việc kết hợp với các từ mã khác trong tương lai. diff --git a/docs/vi-VN/config/README.md b/docs/vi-VN/config/README.md index 09908c3a..9c9efb9c 100644 --- a/docs/vi-VN/config/README.md +++ b/docs/vi-VN/config/README.md @@ -3,7 +3,7 @@ Để bắt đầu cấu hình starship, tạo tập tin sau: `~/.config/starship.toml`. ```sh -mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml +mkdir -p ~/.config && touch ~/.config/starship.toml ``` Tất cả cấu hình của starship đã xong trong tập tin này: [TOML](https://github.com/toml-lang/toml): @@ -49,9 +49,9 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ### Thuật ngữ -**Module**: Một thành phần trong prompt, thông tin lấy được dựa trên thông tin ngữ cảnh từ hệ điều hành của bạn. Cho ví dụ, module "nodejs" cho biết phiên bản của NodeJS, cái hiện tại được cài đặt trên máy tính của bạn, nếu đường dẫn hiện tại của bạn là một dự án NodeJS. +**Module**: Một thành phần trong prompt, thông tin lấy được dựa trên thông tin ngữ cảnh từ hệ điều hành của bạn. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project. -**Variable**: Các thành phần con nhỏ hơn chứa thông tin cung cấp bởi module. Cho ví dụ, biến "version" trong "nodejs" module chứa phiên bản hiện tại của NodeJS. +**Variable**: Các thành phần con nhỏ hơn chứa thông tin cung cấp bởi module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js. Bằng việc quy ước, đa số các module có một tiền tố của terminal mặc định (ví dụ `via` trong "nodejs") và một khoảng trắng như là một hậu tố. @@ -147,7 +147,7 @@ Cái này là danh sách các tuỳ chọn cho cấu hình prompt-wide. | `format` | [link](#default-prompt-format) | Cấu hình định dạng của prompt. | | `scan_timeout` | `30` | Timeout của starship cho việc quét các tập tin (tính theo milliseconds). | | `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). | -| `add_newline` | `true` | Inserts blank line between shell prompts. | +| `add_newline` | `true` | Chèn dòng trắng giữa các dấu nhắc lệnh. | ### Ví dụ @@ -265,7 +265,7 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Các vị dụ @@ -310,7 +310,7 @@ symbol = "🅰 " ## Battery -The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. +`battery` module cho biết cách sạc pin của thiết bị là gì và tình trạng sạc hiện tại của nó. Module chỉ được nhìn thấy khi pin của thiết bị dưới 10%. ### Các tuỳ chọn @@ -338,7 +338,7 @@ discharging_symbol = "💀 " ### Hiển thị pin -The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). If no `display` is provided. Mặc định như sau: +The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). Nếu `display` không được cung cấp. Mặc định như sau: ```toml [[battery.display]] @@ -350,12 +350,12 @@ The default value for the `charging_symbol` and `discharging_symbol` option is r #### Các tuỳ chọn -The `display` option is an array of the following table. +Tuỳ chọn `display` là một mảng của của bảng sau. | Tuỳ chọn | Mặc định | Mô tả | | -------------------- | ---------- | --------------------------------------------------------------------------------------------------------- | -| `threshold` | `10` | The upper bound for the display option. | -| `style` | `bold red` | The style used if the display option is in use. | +| `threshold` | `10` | Cận trên cho tuỳ chọn hiển thị. | +| `style` | `bold red` | Kiểu sử dụng nếu tuỳ chọn hiển thị được sử dụng bên trong. | | `charging_symbol` | `-` | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. | | `discharging_symbol` | `-` | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. | @@ -377,16 +377,16 @@ discharging_symbol = 💦 ## Character -The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. +Module `character` cho biết một kí tự (thường là một mũi tên) bên cạnh nơi văn bản được nhập trong terminal của bạn. -The character will tell you whether the last command was successful or not. It can do this in two ways: +Kí tự sẽ nói cho bạn câu lệnh cuối liệu thành công hay thất bại. Nó có thể làm điều này bằng hai cách: - thay đổi màu(`đỏ`/`xanh lá`) - thay đổi hình dạng (`❯`/`✖`) -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). +Mặc định, nó chỉ thay đổi màu. If you also want to change its shape take a look at [this example](#with-custom-error-shape). -::: warning `error_symbol` is not supported on elvish shell. ::: +::: warning `error_symbol` không được hỗ trợ trên elvish shell. ::: ### Các tuỳ chọn @@ -437,22 +437,23 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met: +The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). Mặc định module sẽ được kích hoạt nếu thoả mãn bất kì điều kiện nào dưới đây: - Đường dẫn hiện tại chứa một tập tin `CmakeLists.txt` - Đường dẫn hiện tại chứa một tập tin `CMakeCache.txt` ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | -------------------------------------- | -------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | -| `symbol` | `"△ "` | Kí hiệu sử dụng trước phiên bản của cmake. | -| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Tên tệp nào sẽ kích hoạt mô-đun này | -| `detect_folders` | `[]` | Thư mục nào sẽ kích hoạt mô-đun này | -| `style` | `"bold blue"` | Kiểu cho module. | -| `disabled` | `false` | Vô hiệu hoá `cmake` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"△ "` | Kí hiệu sử dụng trước phiên bản của cmake. | +| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Tên tệp nào sẽ kích hoạt mô-đun này | +| `detect_folders` | `[]` | Thư mục nào sẽ kích hoạt mô-đun này | +| `style` | `"bold blue"` | Kiểu cho module. | +| `disabled` | `false` | Vô hiệu hoá `cmake` module. | ### Các biến @@ -462,19 +463,19 @@ The `cmake` module shows the currently installed version of CMake. By default th | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ## Command Duration -The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. +Module `cmd_duration`. cho biết câu lệnh cuối cùng thực thi trong bao lâu. Module sẽ được hiện chỉ khi câu lệnh lấy nhiều hơn 2 giây, hoặc giá trị cấu hình `min_time`, nếu nó tồn tại. -::: warning Do not hook the DEBUG trap in Bash +::: cảnh báo Không thể hook DEBUG trap trong Bash -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. +Nếu bạn đang chạy Starship trong `bash`, không thể hook `DEBUG` trap sau khi chạy `eval $(starship init $0)`, hoặc module này **sẽ** ngắt. ::: -Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. +Người dùng Bash, những người cần chức năng giống preexec có thể sử dụng [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Đơn giản là định nghĩa các mảng `preexec_functions` và `precmd_functions` trước khi chạy `eval $(starship init $0)`, và sau đó thực thi như bình thường. ### Các tuỳ chọn @@ -488,9 +489,9 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec | `show_notifications` | `false` | Hiện thông báo desktop khi câu lệnh hoàn thành. | | `min_time_to_notify` | `45_000` | Khoảng thời gian ngắn nhất để thông báo (tính bằng milliseconds). | -::: tip +::: thử thuật -Showing desktop notifications requires starship to be built with `rust-notify` support. You check if your starship supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `true`. +Hiện thông báo desktop yêu cầu starship được built với sự hỗ trợ của `rust-notify`. Bạn kiểm tra nếu starship hỗ trợ các thông báo bằng cách chạy `STARSHIP_LOG=debug starship module cmd_duration -d 60000` khi `show_notifications` được thiết lập là `true`. ::: @@ -501,7 +502,7 @@ Showing desktop notifications requires starship to be built with `rust-notify` s | duration | `16m40s` | Thời gian nó lấy để thực thi câu lệnh | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -515,11 +516,11 @@ format = "underwent [$duration](bold yellow)" ## Conda -The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. +Module `conda` cho biết môi trường conda hiện tại, nếu `$CONDA_DEFAULT_ENV` được thiết lập. -::: tip +::: thử thuật -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. +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`. ::: @@ -542,7 +543,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -555,22 +556,23 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -The `crystal` module shows the currently installed version of Crystal. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). Mặc định module sẽ được hiển thị nếu có 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` ### Options -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `symbol` | `"🔮 "` | Kí hiệu sử dụng trước phiên bản hiển thị của crystal. | -| `style` | `"bold red"` | Kiểu cho module. | -| `detect_extensions` | `["cr"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `["shard.yml"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | -| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | -| `disabled` | `false` | Vô hiệu hoá module `crystal`. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `symbol` | `"🔮 "` | Kí hiệu sử dụng trước phiên bản hiển thị của crystal. | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `"bold red"` | Kiểu cho module. | +| `detect_extensions` | `["cr"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `["shard.yml"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | +| `disabled` | `false` | Vô hiệu hoá module `crystal`. | ### Các biến @@ -580,7 +582,7 @@ The `crystal` module shows the currently installed version of Crystal. Mặc đ | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -593,7 +595,7 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of Dart. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). Mặc định module sẽ được hiển thị nếu có 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 với phần mở rộng `.dart` - Đường dẫn hiện tại chứa một đường dẫn `.dart_tool` @@ -601,15 +603,16 @@ The `dart` module shows the currently installed version of Dart. Mặc định m ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ------------------------------------------------- | --------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | -| `symbol` | `"🎯 "` | Một chuỗi định dạng hiển thị biểu tượng của Dart | -| `detect_extensions` | `['dart']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Những tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[".dart_tool"]` | Những thư mục nào sẽ kích hoạt mô-đun này. | -| `style` | `"bold blue"` | Kiểu cho module. | -| `disabled` | `false` | Vô hiệu `dart` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🎯 "` | Một chuỗi định dạng hiển thị biểu tượng của Dart | +| `detect_extensions` | `["dart"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[".dart_tool"]` | Những thư mục nào sẽ kích hoạt mô-đun này. | +| `style` | `"bold blue"` | Kiểu cho module. | +| `disabled` | `false` | Vô hiệu `dart` module. | ### Các biến @@ -619,7 +622,7 @@ The `dart` module shows the currently installed version of Dart. Mặc định m | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -632,20 +635,21 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of Deno. By default the module will be shown if any of the following conditions are met: +The `deno` module shows you your currently installed version of [Deno](https://deno.land/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: - The current directory contains a `mod.ts`, `mod.js`, `deps.ts` or `deps.js` 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 Deno | -| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | -| `style` | `"green bold"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `deno` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | +| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | +| `style` | `"green bold"` | Kiểu cho module. | +| `disabled` | `false` | Disables the `deno` module. | ### Các biến @@ -666,30 +670,30 @@ format = "via [🦕 $version](green bold) " ## Đường dẫn -The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. +`directory` module hiển thị đường dẫn thư mục hiện hành của bạn,, cắt ngắn ba thư mục cha. Đường dẫn của bạn cũng sẽ được cắt ngắn tới đường dẫn gốc của git repo hiện tại của bạn. -When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. +Khi sử dụng fish style pwd option, thay vì ẩn đường dẫn được rút gọn, bạn sẽ thấy một tên ngắn cho mỗi thư mục dựa trên số bạn cho phép trng tùy chọn. -For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. +Cho ví dụ, `~/Dev/Nix/nixpkgs/pkgs` nơi `nixpkgs` là gốc của repo, và tuỳ chọn thiết lập sang `1`. Bây giờ bạn sẽ thấy `~/D/N/nixpkgs/pkgs`, trong khi trước nó là `nixpkgs/pkgs`. ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- | -| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | -| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | -| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | Định dạng cho module. | -| `style` | `"bold cyan"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `directory` module. | -| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | -| `read_only_style` | `"red"` | The style for the read only symbol. | -| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | -| `home_symbol` | `"~"` | The symbol indicating home directory. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------ | +| `truncation_length` | `3` | Số lượng thư mục cha của thư mục hiện tại nên được rút gọn. | +| `truncate_to_repo` | `true` | Có hoặc không rút gọn đường dẫn gốc của git repo hiện tại của bạn. | +| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | Định dạng cho module. | +| `style` | `"bold cyan"` | Kiểu cho module. | +| `disabled` | `false` | Vô hiệu mô đun `directory`. | +| `read_only` | `"🔒"` | Biểu tượng để nhận biết thư mục hiện tại là chỉ đọc. | +| `read_only_style` | `"red"` | Style cho biểu tượng chỉ đọc. | +| `truncation_symbol` | `""` | Biểu tượng tiền tố cho các đường dẫn rút gọn. ví dụ: "…/" | +| `home_symbol` | `"~"` | Biểu tượng nhận biết thư mục home. |
-This module has a few advanced configuration options that control how the directory is displayed. +Mô đun này có một vài tùy chọn nâng cao để điều khiển cách thư mục được hiển thị. -| Advanced Option | Mặc định | Mô tả | +| Tùy chọn nâng cao | Mặc định | Mô tả | | --------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `substitutions` | | A table of substitutions to be made to the path. | | `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | @@ -711,10 +715,10 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | Biến | Ví dụ | Mô tả | | --------- | --------------------- | -------------------------- | -| path | `"D:/Projects"` | The current directory path | +| path | `"D:/Projects"` | Đường dẫn thư mục hiện tại | | style\* | `"black bold dimmed"` | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -728,30 +732,30 @@ truncation_symbol = "…/" ## Docker Context -The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default`. +Mô đun `docker_context` hiển thị [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) hiện tại được kích hoạt nếu nó không được thiết lập `mặc định`. ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `"via [$symbol$context]($style) "` | Định dạng cho module. | -| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | -| `only_with_files` | `true` | Only show when there's a match | -| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). | -| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). | -| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). | -| `style` | `"blue bold"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `docker_context` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol$context]($style) "` | Định dạng cho module. | +| `symbol` | `"🐳 "` | Biểu tượng sử dụng để hiển thị trước Docker context. | +| `only_with_files` | `true` | Chỉ hiển thị khi có một tệp tin khớp | +| `detect_extensions` | `[]` | Các mở rộng nào nên kích hoạt mô đun này (cần `only_with_files` thiết lập là true). | +| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Tên tệp tin nào nên kích hoạt mô đun này (cần `only_with_files` được thiết lập là true). | +| `detect_folders` | `[]` | Thư mục nào nên kích hoạt mô đun này (cần `only_with_files` được thiết lập là true). | +| `style` | `"blue bold"` | Kiểu cho module. | +| `disabled` | `false` | Vô hiệu mô đun `docker_context`. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | -------------- | -------------------------------- | -| context | `test_context` | The current docker context | +| context | `test_context` | Docker context hiện tại | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -764,9 +768,9 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. Nếu SDK được ghim trong thư mục hiện tại, phiên bản ghim đó được hiển thị. Ngược lại, mô đun hiển thị phiên bản cuối cùng của SDK được cài đặt. -By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: +Mặc định, mô đun này sẽ chỉ được hiển thị trong dấu nhắc lệnh của bạn khi một hoặc nhiều tệp tin dưới đây xuất hiện trong thư mục hiện tại: - `global.json` - `project.json` @@ -778,35 +782,36 @@ By default this module will only be shown in your prompt when one or more of the - `*.fsproj` - `*.xproj` -You'll also need the .NET Core SDK installed in order to use it correctly. +Bạn cũng sẽ cần cài đặt .NET Core SDK đúng cách để sử dụng một cách chính xác. -Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. +Mô đun này sử dụng cơ chế của bản thân để phát hiện phiên bản của chính nó. Thông thường, nó nhanh gấp đôi nếu chạy `dotnet --version`, nhưng nó có thể hiện sai phiên bản nếu dự án .NET của bạn có một cấu trúc thư mục bất thường. Nếu độ chính xác quan trọng hơn tốc độ, bạn có thể vô hiệu cơ chế bằng cài đặt `heuristic = false` trong các tùy chọn mô đun. -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +Mô đun cũng sẽ hiện Target Framework Moniker () khi có một tệp tin csproj trong thư mục hiện tại. ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | Định dạng cho module. | -| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. | -| `heuristic` | `true` | Use faster version detection to keep starship snappy. | -| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. | -| `style` | `"bold blue"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `dotnet` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | Định dạng cho module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `".NET "` | Biểu tượng sử dụng để hiển thị trước phiên bản của dotnet. | +| `heuristic` | `true` | Sử dụng phiên bản phát hiện thông minh hơn. | +| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. | +| `style` | `"bold blue"` | Kiểu cho module. | +| `disabled` | `false` | Vô hiệu mô đun `dotnet`. | ### Các biến -| Biến | Ví dụ | Mô tả | -| --------- | ---------------- | ------------------------------------------------------------------ | -| version | `v3.1.201` | The version of `dotnet` sdk | -| tfm | `netstandard2.0` | The Target Framework Moniker that the current project is targeting | -| symbol | | Giá trị ghi đè tuỳ chọn `symbol` | -| style\* | | Giá trị ghi đè của `style` | +| Biến | Ví dụ | Mô tả | +| --------- | ---------------- | ------------------------------------------------------------- | +| version | `v3.1.201` | Phiên bản của `dotnet` sdk | +| tfm | `netstandard2.0` | Target Framework Monike của dự án hiện tại đang được nhắm đến | +| symbol | | Giá trị ghi đè tuỳ chọn `symbol` | +| style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -821,32 +826,33 @@ heuristic = false ## Elixir -The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `elixir` module shows the currently installed version of [Elixir](https://elixir-lang.org/) and [Erlang/OTP](https://erlang.org/doc/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: -- The current directory contains a `mix.exs` file. +- Đường dẫn hiện tại chứa một tập tin `mix.exs`. ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------- | -| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | -| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `["mix.exs"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. | -| `style` | `"bold purple"` | Kiểu cho module. | -| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | -| `disabled` | `false` | Disables the `elixir` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | Định dạng cho module elixir. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💧 "` | Kí hiệu sử dụng trước phiên bản hiển thị của Elixir/Erlang. | +| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `["mix.exs"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. | +| `style` | `"bold purple"` | Kiểu cho module. | +| `disabled` | `false` | Vô hiệu mô đun `elixir`. | ### Các biến | Biến | Ví dụ | Mô tả | | ----------- | ------- | -------------------------------- | -| version | `v1.10` | The version of `elixir` | -| otp_version | | The otp version of `elixir` | +| version | `v1.10` | Phiên bản của `elixir` | +| otp_version | | Phiên bản otp của `elixir` | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -859,35 +865,36 @@ symbol = "🔮 " ## Elm -The `elm` module shows the currently installed version of Elm. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `elm` module shows the currently installed version of [Elm](https://elm-lang.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: -- The current directory contains a `elm.json` file -- The current directory contains a `elm-package.json` file -- The current directory contains a `.elm-version` file -- The current directory contains a `elm-stuff` folder -- The current directory contains a `*.elm` files +- Đường dẫn hiện tại chứa một tập tin `elm.json` +- Đường dẫn hiện tại chứa một tập tin `elm-package.json` +- Đường dẫn hiện tại chứa một tệp tin `.elm-version` +- Đường dẫn hiện tại chứa một thư mục `elm-stuff` +- Đường dẫn hiện tại chứa một tập tin `*.elm` ### 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 Elm. | -| `detect_extensions` | `["elm"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `["elm-stuff"]` | Những thư mục nào nên kích hoạt các mô đun này. | -| `style` | `"cyan bold"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `elm` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🌳 "` | Một format string đại diện cho biểu tượng của Elm. | +| `detect_extensions` | `["elm"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `["elm-stuff"]` | Những thư mục nào nên kích hoạt các mô đun này. | +| `style` | `"cyan bold"` | Kiểu cho module. | +| `disabled` | `false` | Vô hiệu mô đun `elm`. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | --------- | -------------------------------- | -| version | `v0.19.1` | The version of `elm` | +| version | `v0.19.1` | Phiên bản của `elm` | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -900,30 +907,30 @@ format = "via [ $version](cyan bold) " ## Biến môi trường -The `env_var` module displays the current value of a selected environment variable. The module will be shown only if any of the following conditions are met: +Mô đun `env_var` hiển thị giá trị hiện tại của biến môi trường được chọn. Mô đun sẽ được hiển thị chỉ khi bất kì điều kiện nào sau đây thỏa mãn: -- The `variable` configuration option matches an existing environment variable -- The `variable` configuration option is not defined, but the `default` configuration option is +- Tùy chọn `variable` khớp với mootjj biến môi trường tồn tại +- Tùy chọn `variable` không được định nghĩa, nhưng tùy chọn `default` là ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `symbol` | | The symbol used before displaying the variable value. | -| `variable` | | The environment variable to be displayed. | -| `default` | | The default value to be displayed when the selected variable is not defined. | -| `format` | `"with [$env_value]($style) "` | Định dạng cho module. | -| `disabled` | `false` | Disables the `env_var` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ---------- | ------------------------------ | ------------------------------------------------------------------------ | +| `symbol` | | Biểu tượng sử dụng để hiển thị trước giá trị của biến. | +| `variable` | | Biến môi trường được hiển thị. | +| `default` | | Giá trị mặc định được hiển thị khi biến được chọn không được định nghĩa. | +| `format` | `"with [$env_value]($style) "` | Định dạng cho module. | +| `disabled` | `false` | Vô hiệu `env_var`. | ### Các biến -| Biến | Ví dụ | Mô tả | -| --------- | ------------------------------------------- | ------------------------------------------ | -| env_value | `Windows NT` (if _variable_ would be `$OS`) | The environment value of option `variable` | -| symbol | | Giá trị ghi đè tuỳ chọn `symbol` | -| style\* | `black bold dimmed` | Giá trị ghi đè của `style` | +| Biến | Ví dụ | Mô tả | +| --------- | ----------------------------------------- | ----------------------------------------------- | +| env_value | `Windows NT` (nếu _variable_ sẽ là `$OS`) | Giá trị biến môi trường của tùy chọn `variable` | +| symbol | | Giá trị ghi đè tuỳ chọn `symbol` | +| style\* | `black bold dimmed` | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -937,22 +944,23 @@ default = "unknown shell" ## Erlang -The `erlang` module shows the currently installed version of Erlang/OTP. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `erlang` module shows the currently installed version of [Erlang/OTP](https://erlang.org/doc/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: -- The current directory contains a `rebar.config` file. -- The current directory contains a `erlang.mk` file. +- Đường dẫn hiện tại chứa một tập tin `rebar.config`. +- Đường dẫn hiện tại chứa một tập tin `erlang.mk`. ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ------------------------------------ | -------------------------------------------------------- | -| `symbol` | `" "` | The symbol used before displaying the version of erlang. | -| `style` | `"bold red"` | Kiểu cho module. | -| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `["rebar.config", "elang.mk"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. | -| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | -| `disabled` | `false` | Disables the `erlang` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | Biểu tượng sử dụng để hiển thị trước phiên bản của erlang. | +| `style` | `"bold red"` | Kiểu cho module. | +| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `["rebar.config", "elang.mk"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. | +| `disabled` | `false` | Vô hiệu mô đun `erlang`. | ### Các biến @@ -962,7 +970,7 @@ The `erlang` module shows the currently installed version of Erlang/OTP. Mặc | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -975,30 +983,31 @@ format = "via [e $version](bold red) " ## Google Cloud (`gcloud`) -The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. +Mô đun `gcloud` hiển thị cấu hình hiện tại của [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. Cái này dựa trên tập tin `~/.config/gcloud/active_config`, `~/.config/gcloud/configurations/config_{CONFIG NAME}` và biến môi trường `CLOUDSDK_CONFIG`. ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ---------------- | ------------------------------------------------ | --------------------------------------------------------------- | -| `format` | `'on [$symbol$account(\($region\))]($style) '` | Định dạng cho module. | -| `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. | -| `region_aliases` | | Table of region aliases to display in addition to the GCP name. | -| `style` | `"bold blue"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `gcloud` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ---------------- | ---------------------------------------------------------- | ----------------------------------------------------------------- | +| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | Định dạng cho module. | +| `symbol` | `"☁️ "` | Kí hiệu sử dụng hiển thị trước profile GCP hiện tại. | +| `region_aliases` | | Bảng ánh xạ của các bí danh của region để hiển thị ngoài tên GCP. | +| `style` | `"bold blue"` | Kiểu cho module. | +| `disabled` | `false` | Vô hiệu mô đun `gcloud`. | ### Các biến -| Biến | Ví dụ | Mô tả | -| --------- | ----------------- | ------------------------------------------------------------------ | -| region | `us-central1` | The current GCP region | -| account | `foo@example.com` | The current GCP profile | -| project | | The current GCP project | -| active | `default` | The active config name written in `~/.config/gcloud/active_config` | -| symbol | | Giá trị ghi đè tuỳ chọn `symbol` | -| style\* | | Giá trị ghi đè của `style` | +| Biến | Ví dụ | Mô tả | +| --------- | ------------- | -------------------------------------------------------------------- | +| region | `us-central1` | Region GCP hiện tại | +| account | `foo` | Profile hiện tại của GCP | +| domain | `example.com` | The current GCP profile domain | +| project | | Dự án hiện tại của GCP | +| active | `default` | Tên cấu hình có hiệu lực viết trong `~/.config/gcloud/active_config` | +| symbol | | Giá trị ghi đè tuỳ chọn `symbol` | +| style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Các vị dụ @@ -1008,7 +1017,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud # ~/.config/starship.toml [gcloud] -format = 'on [$symbol$account(\($project\))]($style) ' +format = 'on [$symbol$account(@$domain)(\($project\))]($style) ' ``` #### Chỉ hiển thị tên cấu hình hiệu lực @@ -1035,32 +1044,32 @@ asia-northeast1 = "an1" ## Git Branch -The `git_branch` module shows the active branch of the repo in your current directory. +Mô đun `git_branch` hiển thị nhánh hiệu lực của repo trong thư mục hiện tại của bạn. ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | -| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | -| `format` | `"on [$symbol$branch]($style) "` | Định dạng cho module. Use `"$branch"` to refer to the current branch name. | -| `symbol` | `" "` | A format string representing the symbol of git branch. | -| `style` | `"bold purple"` | Kiểu cho module. | -| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | -| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | -| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | -| `disabled` | `false` | Disables the `git_branch` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| -------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `always_show_remote` | `false` | Hiển thị tên nhánh remote tracking, thậm chí nếu nó bằng với tên nhánh local. | +| `format` | `"on [$symbol$branch]($style) "` | Định dạng cho module. Sử dụng `"$branch"` để tham chiếu tới tên nhánh hiện tại. | +| `symbol` | `" "` | Một chuỗi định dạng hiển thị biểu tượng của nhánh git. | +| `style` | `"bold purple"` | Kiểu cho module. | +| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | +| `truncation_symbol` | `"…"` | Biểu tượng sử dụng để nhận biết một tên nhánh được rút gọn. Bạn có thể sử dụng `""` để ẩn biểu tượng. | +| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `disabled` | `false` | Vô hiệu mô đun `git_branch`. | ### Các biến | Biến | Ví dụ | Mô tả | | ------------- | -------- | ------------------------------------------------------------------------------------------------------ | | branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). | -| remote_name | `origin` | The remote name. | -| remote_branch | `master` | The name of the branch tracked on `remote_name`. | +| remote_name | `origin` | Tên remote. | +| remote_branch | `master` | Tên của nhánh đã theo dõi trên `remote_name`. | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -1075,28 +1084,28 @@ truncation_symbol = "" ## Git Commit -The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory. +Mô đun `git_commit` hiển thị hash commit hiện tại và tag (nếu có) của repo trong thư mục hiện tại của bạn. ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| -------------------- | ------------------------------------------------------ | ------------------------------------------------------- | -| `commit_hash_length` | `7` | The length of the displayed git commit hash. | -| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | Định dạng cho module. | -| `style` | `"bold green"` | Kiểu cho module. | -| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state | -| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | -| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown | -| `disabled` | `false` | Disables the `git_commit` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| -------------------- | ------------------------------------------------------ | --------------------------------------------------------- | +| `commit_hash_length` | `7` | Độ dài của git commit hash được hiển thị. | +| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | Định dạng cho module. | +| `style` | `"bold green"` | Kiểu cho module. | +| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state | +| `tag_disabled` | `true` | Vô hiệu hiển thị thông tin tag trong mô đun `git_commit`. | +| `tag_symbol` | `"🏷 "` | Biểu tượng tag trước thông tin được hiển thị | +| `disabled` | `false` | Vô hiệu mô đun `git_commit`. | ### Các biến -| Biến | Ví dụ | Mô tả | -| --------- | --------- | --------------------------- | -| hash | `b703eb3` | The current git commit hash | -| style\* | | Giá trị ghi đè của `style` | +| Biến | Ví dụ | Mô tả | +| --------- | --------- | -------------------------- | +| hash | `b703eb3` | Git commit hash hiện tại | +| style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -1110,33 +1119,33 @@ tag_symbol = "🔖 " ## Git State -The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. +Mô đun `git_state` sẽ hiển hiển thị trong các thư mục là một phần của gt repository và những nơi tồn tại một hoạt động trong tiến trình như _REBASING_, _BISECTING_. Nếu có thông tin tiến trình (ví dụ, REBASING 3/10), thông tin đó cũng sẽ được hiển thị. ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `rebase` | `"REBASING"` | A format string displayed when a `rebase` is in progress. | -| `merge` | `"MERGING"` | A format string displayed when a `merge` is in progress. | -| `revert` | `"REVERTING"` | A format string displayed when a `revert` is in progress. | -| `cherry_pick` | `"CHERRY-PICKING"` | A format string displayed when a `cherry-pick` is in progress. | -| `bisect` | `"BISECTING"` | A format string displayed when a `bisect` is in progress. | -| `am` | `"AM"` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | -| `am_or_rebase` | `"AM/REBASE"` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | -| `style` | `"bold yellow"` | Kiểu cho module. | -| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Định dạng cho module. | -| `disabled` | `false` | Disables the `git_state` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| -------------- | --------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `rebase` | `"REBASING"` | Một format sring hiển thị khi một `rebase` đang trong quá trình. | +| `merge` | `"MERGING"` | Một format sring hiển thị khi một `merge` đang trong quá trình. | +| `revert` | `"REVERTING"` | Một format sring hiển thị khi một `revert` đang trong quá trình. | +| `cherry_pick` | `"CHERRY-PICKING"` | Một format sring hiển thị khi một `cherry-pick` đang trong quá trình. | +| `bisect` | `"BISECTING"` | Một format sring hiển thị khi một `bisect` đang trong quá trình. | +| `am` | `"AM"` | Một format sring hiển thị khi một `apply-mailbox` (`git am`) đang trong quá trình. | +| `am_or_rebase` | `"AM/REBASE"` | Một format sring hiển thị khi một `apply-mailbox` (`rebase`) đang trong quá trình. | +| `style` | `"bold yellow"` | Kiểu cho module. | +| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Định dạng cho module. | +| `disabled` | `false` | Vô hiệu `git_state` module. | ### Các biến -| Biến | Ví dụ | Mô tả | -| ---------------- | ---------- | ------------------------------ | -| state | `REBASING` | The current state of the repo | -| progress_current | `1` | The current operation progress | -| progress_total | `2` | The total operation progress | -| style\* | | Giá trị ghi đè của `style` | +| Biến | Ví dụ | Mô tả | +| ---------------- | ---------- | --------------------------------- | +| state | `REBASING` | Trạng thái của repo hiện tại | +| progress_current | `1` | Trạng thái của quá trình hiện tại | +| progress_total | `2` | Tổng số các quá trình | +| style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -1150,57 +1159,57 @@ cherry_pick = "[🍒 PICKING](bold red)" ## Git Status -The `git_status` module shows symbols representing the state of the repo in your current directory. +Mô đun `git_status` hiển thị các biểu tượng đại diện cho trạng thái của repo trong thư mục hiện tại của bạn. ### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------ | ----------------------------------------------- | ----------------------------------- | -| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | -| `conflicted` | `"="` | This branch has merge conflicts. | -| `ahead` | `"⇡"` | The format of `ahead` | -| `behind` | `"⇣"` | The format of `behind` | -| `diverged` | `"⇕"` | The format of `diverged` | -| `untracked` | `"?"` | The format of `untracked` | -| `stashed` | `"$"` | The format of `stashed` | -| `modified` | `"!"` | The format of `modified` | -| `staged` | `"+"` | The format of `staged` | -| `renamed` | `"»"` | The format of `renamed` | -| `deleted` | `"✘"` | The format of `deleted` | +| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | Định dạng mặc định cho `git_status` | +| `conflicted` | `"="` | Nhánh này có nhiều merge conflicts. | +| `ahead` | `"⇡"` | Định dạng của `ahead` | +| `behind` | `"⇣"` | Định dạng của `behind` | +| `diverged` | `"⇕"` | Định dạng của `diverged` | +| `untracked` | `"?"` | Định dạng của `untracked` | +| `stashed` | `"$"` | Định dạng của `stashed` | +| `modified` | `"!"` | Định dạng của `modified` | +| `staged` | `"+"` | Định dạng của `modified` | +| `renamed` | `"»"` | Định dạng của `renamed` | +| `deleted` | `"✘"` | Định dạng của `deleted` | | `style` | `"bold red"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `git_status` module. | +| `disabled` | `false` | Vô hiệu `git_status` module. | ### Các biến -The following variables can be used in `format`: +Các biến dưới đây có thể được sử dụng trong `format`: -| Biến | Mô tả | -| -------------- | --------------------------------------------------------------------------------------------- | -| `all_status` | Shortcut for`$conflicted$stashed$deleted$renamed$modified$staged$untracked` | -| `ahead_behind` | Displays `diverged` `ahead` or `behind` format string based on the current status of the repo | -| `conflicted` | Displays `conflicted` when this branch has merge conflicts. | -| `untracked` | Displays `untracked` when there are untracked files in the working directory. | -| `stashed` | Displays `stashed` when a stash exists for the local repository. | -| `modified` | Displays `modified` when there are file modifications in the working directory. | -| `staged` | Displays `staged` when a new file has been added to the staging area. | -| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | -| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | -| style\* | Giá trị ghi đè của `style` | +| Biến | Mô tả | +| -------------- | ----------------------------------------------------------------------------------------------- | +| `all_status` | Shortcut cho `$conflicted$stashed$deleted$renamed$modified$staged$untracked` | +| `ahead_behind` | Hiển thị format string của `diverged` `ahead` or `behind` dựa trên trạng thái hiện tại của repo | +| `conflicted` | Hiển thị `conflicted` khi nhánh này có merge conflicts. | +| `untracked` | Hiển thị `untracked` khi có tệp tin untracked trong thư mục làm việc. | +| `stashed` | Hiển thị `stashed` khi một stash tồn tại trong local repository. | +| `modified` | Hiển thị `modified` khi có tệp tin được chỉnh sửa trong thư mục làm việc. | +| `staged` | Hiển thị `staged` khi một tệp tin mới được thêm vào staging area. | +| `renamed` | Hiển thị `renamed` khi một tệp tin đổi tên đã được thêm vào staging area. | +| `deleted` | Hiển thị `deleted` khi một tệp tin bị xóa đã được thêm vào staging area. | +| style\* | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string -The following variables can be used in `diverged`: +Các biến sau có thể được sử dụng trong `diverged`: -| Biến | Mô tả | -| -------------- | ---------------------------------------------- | -| `ahead_count` | Number of commits ahead of the tracking branch | -| `behind_count` | Number of commits behind the tracking branch | +| Biến | Mô tả | +| -------------- | --------------------------------------------- | +| `ahead_count` | Số lượng commit phía trước của nhánh tracking | +| `behind_count` | Số lượng commit phía sau nhánh tracking | -The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: +Các biến sau có thể được sử dụng trong `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: -| Biến | Mô tả | -| ------- | ------------------------ | -| `count` | Show the number of files | +| Biến | Mô tả | +| ------- | ----------------------------- | +| `count` | Hiển thị số lượng các tệp tin | ### Ví dụ @@ -1220,7 +1229,7 @@ renamed = "👅" deleted = "🗑" ``` -Show ahead/behind count of the branch being tracked +Hiển thị tổng số nhánh phía trước/phía sau của nhánh được track ```toml # ~/.config/starship.toml @@ -1233,38 +1242,39 @@ behind = "⇣${count}" ## Golang -The `golang` module shows the currently installed version of Golang. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `golang` module shows the currently installed version of [Golang](https://golang.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: -- The current directory contains a `go.mod` file -- The current directory contains a `go.sum` file -- The current directory contains a `glide.yaml` file -- The current directory contains a `Gopkg.yml` file -- The current directory contains a `Gopkg.lock` file -- The current directory contains a `.go-version` file -- The current directory contains a `Godeps` directory -- The current directory contains a file with the `.go` extension +- Thư mục hiện tại chứa một tập tin `go.mod` +- Đường dẫn hiện tại chứa một tập tin `go.sum` +- Thư mục hiện tại chứa một tập tin `glide.yaml` +- Thư mục hiện tại chứa một tập tin `Gopkg.yml` +- Đường dẫn hiện tại chứa một tập tin `Gopkg.lock` +- Thư mục hiện tại chứa một tệp tin `.go-version` +- Thư mục hiện tại chứa một thư mục `Godeps` +- Thư mục hiện tại chứa một tệp tin với phần mở rộng `.go` ### 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 Go. | -| `detect_extensions` | `["go"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `["Godeps"]` | Những thư mục nào sẽ kích hoạt mô-đun này. | -| `style` | `"bold cyan"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `golang` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐹 "` | Một format string đại diện cho biểu tượng của Go. | +| `detect_extensions` | `["go"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `["Godeps"]` | Những thư mục nào sẽ kích hoạt mô-đun này. | +| `style` | `"bold cyan"` | Kiểu cho module. | +| `disabled` | `false` | Vô hiệu `golang` module. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | --------- | -------------------------------- | -| version | `v1.12.1` | The version of `go` | +| version | `v1.12.1` | Phiên bản của `go` | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -1277,32 +1287,33 @@ format = "via [🏎💨 $version](bold cyan) " ## Helm -The `helm` module shows the currently installed version of Helm. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `helm` module shows the currently installed version of [Helm](https://helm.sh/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: -- The current directory contains a `helmfile.yaml` file -- The current directory contains a `Chart.yaml` file +- Đường dẫn hiện tại chứa một tập tin `helmfile.yaml` +- Thư mục hiện tại chứa một tập tin `Chart.yaml` ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ------------------------------------ | --------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | -| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. | -| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | -| `style` | `"bold white"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `helm` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. | +| `symbol` | `"⎈ "` | Một format string đại diện cho biểu tượng của Helm. | +| `style` | `"bold white"` | Kiểu cho module. | +| `disabled` | `false` | Vô hiệu `helm` module. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | -------- | -------------------------------- | -| version | `v3.1.1` | The version of `helm` | +| version | `v3.1.1` | Phiên bản của `helm` | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -1315,17 +1326,17 @@ format = "via [⎈ $version](bold white) " ## Hostname -The `hostname` module shows the system hostname. +Mô đun `hostname` hiển thị hostnam hệ thống. ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | -| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation | -| `format` | `"[$hostname]($style) in "` | Định dạng cho module. | -| `style` | `"bold dimmed green"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `hostname` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ---------- | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `ssh_only` | `true` | Chỉ hiển thị hostname khi được kết nối tới một phiên SSH. | +| `trim_at` | `"."` | Chuỗi mà hostname được cắt ngắn, sau khi khớp lần đầu tiên. `"."` sẽ dừng sau dấu chấm đầu tiên. `""` sẽ vô hiệu mọi sự cắt ngắn | +| `format` | `"[$hostname]($style) in "` | Định dạng cho module. | +| `style` | `"bold dimmed green"` | Kiểu cho module. | +| `disabled` | `false` | Vô hiệu `hastname` module. | ### Các biến @@ -1334,7 +1345,7 @@ The `hostname` module shows the system hostname. | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -1350,10 +1361,10 @@ disabled = false ## Java -The `java` module shows the currently installed version of Java. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: -- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file -- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension +- Thư mục hiện tại chứa một tệp tin `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` +- Thư mục hiện tại chứa một tệp tin với phần mở rộng `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` ### Các tuỳ chọn @@ -1364,19 +1375,19 @@ The `java` module shows the currently installed version of Java. Mặc định m | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | | `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. | -| `symbol` | `"☕ "` | A format string representing the symbol of Java | +| `symbol` | `"☕ "` | Một format string đại diện cho biểu tượng Java | | `style` | `"red dimmed"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `java` module. | +| `disabled` | `false` | Vô hiệu `java` module. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | ----- | -------------------------------- | -| version | `v14` | The version of `java` | +| version | `v14` | Phiên bản của `java` | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -1389,33 +1400,33 @@ symbol = "🌟 " ## Jobs -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. +`jobs` module cho biết số lượng các jobs đang chạy. Mô đun sẽ được hiển thị chỉ khi có background jobs đang chạy. Mô đúnẽ hiển thị số lượng jobs đang chỵ nếu có nhiều hơn 1 jobs, hoặc nhiều hơn giá trị cấu hình `threshold`, nếu nó tồn tại. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. ::: cảnh báo -This module is not supported on tcsh. +Mô đun này không hỗ trợ trên tcsh. ::: ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ----------- | ----------------------------- | ------------------------------------------------ | -| `threshold` | `1` | Show number of jobs if exceeded. | -| `format` | `"[$symbol$number]($style) "` | Định dạng cho module. | -| `symbol` | `"✦"` | A format string representing the number of jobs. | -| `style` | `"bold blue"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `jobs` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ----------- | ----------------------------- | -------------------------------------------- | +| `threshold` | `1` | Cho biết số lượng jobs nếu nó vượt quá. | +| `format` | `"[$symbol$number]($style) "` | Định dạng cho module. | +| `symbol` | `"✦"` | Một format string đại diện cho số lượng job. | +| `style` | `"bold blue"` | Kiểu cho module. | +| `disabled` | `false` | Vô hiệu `jobs` module. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | ----- | -------------------------------- | -| number | `1` | The number of jobs | +| number | `1` | Số lượng job | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -1429,33 +1440,34 @@ threshold = 4 ## Julia -The `julia` module shows the currently installed version of Julia. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `julia` module shows the currently installed version of [Julia](https://julialang.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: -- The current directory contains a `Project.toml` file -- The current directory contains a `Manifest.toml` file -- The current directory contains a file with the `.jl` extension +- Thư mục hiện tại chứa một tệp tin `Project.toml` +- Thư mục hiện tại chứa một tập tin `Manifest.toml` +- Thư mục hiện tại chứa một tệp tin với phần mở rộng `.jl` ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ------------------------------------ | --------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | -| `detect_extensions` | `["jl"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `["Project.toml", "Manifest.toml"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. | -| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | -| `style` | `"bold purple"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `julia` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["jl"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `["Project.toml", "Manifest.toml"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. | +| `symbol` | `"ஃ "` | Một format string đại diện cho biếu tượng của Julia. | +| `style` | `"bold purple"` | Kiểu cho module. | +| `disabled` | `false` | Vô hiệu `julia` module. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | -------- | -------------------------------- | -| version | `v1.4.0` | The version of `julia` | +| version | `v1.4.0` | Phiên bản của `julia` | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -1468,32 +1480,33 @@ symbol = "∴ " ## Kotlin -The `kotlin` module shows the currently installed version of Kotlin. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: -- The current directory contains a `.kt` or a `.kts` file +- Thư mục hiện tại chứa một tệp tin `.kt` hoặc một tệp tin `.kts` ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | -| `detect_extensions` | `["kt", "kts"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `[]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. | -| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | -| `style` | `"bold blue"` | Kiểu cho module. | -| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | -| `disabled` | `false` | Disables the `kotlin` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["kt", "kts"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `[]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. | +| `symbol` | `"🅺 "` | Một format string đại diện cho biết tượng của Kotllin. | +| `style` | `"bold blue"` | Kiểu cho module. | +| `kotlin_binary` | `"kotlin"` | Cấu hình kotlin nhị phân mà Starship thực thi khi lấy phiên bản. | +| `disabled` | `false` | Vô hiệu `kotlin` module. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | --------- | -------------------------------- | -| version | `v1.4.21` | The version of `kotlin` | +| version | `v1.4.21` | Phiên bản của `kotlin` | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -1508,17 +1521,17 @@ symbol = "🅺 " # ~/.config/starship.toml [kotlin] -# Uses the Kotlin Compiler binary to get the installed version +# Sử dụng Kitlin Compiler nhị phân để lấy phiên bản được cài đặt kotlin_binary = "kotlinc" ``` ## Kubernetes -Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-cluster --namespace astronaut`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. +Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace from the kubeconfig file. Namespace cần được thiết lập trong tệp tin kubeconfig, cài này có thể được thực thi thông qua `kubectl config set-context starship-cluster --namespace astronaut`. Nếu biến môi trường `$KUBECONFIG` được thiết lập, mô đun sẽ sử dụng cái đó nếu nó không sử dụng `~/.kube/config`. -::: tip +::: thử thuật -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. ::: @@ -1541,7 +1554,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -1576,7 +1589,7 @@ disabled = true ## Lua -The `lua` module shows the currently installed version of Lua. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: - The current directory contains a `.lua-version` file - The current directory contains a `lua` directory @@ -1587,6 +1600,7 @@ The `lua` module shows the currently installed version of Lua. Mặc định mod | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `detect_extensions` | `["lua"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | | `detect_files` | `[".lua-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | @@ -1603,7 +1617,7 @@ The `lua` module shows the currently installed version of Lua. Mặc định mod | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -1620,9 +1634,9 @@ The `memory_usage` module shows current system memory and swap usage. By default the swap usage is displayed if the total system swap is non-zero. -::: tip +::: thử thuật -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. ::: @@ -1673,7 +1687,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc | `style` | `"bold purple"` | Kiểu cho module. | | `format` | `"on [$symbol$branch]($style) "` | Định dạng cho module. | | `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | -| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. | +| `truncation_symbol` | `"…"` | Biểu tượng sử dụng để nhận biết một tên nhánh được rút gọn. | | `disabled` | `true` | Disables the `hg_branch` module. | ### Các biến @@ -1684,7 +1698,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -1699,24 +1713,25 @@ truncation_symbol = "" ## Nim -The `nim` module shows the currently installed version of Nim. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). Mặc định module sẽ được hiển thị nếu có 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 ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module | -| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | -| `detect_extensions` | `["nim", "nims", "nimble"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `["nim.cfg"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | -| `style` | `"bold yellow"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `nim` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | +| `detect_extensions` | `["nim", "nims", "nimble"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `["nim.cfg"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | +| `style` | `"bold yellow"` | Kiểu cho module. | +| `disabled` | `false` | Disables the `nim` module. | ### Các biến @@ -1726,7 +1741,7 @@ The `nim` module shows the currently installed version of Nim. Mặc định mod | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -1740,7 +1755,7 @@ symbol = "🎣 " ## Nix-shell -The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment. +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment. ### Các tuỳ chọn @@ -1762,7 +1777,7 @@ The `nix_shell` module shows the nix-shell environment. The module will be shown | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -1776,11 +1791,11 @@ pure_msg = "[pure shell](bold green)" format = 'via [☃️ $state( \($name\))](bold blue) ' ``` -## NodeJS +## Node.js -The `nodejs` module shows the currently installed version of NodeJS. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). Mặc định module sẽ được hiển thị nếu có 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 `.nvmrc` file - The current directory contains a `node_modules` directory @@ -1789,17 +1804,17 @@ The `nodejs` module shows the currently installed version of NodeJS. Mặc đị ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | -| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | A format string representing the symbol of NodeJS. | -| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `["package.json", ".node-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `["node_modules"]` | Những thư mục nào sẽ kích hoạt mô-đun này. | -| `style` | `"bold green"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `nodejs` module. | -| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the NodeJS version. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | A format string representing the symbol of Node.js. | +| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `["package.json", ".node-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `["node_modules"]` | Những thư mục nào sẽ kích hoạt mô-đun này. | +| `style` | `"bold green"` | Kiểu cho module. | +| `disabled` | `false` | Disables the `nodejs` module. | +| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | ### Các biến @@ -1809,7 +1824,7 @@ The `nodejs` module shows the currently installed version of NodeJS. Mặc đị | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -1822,7 +1837,7 @@ format = "via [🤖 $version](bold green) " ## OCaml -The `ocaml` module shows the currently installed version of OCaml. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: - The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a `esy.lock` directory @@ -1833,17 +1848,18 @@ The `ocaml` module shows the currently installed version of OCaml. Mặc định ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------- | -| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. | -| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | -| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. | -| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. | -| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `["_opam", "esy.lock"]` | Những thư mục nào sẽ kích hoạt mô-đun này. | -| `style` | `"bold yellow"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `ocaml` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | +| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. | +| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. | +| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `["_opam", "esy.lock"]` | Những thư mục nào sẽ kích hoạt mô-đun này. | +| `style` | `"bold yellow"` | Kiểu cho module. | +| `disabled` | `false` | Disables the `ocaml` module. | ### Các biến @@ -1855,7 +1871,7 @@ The `ocaml` module shows the currently installed version of OCaml. Mặc định | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -1888,7 +1904,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -1905,16 +1921,16 @@ symbol = "☁️ " The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages. -- **npm** – The `npm` package version is extracted from the `package.json` present in the current directory -- **cargo** – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory -- **poetry** – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory -- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory -- **gradle** – The `gradle` package version is extracted from the `build.gradle` present -- **julia** - The package version is extracted from the `Project.toml` present -- **mix** - The `mix` package version is extracted from the `mix.exs` present -- **helm** - The `helm` chart version is extracted from the `Chart.yaml` present -- **maven** - The `maven` package version is extracted from the `pom.xml` present -- **meson** - The `meson` package version is extracted from the `meson.build` present +- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory +- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory +- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory +- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory +- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present +- [**julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present +- [**mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present +- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present +- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present +- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present > ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager. @@ -1936,7 +1952,7 @@ The `package` module is shown when the current directory is the repository for a | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -1949,7 +1965,7 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of Perl. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file @@ -1959,15 +1975,16 @@ The `perl` module shows the currently installed version of Perl. Mặc định m ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | -| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | -| `detect_extensions` | `["pl", "pm", "pod"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | -| `style` | `"bold 149"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `perl` module. | +| Tuỳ chọn | Mặc định | Mô tả | **** | +| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- | +| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | +| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | +| `detect_extensions` | `["pl", "pm", "pod"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | | +| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | | +| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | | +| `style` | `"bold 149"` | Kiểu cho module. | | +| `disabled` | `false` | Disables the `perl` module. | | ### Các biến @@ -1988,23 +2005,24 @@ format = "via [🦪 $version]($style) " ## PHP -The `php` module shows the currently installed version of PHP. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). Mặc định module sẽ được hiển thị nếu có 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` extension ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | -| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | -| `detect_extensions` | `["php"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `["composer.json", ".php-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | -| `style` | `"147 bold"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `php` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `detect_extensions` | `["php"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `["composer.json", ".php-version"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | +| `style` | `"147 bold"` | Kiểu cho module. | +| `disabled` | `false` | Disables the `php` module. | ### Các biến @@ -2014,7 +2032,7 @@ The `php` module shows the currently installed version of PHP. Mặc định mod | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -2027,22 +2045,23 @@ format = "via [🔹 $version](147 bold) " ## PureScript -The `purescript` module shows the currently installed version of PureScript version. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. Mặc định module sẽ được hiển thị nếu có 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 file with the `.purs` extension ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ------------------------------------ | ------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | -| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `["spago.dhall"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | -| `style` | `"bold white"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `purescript` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | +| `detect_extensions` | `["purs"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `["spago.dhall"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | +| `style` | `"bold white"` | Kiểu cho module. | +| `disabled` | `false` | Disables the `purescript` module. | ### Các biến @@ -2052,7 +2071,7 @@ The `purescript` module shows the currently installed version of PureScript vers | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -2065,7 +2084,7 @@ format = "via [$symbol$version](bold white)" ## Python -The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. @@ -2074,10 +2093,10 @@ Mặc định module sẽ được hiển thị nếu có bất kì điều ki - The current directory contains a `.python-version` file - The current directory contains a `Pipfile` file - The current directory contains a `__init__.py` file -- The current directory contains a `pyproject.toml` file -- The current directory contains a `requirements.txt` file -- The current directory contains a `setup.py` file -- The current directory contains a `tox.ini` file +- Đường dẫn hiện tại chứa một tập tin `pyproject.toml` +- Đườ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 `setup.py` +- Đường dẫn hiện tại chứa một tập tin `tox.ini` - The current directory contains a file with the `.py` extension. - A virtual environment is currently activated @@ -2092,12 +2111,12 @@ Mặc định module sẽ được hiển thị nếu có bất kì điều ki | `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | -| `detect_extensions` | `[".py"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này | +| `detect_extensions` | `["py"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Tên tệp nào sẽ kích hoạt mô-đun này | | `detect_folders` | `[]` | Thư mục nào sẽ kích hoạt mô-đun này | | `disabled` | `false` | Disables the `python` module. | -::: tip +::: thử thuật The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. @@ -2143,7 +2162,7 @@ detect_extensions = [] ## Red -By default the `red` module shows the currently installed version of Red. The module will be shown if any of the following conditions are met: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). 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 file with `.red` or `.reds` extension @@ -2168,7 +2187,7 @@ By default the `red` module shows the currently installed version of Red. The mo | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -2181,7 +2200,7 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). 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 `Gemfile` file - The current directory contains a `.ruby-version` file @@ -2208,7 +2227,7 @@ By default the `ruby` module shows the currently installed version of Ruby. The | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -2221,7 +2240,7 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). 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 `Cargo.toml` file - The current directory contains a file with the `.rs` extension @@ -2247,7 +2266,7 @@ By default the `rust` module shows the currently installed version of Rust. The | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -2260,7 +2279,7 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of Scala. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension @@ -2268,15 +2287,16 @@ The `scala` module shows the currently installed version of Scala. Mặc định ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ---------------------------------------- | --------------------------------------------------- | -| `format` | `"via [${symbol}(${version} )]($style)"` | Định dạng cho module. | -| `detect_extensions` | `["sbt", "scala"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[".metals"]` | Những thư mục nào nên kích hoạt các mô đun này. | -| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | -| `style` | `"red dimmed"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `scala` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | Định dạng cho module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["sbt", "scala"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[".metals"]` | Những thư mục nào nên kích hoạt các mô đun này. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `style` | `"red dimmed"` | Kiểu cho module. | +| `disabled` | `false` | Disables the `scala` module. | ### Các biến @@ -2286,7 +2306,7 @@ The `scala` module shows the currently installed version of Scala. Mặc định | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -2301,25 +2321,26 @@ symbol = "🌟 " The `shell` module shows an indicator for currently used shell. -::: tip +::: thử thuật -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. ::: ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ---------------------- | ------------ | --------------------------------------------- | -| `bash_indicator` | `bsh` | A format string used to represent bash. | -| `fish_indicator` | `fsh` | A format string used to represent fish. | -| `zsh_indicator` | `zsh` | A format string used to represent zsh. | -| `powershell_indicator` | `psh` | A format string used to represent powershell. | -| `ion_indicator` | `ion` | A format string used to represent ion. | -| `elvish_indicator` | `esh` | A format string used to represent elvish. | -| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | -| `format` | `$indicator` | Định dạng cho module. | -| `disabled` | `true` | Disables the `shell` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ---------------------- | ------------ | ------------------------------------------------------------ | +| `bash_indicator` | `bsh` | A format string used to represent bash. | +| `fish_indicator` | `fsh` | A format string used to represent fish. | +| `zsh_indicator` | `zsh` | A format string used to represent zsh. | +| `powershell_indicator` | `psh` | A format string used to represent powershell. | +| `ion_indicator` | `ion` | A format string used to represent ion. | +| `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | +| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `format` | `$indicator` | Định dạng cho module. | +| `disabled` | `true` | Disables the `shell` module. | ### Các biến @@ -2335,6 +2356,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [shell] fish_indicator = "" powershell_indicator = "_" +unknown_indicator = "mystery shell" disabled = false ``` @@ -2361,7 +2383,7 @@ The `shlvl` module shows the current `SHLVL` ("shell level") environment variabl | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -2376,7 +2398,7 @@ threshold = 3 ## Singularity -The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Các tuỳ chọn @@ -2391,11 +2413,11 @@ The `singularity` module shows the current singularity image, if inside a contai | Biến | Ví dụ | Mô tả | | --------- | ------------ | -------------------------------- | -| env | `centos.img` | The current singularity image | +| env | `centos.img` | The current Singularity image | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -2410,9 +2432,9 @@ format = '[📦 \[$env\]]($style) ' The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. -::: tip +::: thử thuật -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. ::: @@ -2446,7 +2468,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -2465,22 +2487,23 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). 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.swift` file - The current directory contains a file with the `.swift` extension ### 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 Swift | -| `detect_extensions` | `["swift"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `["Package.swift"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | -| `style` | `"bold 202"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `swift` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `detect_extensions` | `["swift"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `["Package.swift"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | +| `style` | `"bold 202"` | Kiểu cho module. | +| `disabled` | `false` | Disables the `swift` module. | ### Các biến @@ -2490,7 +2513,7 @@ By default the `swift` module shows the currently installed version of Swift. Th | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -2503,11 +2526,11 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. -::: tip +::: thử thuật -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). +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-terraform-version). ::: @@ -2518,30 +2541,31 @@ Mặc định module sẽ được hiển thị nếu có bất kì điều ki ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | -| `symbol` | `"💠"` | A format string shown before the terraform workspace. | -| `detect_extensions` | `["tf", "hcl"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `[]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[".terraform"]` | Những thư mục nào sẽ kích hoạt mô-đun này. | -| `style` | `"bold 105"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `terraform` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | +| `detect_extensions` | `["tf", "hcl"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `[]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[".terraform"]` | Những thư mục nào sẽ kích hoạt mô-đun này. | +| `style` | `"bold 105"` | Kiểu cho module. | +| `disabled` | `false` | Disables the `terraform` module. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | ---------- | -------------------------------- | | version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current terraform workspace | +| workspace | `default` | The current Terraform workspace | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ -#### With Version +#### With Terraform Version ```toml # ~/.config/starship.toml @@ -2550,7 +2574,7 @@ Mặc định module sẽ được hiển thị nếu có bất kì điều ki format = "[🏎💨 $version$workspace]($style) " ``` -#### Without version +#### Without Terraform version ```toml # ~/.config/starship.toml @@ -2563,9 +2587,9 @@ 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. -::: tip +::: thử thuật -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. ::: @@ -2587,10 +2611,10 @@ If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it de | Biến | Ví dụ | Mô tả | | --------- | ---------- | -------------------------- | -| time | `13:08:10` | The current time. | +| thời gian | `13:08:10` | The current time. | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -2607,14 +2631,14 @@ time_range = "10:00:00-14:00:00" ## Username -The `username` module shows active user's username. The module will be shown if any of the following conditions are met: +The `username` module shows active user's username. 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 user is root - The current user isn't the same as the one that is logged in - The user is currently connected as an SSH session - The variable `show_always` is set to true -::: tip +::: thử thuật 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. @@ -2652,21 +2676,22 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of Vagrant. Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). Mặc định module sẽ được hiển thị nếu có 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. | -| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `["Vagrantfile"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | -| `style` | `"cyan bold"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `vagrant` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `["Vagrantfile"]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | +| `style` | `"cyan bold"` | Kiểu cho module. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Các biến @@ -2676,7 +2701,7 @@ The `vagrant` module shows the currently installed version of Vagrant. Mặc đ | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -2689,7 +2714,7 @@ format = "via [⍱ $version](bold white) " ## VCSH -The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### Các tuỳ chọn @@ -2708,7 +2733,7 @@ The `vcsh` module displays the current active VCSH repository. The module will b | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | `black bold dimmed` | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -2721,21 +2746,22 @@ format = "[🆅 $repo](bold blue) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). 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 `.zig` file ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | -| `style` | `"bold yellow"` | Kiểu cho module. | -| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | -| `disabled` | `false` | Disables the `zig` module. | -| `detect_extensions` | `["zig"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `[]` | Tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | +| `style` | `"bold yellow"` | Kiểu cho module. | +| `disabled` | `false` | Disables the `zig` module. | +| `detect_extensions` | `["zig"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `[]` | Tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | ### Các biến @@ -2745,7 +2771,7 @@ By default the the `zig` module shows the currently installed version of Zig. Th | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string ### Ví dụ @@ -2767,19 +2793,19 @@ These modules will be shown if any of the following conditions are met: - The current directory contains a file whose extension is in `extensions` - The `when` command returns 0 -::: tip +::: thử thuật Multiple custom modules can be defined by using a `.`. ::: -::: tip +::: thử thuật 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. ::: -::: tip +::: thử thuật [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! @@ -2792,7 +2818,7 @@ The order in which custom modules are shown can be individually set by including | `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | | `shell` | | [See below](#custom-command-shell) | -| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `mô tả` | `""` | The description of the module that is shown when running `starship explain`. | | `files` | `[]` | The files that will be searched in the working directory for a match. | | `directories` | `[]` | The directories that will be searched in the working directory for a match. | | `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | @@ -2809,7 +2835,7 @@ The order in which custom modules are shown can be individually set by including | symbol | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | Giá trị ghi đè của `style` | -\*: This variable can only be used as a part of a style string +\*: Biến này có thể chỉ được sử dụng như một phần của style string #### Custom command shell diff --git a/docs/zh-CN/README.md b/docs/zh-CN/README.md index cb069b63..a34dbcf2 100644 --- a/docs/zh-CN/README.md +++ b/docs/zh-CN/README.md @@ -32,7 +32,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal. -### Quick Install +### 快速安装 1. 安装 **starship** 二进制文件： diff --git a/docs/zh-CN/advanced-config/README.md b/docs/zh-CN/advanced-config/README.md index 0d17d1c3..e9ad0539 100644 --- a/docs/zh-CN/advanced-config/README.md +++ b/docs/zh-CN/advanced-config/README.md @@ -81,7 +81,7 @@ starship_precmd_user_func="set_win_title" - `` - `none` -`` 是颜色说明符（下面解释）。 `fg:` and `` currently do the same thing, though this may change in the future. `inverted` swaps the background and foreground colors. The order of words in the string does not matter. +`` 是颜色说明符（下面解释）。 `fg:` and `` currently do the same thing, though this may change in the future. `inverted` swaps the background and foreground colors. 字符串中的单词顺序不影响显示结果。 The `none` token overrides all other tokens in a string if it is not part of a `bg:` specifier, so that e.g. `fg:red none fg:blue` will still create a string with no styling. `bg:none` sets the background to the default color so `fg:red bg:none` is equivalent to `red` or `fg:red` and `bg:green fg:red bg:none` is also equivalent to `fg:red` or `red`. 未来可能会将 `none` 与其它标识符一起使用视为一种错误。 diff --git a/docs/zh-CN/config/README.md b/docs/zh-CN/config/README.md index 82397752..954962c0 100644 --- a/docs/zh-CN/config/README.md +++ b/docs/zh-CN/config/README.md @@ -3,7 +3,7 @@ 您需要创建配置文件 `~/.config/starship.toml` 以供 Starship 使用。 ```sh -mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml +mkdir -p ~/.config && touch ~/.config/starship.toml ``` Starship 的所有配置都在此 [TOML](https://github.com/toml-lang/toml) 配置文件中完成： @@ -49,9 +49,9 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ### 术语 -**组件（Module）**：提示符的组成部分，通过来自系统的上下文信息向用户显示各种信息。 比如“nodejs”组件会在当前目录是一个 NodeJS 项目时显示您当前安装的 NodeJS 版本。 +**组件（Module）**：提示符的组成部分，通过来自系统的上下文信息向用户显示各种信息。 For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project. -**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of NodeJS. +**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js. By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix. @@ -310,7 +310,7 @@ symbol = "🅰 " ## Battery -The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. +`battery` 组件显示电池充电情况和当前充电状态。 这个组件只会在当前电量低于 10% 时显示。 ### 配置项 @@ -338,7 +338,7 @@ discharging_symbol = "💀 " ### Battery 组件的显示 -The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). If no `display` is provided. 默认设置如下： +The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). 如果 `display` 没有设置， 默认设置如下： ```toml [[battery.display]] @@ -350,12 +350,12 @@ The default value for the `charging_symbol` and `discharging_symbol` option is r #### 配置项 -The `display` option is an array of the following table. +`display` 字段的子字段如下： | Option | 默认值 | 描述 | | -------------------- | ---------- | --------------------------------------------------------------------------------------------------------- | -| `threshold` | `10` | The upper bound for the display option. | -| `style` | `bold red` | The style used if the display option is in use. | +| `threshold` | `10` | 当前显示设置的电量上限（见示例） | +| `style` | `bold red` | 若组件被显示，则使用此样式 | | `charging_symbol` | `-` | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. | | `discharging_symbol` | `-` | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. | @@ -377,14 +377,14 @@ discharging_symbol = 💦 ## Character -The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. +`character` 组件用于在您输入终端的文本旁显示一个字符（通常是一个箭头）。 -The character will tell you whether the last command was successful or not. It can do this in two ways: +这个字符可以告诉您最后一个命令是否执行成功。 It can do this in two ways: - changing color (`red`/`green`) - changing shape (`❯`/`✖`) -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). +By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). ::: warning `error_symbol` is not supported on elvish shell. ::: @@ -437,22 +437,23 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met: +The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met: - The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeCache.txt` file ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | -------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | -| `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | -| `style` | `"bold blue"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `cmake` module. | +| Option | 默认值 | 描述 | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"△ "` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `"bold blue"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `cmake` module. | ### Variables @@ -466,15 +467,15 @@ The `cmake` module shows the currently installed version of CMake. By default th ## Command Duration -The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. +`cmd_duration` 组件显示上一个命令执行的时间。 此组件只在命令执行时间长于两秒时显示，或者当其 `min_time` 字段被设置时，按此值为执行时间的显示下限。 -::: warning Do not hook the DEBUG trap in Bash +::: warning 不要在 Bash 里捕获 DEBUG 信号 -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. +如果您正在 `bash` 上使用 Starship，在运行 `eval $(starship)` 后，不要捕获 `DEBUG` 信号，否则此组件**将会**坏掉。 ::: -Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. +需要在自动每一条命令前执行某些操作的 Bash 用户可以使用 [rcaloras 的 bash_preexec 框架](https://github.com/rcaloras/bash-preexec)。 只需要在执行 `eval $(starship init $0)` 前简单地定义 `preexec_functions` 和 `precmd_functions` 两个列表，就可以照常运行了。 ### 配置项 @@ -515,11 +516,11 @@ format = "underwent [$duration](bold yellow)" ## Conda -The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. +`conda` 组件在 `$CONDA_DEFAULT_ENV` 被设置时显示当前 conda 环境。 ::: tip -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. +此组件没有禁用 conda 自带的提示符修改，您可能需要执行 `conda config --set changeps1 False`。 ::: @@ -555,22 +556,23 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met: +The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: - 当前目录包含一个 `shard.yml` 文件 - The current directory contains a `.cr` file ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | ------------------------------------ | --------------------------------------------------------- | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | -| `style` | `"bold red"` | 此组件的样式。 | -| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | -| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | -| `disabled` | `false` | Disables the `crystal` module. | +| Option | 默认值 | 描述 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `"bold red"` | 此组件的样式。 | +| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | +| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `disabled` | `false` | Disables the `crystal` module. | ### Variables @@ -593,7 +595,7 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory @@ -601,15 +603,16 @@ The `dart` module shows the currently installed version of Dart. By default the ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | ------------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | -| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | -| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | -| `style` | `"bold blue"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `dart` module. | +| Option | 默认值 | 描述 | +| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | +| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. | +| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | +| `style` | `"bold blue"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `dart` module. | ### Variables @@ -632,20 +635,21 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of Deno. By default the module will be shown if any of the following conditions are met: +The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | -------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | -| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"green bold"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `deno` module. | +| Option | 默认值 | 描述 | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"green bold"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `deno` module. | ### Variables @@ -666,33 +670,33 @@ format = "via [🦕 $version](green bold) " ## Directory -The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. +`directory` 组件显示当前目录的路径，显示的路径会截断到三个父目录以内。 如果您处于一个 git 仓库中，显示的路径则最多会截断到该仓库的根目录。 -When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. +当使用 fish 风格的当前目录显示样式时，您会看到基于您的设置的每个上级目录的短名称，而不是隐藏被截断的上级目录。 -For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. +例如，对于 `~/Dev/Nix/nixpkgs/pkgs`，其中 `nixpkgs` 是 git 仓库根目录，fish 风格相关选项设置为 `1`。 您将会看到 `~/D/N/nixpkgs/pkgs`，而在设置 fish 风格之前，当前路径将显示成 `nixpkgs/pkgs`。 ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- | -| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | -| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | -| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | 组件格式化模板。 | -| `style` | `"bold cyan"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `directory` module. | -| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | -| `read_only_style` | `"red"` | The style for the read only symbol. | -| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | -| `home_symbol` | `"~"` | The symbol indicating home directory. | +| Option | 默认值 | 描述 | +| ------------------- | -------------------------------------------------- | ----------------------------------------------------- | +| `truncation_length` | `3` | 当前目录路径被截断后最多保留的父目录数量。 | +| `truncate_to_repo` | `true` | 是否只截断到您当前处于的 git 仓库根目录下。 | +| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | 组件格式化模板。 | +| `style` | `"bold cyan"` | 此组件的样式。 | +| `disabled` | `false` | 禁用 `directory` 组件。 | +| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | +| `read_only_style` | `"red"` | The style for the read only symbol. | +| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | +| `home_symbol` | `"~"` | The symbol indicating home directory. |
-This module has a few advanced configuration options that control how the directory is displayed. +此组件有几个高级配置选项来控制当前目录路径的显示方式。 | Advanced Option | 默认值 | 描述 | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `substitutions` | | A table of substitutions to be made to the path. | -| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | +| `fish_style_pwd_dir_length` | `0` | 使用 fish shell 当前目录路径逻辑时每个省略目录名使用的字符数。 | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. | `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. @@ -764,7 +768,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. 如果当前目录已被绑定了一个版本的 SDK，则显示被帮定的版本。 否则此组件将显示最新安装的 SDK 版本。 By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -780,22 +784,23 @@ By default this module will only be shown in your prompt when one or more of the You'll also need the .NET Core SDK installed in order to use it correctly. -Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. +在内部，此组件使用自己的版本检测机制。 一般来说此组件是直接执行 `dotnet --version` 的两倍快，但当你的 .NET 项目使用了不常见的目录布局时此组件可能显示一个错误的版本。 如果相比于速度您更需要正确的版本号，您可以在组件设置中设置 `heuristic = false` 来禁用该机制。 The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | 组件格式化模板。 | -| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. | -| `heuristic` | `true` | Use faster version detection to keep starship snappy. | -| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. | -| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `style` | `"bold blue"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `dotnet` module. | +| Option | 默认值 | 描述 | +| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | 组件格式化模板。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `".NET "` | 这个字段的内容会显示在当前 .NET 版本之前。 | +| `heuristic` | `true` | 使用更快的版本探测机制以保证 starship 的运行速度。 | +| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. | +| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold blue"` | 此组件的样式。 | +| `disabled` | `false` | 禁用 `dotnet` 组件。 | ### Variables @@ -821,21 +826,22 @@ heuristic = false ## Elixir -The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. By default the module will be shown if any of the following conditions are met: +The `elixir` module shows the currently installed version of [Elixir](https://elixir-lang.org/) and [Erlang/OTP](https://erlang.org/doc/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `mix.exs` file. +- 当前目录包含一个 `mix.exs` 文件. ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------- | -| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `style` | `"bold purple"` | 此组件的样式。 | -| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | -| `disabled` | `false` | Disables the `elixir` module. | +| Option | 默认值 | 描述 | +| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold purple"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `elixir` module. | ### Variables @@ -859,25 +865,26 @@ symbol = "🔮 " ## Elm -The `elm` module shows the currently installed version of Elm. By default the module will be shown if any of the following conditions are met: +The `elm` module shows the currently installed version of [Elm](https://elm-lang.org/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `elm.json` file -- The current directory contains a `elm-package.json` file +- 当前目录包含一个 `elm.json` 文件 +- 当前目录包含 `elm-package.json` 文件 - The current directory contains a `.elm-version` file - The current directory contains a `elm-stuff` folder - The current directory contains a `*.elm` files ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | -------------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | -| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | -| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. | -| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. | -| `style` | `"cyan bold"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `elm` module. | +| Option | 默认值 | 描述 | +| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | +| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. | +| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. | +| `style` | `"cyan bold"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `elm` module. | ### Variables @@ -900,20 +907,20 @@ format = "via [ $version](cyan bold) " ## Environment Variable -The `env_var` module displays the current value of a selected environment variable. The module will be shown only if any of the following conditions are met: +`env_var` 组件显示选定的环境变量的当前值。 此组件只有满足以下条件之一时才会被显示： -- The `variable` configuration option matches an existing environment variable -- The `variable` configuration option is not defined, but the `default` configuration option is +- 设置的 `variable` 是一个已存在的环境变量 +- 未定义 `variable`，但定义了 `default` ### 配置项 -| Option | 默认值 | 描述 | -| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `symbol` | | The symbol used before displaying the variable value. | -| `variable` | | The environment variable to be displayed. | -| `default` | | The default value to be displayed when the selected variable is not defined. | -| `format` | `"with [$env_value]($style) "` | 组件格式化模板。 | -| `disabled` | `false` | Disables the `env_var` module. | +| Option | 默认值 | 描述 | +| ---------- | ------------------------------ | ------------------- | +| `symbol` | | 这个字段的内容会显示在环境变量值之前。 | +| `variable` | | 要显示的环境变量。 | +| `default` | | 所选变量未定义时显示的默认值。 | +| `format` | `"with [$env_value]($style) "` | 组件格式化模板。 | +| `disabled` | `false` | 禁用 `env_var` 组件。 | ### Variables @@ -937,22 +944,23 @@ default = "unknown shell" ## Erlang -The `erlang` module shows the currently installed version of Erlang/OTP. By default the module will be shown if any of the following conditions are met: +The `erlang` module shows the currently installed version of [Erlang/OTP](https://erlang.org/doc/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `rebar.config` file. -- The current directory contains a `erlang.mk` file. +- 当前目录包含一个 `rebar.config` 文件. +- 当前目录包含一个 `erlang.mk` 文件. ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | ------------------------------------ | -------------------------------------------------------- | -| `symbol` | `" "` | The symbol used before displaying the version of erlang. | -| `style` | `"bold red"` | 此组件的样式。 | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | -| `disabled` | `false` | Disables the `erlang` module. | +| Option | 默认值 | 描述 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | The symbol used before displaying the version of erlang. | +| `style` | `"bold red"` | 此组件的样式。 | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `disabled` | `false` | Disables the `erlang` module. | ### Variables @@ -979,24 +987,25 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud ### 配置项 -| Option | 默认值 | 描述 | -| ---------------- | ------------------------------------------------ | --------------------------------------------------------------- | -| `format` | `'on [$symbol$account(\($region\))]($style) '` | 组件格式化模板。 | -| `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. | -| `region_aliases` | | Table of region aliases to display in addition to the GCP name. | -| `style` | `"bold blue"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `gcloud` module. | +| Option | 默认值 | 描述 | +| ---------------- | ---------------------------------------------------------- | --------------------------------------------------------------- | +| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | 组件格式化模板。 | +| `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. | +| `region_aliases` | | Table of region aliases to display in addition to the GCP name. | +| `style` | `"bold blue"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `gcloud` module. | ### Variables -| 字段 | 示例 | 描述 | -| --------- | ----------------- | ------------------------------------------------------------------ | -| region | `us-central1` | The current GCP region | -| account | `foo@example.com` | The current GCP profile | -| project | | The current GCP project | -| active | `default` | The active config name written in `~/.config/gcloud/active_config` | -| symbol | | `symbol`对应值 | -| style\* | | `style`对应值 | +| 字段 | 示例 | 描述 | +| --------- | ------------- | ------------------------------------------------------------------ | +| region | `us-central1` | The current GCP region | +| account | `foo` | The current GCP profile | +| domain | `example.com` | The current GCP profile domain | +| project | | The current GCP project | +| active | `default` | The active config name written in `~/.config/gcloud/active_config` | +| symbol | | `symbol`对应值 | +| style\* | | `style`对应值 | \*: This variable can only be used as a part of a style string @@ -1008,7 +1017,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud # ~/.config/starship.toml [gcloud] -format = 'on [$symbol$account(\($project\))]($style) ' +format = 'on [$symbol$account(@$domain)(\($project\))]($style) ' ``` #### Display active config name only @@ -1035,20 +1044,20 @@ asia-northeast1 = "an1" ## Git Branch -The `git_branch` module shows the active branch of the repo in your current directory. +`git_branch` 组件显示当前目录的 git 仓库的活动分支。 ### 配置项 -| Option | 默认值 | 描述 | -| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | -| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | -| `format` | `"on [$symbol$branch]($style) "` | 组件格式化模板。 Use `"$branch"` to refer to the current branch name. | -| `symbol` | `" "` | A format string representing the symbol of git branch. | -| `style` | `"bold purple"` | 此组件的样式。 | -| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | -| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | -| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | -| `disabled` | `false` | Disables the `git_branch` module. | +| Option | 默认值 | 描述 | +| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------ | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `"on [$symbol$branch]($style) "` | 组件格式化模板。 Use `"$branch"` to refer to the current branch name. | +| `symbol` | `" "` | A format string representing the symbol of git branch. | +| `style` | `"bold purple"` | 此组件的样式。 | +| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | +| `truncation_symbol` | `"…"` | 此字段的内容用来表示分支名称被截断。 You can use `""` for no symbol. | +| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `disabled` | `false` | 禁用 `git_branch` 组件。 | ### Variables @@ -1081,13 +1090,13 @@ The `git_commit` module shows the current commit hash and also the tag (if any) | Option | 默认值 | 描述 | | -------------------- | ------------------------------------------------------ | ------------------------------------------------------- | -| `commit_hash_length` | `7` | The length of the displayed git commit hash. | +| `commit_hash_length` | `7` | 显示的 git 提交哈希值的长度。 | | `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | 组件格式化模板。 | | `style` | `"bold green"` | 此组件的样式。 | | `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state | | `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | | `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown | -| `disabled` | `false` | Disables the `git_commit` module. | +| `disabled` | `false` | 禁用 `git_commit` 组件。 | ### Variables @@ -1110,7 +1119,7 @@ tag_symbol = "🔖 " ## Git State -The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. +`git_state` 组件会显示当前目录在哪个 git 仓库中，以及正在进行的操作，例如：_REBASING_，_BISECTING_ 等。 进度信息（例如 REBASING 3/10）如果存在则也会被显示。 ### 配置项 @@ -1125,7 +1134,7 @@ The `git_state` module will show in directories which are part of a git reposito | `am_or_rebase` | `"AM/REBASE"` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | | `style` | `"bold yellow"` | 此组件的样式。 | | `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | 组件格式化模板。 | -| `disabled` | `false` | Disables the `git_state` module. | +| `disabled` | `false` | 禁用 `git_state` 模块 | ### Variables @@ -1150,14 +1159,14 @@ cherry_pick = "[🍒 PICKING](bold red)" ## Git Status -The `git_status` module shows symbols representing the state of the repo in your current directory. +`git_status`组件通过相应的符号显示您当前目录中 git 仓库的状态。 ### 配置项 | Option | 默认值 | 描述 | | ------------ | ----------------------------------------------- | ----------------------------------- | | `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | -| `conflicted` | `"="` | This branch has merge conflicts. | +| `conflicted` | `"="` | 这个分支有合并冲突。 | | `ahead` | `"⇡"` | The format of `ahead` | | `behind` | `"⇣"` | The format of `behind` | | `diverged` | `"⇕"` | The format of `diverged` | @@ -1168,7 +1177,7 @@ The `git_status` module shows symbols representing the state of the repo in your | `renamed` | `"»"` | The format of `renamed` | | `deleted` | `"✘"` | The format of `deleted` | | `style` | `"bold red"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `git_status` module. | +| `disabled` | `false` | 禁用 `git_status` 组件。 | ### Variables @@ -1198,9 +1207,9 @@ The following variables can be used in `diverged`: The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: -| 字段 | 描述 | -| ------- | ------------------------ | -| `count` | Show the number of files | +| 字段 | 描述 | +| ------- | --------- | +| `count` | 显示相应的文件数量 | ### 示例 @@ -1233,28 +1242,29 @@ behind = "⇣${count}" ## Golang -The `golang` module shows the currently installed version of Golang. By default the module will be shown if any of the following conditions are met: +The `golang` module shows the currently installed version of [Golang](https://golang.org/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `go.mod` file -- The current directory contains a `go.sum` file -- The current directory contains a `glide.yaml` file -- The current directory contains a `Gopkg.yml` file -- The current directory contains a `Gopkg.lock` file +- 当前目录包含 `go.mod` 文件 +- 当前目录包含 `go.sum` 文件 +- 当前目录包含 `glide.yaml` 文件 +- 当前目录包含 `Gopkg.yml` 文件 +- 当前目录包含 `Gopkg.lock` 文件 - The current directory contains a `.go-version` file -- The current directory contains a `Godeps` directory -- The current directory contains a file with the `.go` extension +- 当前目录包含 `Godeps` 目录 +- 当前目录包含一个使用 `.go` 扩展名的文件 ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | -| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | -| `detect_extensions` | `["go"]` | Which extensions should trigger this module. | -| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. | -| `style` | `"bold cyan"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `golang` module. | +| Option | 默认值 | 描述 | +| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | +| `detect_extensions` | `["go"]` | Which extensions should trigger this module. | +| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. | +| `style` | `"bold cyan"` | 此组件的样式。 | +| `disabled` | `false` | 禁用 `golang` 组件。 | ### Variables @@ -1277,22 +1287,23 @@ format = "via [🏎💨 $version](bold cyan) " ## Helm -The `helm` module shows the currently installed version of Helm. By default the module will be shown if any of the following conditions are met: +The `helm` module shows the currently installed version of [Helm](https://helm.sh/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `helmfile.yaml` file +- 当前目录包含一个 `helmfile.yaml` 文件 - The current directory contains a `Chart.yaml` file ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | ------------------------------------ | ------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | -| `style` | `"bold white"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `helm` module. | +| Option | 默认值 | 描述 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | +| `style` | `"bold white"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `helm` module. | ### Variables @@ -1315,17 +1326,17 @@ format = "via [⎈ $version](bold white) " ## Hostname -The `hostname` module shows the system hostname. +`hostname` 组件显示系统主机名。 ### 配置项 -| Option | 默认值 | 描述 | -| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | -| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation | -| `format` | `"[$hostname]($style) in "` | 组件格式化模板。 | -| `style` | `"bold dimmed green"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `hostname` module. | +| Option | 默认值 | 描述 | +| ---------- | --------------------------- | ------------------------------------------------------------------ | +| `ssh_only` | `true` | 仅在连接到 SSH 会话时显示主机名。 | +| `trim_at` | `"."` | 当主机名过长被截断时，会截断成第一次匹配该字符串之前的主机名。 `"."` 会让主机名截断到第一个点处。 `""` 会禁用任何截断。 | +| `format` | `"[$hostname]($style) in "` | 组件格式化模板。 | +| `style` | `"bold dimmed green"` | 此组件的样式。 | +| `disabled` | `false` | 禁用 `hostname` 组件。 | ### Variables @@ -1350,7 +1361,7 @@ disabled = false ## Java -The `java` module shows the currently installed version of Java. By default the module will be shown if any of the following conditions are met: +The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension @@ -1366,7 +1377,7 @@ The `java` module shows the currently installed version of Java. By default the | `detect_folders` | `[]` | Which folders should trigger this modules. | | `symbol` | `"☕ "` | A format string representing the symbol of Java | | `style` | `"red dimmed"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `java` module. | +| `disabled` | `false` | 禁用 `java` 组件。 | ### Variables @@ -1389,7 +1400,7 @@ symbol = "🌟 " ## Jobs -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. +`jobs` 组件显示当前正在运行的任务数量。 仅当有后台任务运行时，此组件才会显示。 如果有超过 1 个作业，模块将显示正在运行的作业数量，如果配置了 `threshold` 字段，则使用它作为显示作业数量的下限。 If `threshold` is set to 0, then the module will also show when there are 0 jobs running. ::: warning @@ -1401,11 +1412,11 @@ This module is not supported on tcsh. | Option | 默认值 | 描述 | | ----------- | ----------------------------- | ------------------------------------------------ | -| `threshold` | `1` | Show number of jobs if exceeded. | +| `threshold` | `1` | 如果超过此字段的值，显示任务数量。 | | `format` | `"[$symbol$number]($style) "` | 组件格式化模板。 | | `symbol` | `"✦"` | A format string representing the number of jobs. | | `style` | `"bold blue"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `jobs` module. | +| `disabled` | `false` | 禁用 `jobs` 组件。 | ### Variables @@ -1429,7 +1440,7 @@ threshold = 4 ## Julia -The `julia` module shows the currently installed version of Julia. By default the module will be shown if any of the following conditions are met: +The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Project.toml` file - The current directory contains a `Manifest.toml` file @@ -1437,15 +1448,16 @@ The `julia` module shows the currently installed version of Julia. By default th ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | ------------------------------------ | ------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | -| `detect_extensions` | `["jl"]` | Which extensions should trigger this module. | -| `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | -| `style` | `"bold purple"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `julia` module. | +| Option | 默认值 | 描述 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["jl"]` | Which extensions should trigger this module. | +| `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | +| `style` | `"bold purple"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `julia` module. | ### Variables @@ -1468,7 +1480,7 @@ symbol = "∴ " ## Kotlin -The `kotlin` module shows the currently installed version of Kotlin. By default the module will be shown if any of the following conditions are met: +The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `.kt` or a `.kts` file @@ -1477,6 +1489,7 @@ The `kotlin` module shows the currently installed version of Kotlin. By default | Option | 默认值 | 描述 | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this modules. | @@ -1514,11 +1527,11 @@ kotlin_binary = "kotlinc" ## Kubernetes -Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-cluster --namespace astronaut`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. +Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-cluster --namespace astronaut`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 ::: @@ -1557,13 +1570,13 @@ disabled = false ## Line Break -The `line_break` module separates the prompt into two lines. +`line_break` 组件将提示分隔为两行。 ### 配置项 -| Option | 默认值 | 描述 | -| ---------- | ------- | ------------------------------------------------------------------ | -| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | +| Option | 默认值 | 描述 | +| ---------- | ------- | --------------------------- | +| `disabled` | `false` | 禁用 `line_break` 组件，使提示成为单行。 | ### 示例 @@ -1576,7 +1589,7 @@ disabled = true ## Lua -The `lua` module shows the currently installed version of Lua. By default the module will be shown if any of the following conditions are met: +The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `.lua-version` file - The current directory contains a `lua` directory @@ -1587,6 +1600,7 @@ The `lua` module shows the currently installed version of Lua. By default the mo | Option | 默认值 | 描述 | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `detect_extensions` | `["lua"]` | Which extensions should trigger this module. | | `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. | @@ -1616,25 +1630,25 @@ format = "via [🌕 $version](bold blue) " ## Memory Usage -The `memory_usage` module shows current system memory and swap usage. +`memory_usage` 组件显示当前系统内存和交换区使用情况。 -By default the swap usage is displayed if the total system swap is non-zero. +默认情况下，如果系统交换区使用不为 0，则会显示交换区使用情况。 ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 ::: ### 配置项 -| Option | 默认值 | 描述 | -| ----------- | ----------------------------------------------- | -------------------------------------------------------- | -| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | -| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | 组件格式化模板。 | -| `symbol` | `"🐏"` | The symbol used before displaying the memory usage. | -| `style` | `"bold dimmed white"` | 此组件的样式。 | -| `disabled` | `true` | Disables the `memory_usage` module. | +| Option | 默认值 | 描述 | +| ----------- | ----------------------------------------------- | ---------------------- | +| `threshold` | `75` | 隐藏内存使用情况，除非它超过这个百分比。 | +| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | 组件格式化模板。 | +| `symbol` | `"🐏"` | 这个字段的内容会显示在当前内存使用情况之前。 | +| `style` | `"bold dimmed white"` | 此组件的样式。 | +| `disabled` | `true` | 禁用 `memory_usage` 模块 | ### Variables @@ -1663,18 +1677,18 @@ style = "bold dimmed green" ## Mercurial Branch -The `hg_branch` module shows the active branch of the repo in your current directory. +`hg_branch` 组件显示当前目录的 hg 仓库的活动分支。 ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | -| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | -| `style` | `"bold purple"` | 此组件的样式。 | -| `format` | `"on [$symbol$branch]($style) "` | 组件格式化模板。 | -| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | -| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. | -| `disabled` | `true` | Disables the `hg_branch` module. | +| Option | 默认值 | 描述 | +| ------------------- | -------------------------------- | --------------------------------------------- | +| `symbol` | `" "` | 该字段的内容显示于当前仓库的 hg 书签或活动分支名之前。 | +| `style` | `"bold purple"` | 此组件的样式。 | +| `format` | `"on [$symbol$branch]($style) "` | 组件格式化模板。 | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | +| `truncation_symbol` | `"…"` | 此字段的内容用来表示分支名称被截断。 | +| `disabled` | `true` | 禁用 `hg_branch` 组件。 | ### Variables @@ -1699,24 +1713,25 @@ truncation_symbol = "" ## Nim -The `nim` module shows the currently installed version of Nim. By default the module will be shown if any of the following conditions are met: +The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met: -- 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 ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module | -| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | -| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. | -| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold yellow"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `nim` module. | +| Option | 默认值 | 描述 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | +| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. | +| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold yellow"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `nim` module. | ### Variables @@ -1740,7 +1755,7 @@ symbol = "🎣 " ## Nix-shell -The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment. +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. 当处于一个 nix-shell 环境中时，此组件会被显示。 ### 配置项 @@ -1751,7 +1766,7 @@ The `nix_shell` module shows the nix-shell environment. The module will be shown | `style` | `"bold blue"` | 此组件的样式。 | | `impure_msg` | `"impure"` | A format string shown when the shell is impure. | | `pure_msg` | `"pure"` | A format string shown when the shell is pure. | -| `disabled` | `false` | Disables the `nix_shell` module. | +| `disabled` | `false` | 禁用 `nix_shell` 组件。 | ### Variables @@ -1776,30 +1791,30 @@ pure_msg = "[pure shell](bold green)" format = 'via [☃️ $state( \($name\))](bold blue) ' ``` -## NodeJS +## Node.js -The `nodejs` module shows the currently installed version of NodeJS. By default the module will be shown if any of the following conditions are met: +The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `package.json` file +- 当前目录包含 `package.json` 文件 - The current directory contains a `.node-version` file - The current directory contains a `.nvmrc` file -- The current directory contains a `node_modules` directory +- 当前目录包含 `node_modules` 目录 - The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension - The current directory contains a file with the `.ts` extension ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | -| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | A format string representing the symbol of NodeJS. | -| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. | -| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | -| `style` | `"bold green"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `nodejs` module. | -| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the NodeJS version. | +| Option | 默认值 | 描述 | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | A format string representing the symbol of Node.js. | +| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. | +| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | +| `style` | `"bold green"` | 此组件的样式。 | +| `disabled` | `false` | 禁用 `nodejs` 组件。 | +| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | ### Variables @@ -1822,7 +1837,7 @@ format = "via [🤖 $version](bold green) " ## OCaml -The `ocaml` module shows the currently installed version of OCaml. By default the module will be shown if any of the following conditions are met: +The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a `esy.lock` directory @@ -1833,17 +1848,18 @@ The `ocaml` module shows the currently installed version of OCaml. By default th ### 配置项 -| Option | 默认值 | 描述 | -| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------- | -| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. | -| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | -| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. | -| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. | -| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this module. | -| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. | -| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. | -| `style` | `"bold yellow"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `ocaml` module. | +| Option | 默认值 | 描述 | +| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | +| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. | +| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. | +| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this module. | +| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. | +| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. | +| `style` | `"bold yellow"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `ocaml` module. | ### Variables @@ -1903,30 +1919,30 @@ symbol = "☁️ " ## Package Version -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages. +当前目录是软件包的代码仓库时，将显示 `package` 组件，并显示软件包当前版本。 The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages. -- **npm** – The `npm` package version is extracted from the `package.json` present in the current directory -- **cargo** – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory -- **poetry** – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory -- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory -- **gradle** – The `gradle` package version is extracted from the `build.gradle` present -- **julia** - The package version is extracted from the `Project.toml` present -- **mix** - The `mix` package version is extracted from the `mix.exs` present -- **helm** - The `helm` chart version is extracted from the `Chart.yaml` present -- **maven** - The `maven` package version is extracted from the `pom.xml` present -- **meson** - The `meson` package version is extracted from the `meson.build` present +- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory +- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory +- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory +- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory +- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present +- [**julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present +- [**mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present +- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present +- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present +- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present > ⚠ 此组件显示的是源代码在当前目录中的软件包的版本，而不是包管理器的版本。 ### 配置项 -| Option | 默认值 | 描述 | -| ----------------- | --------------------------------- | ---------------------------------------------------------- | -| `format` | `"is [$symbol$version]($style) "` | 组件格式化模板。 | -| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | -| `style` | `"bold 208"` | 此组件的样式。 | -| `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | Disables the `package` module. | +| Option | 默认值 | 描述 | +| ----------------- | --------------------------------- | --------------------------------------------------------- | +| `format` | `"is [$symbol$version]($style) "` | 组件格式化模板。 | +| `symbol` | `"📦 "` | 这个字段的内容会显示在当前软件包版本之前。 | +| `style` | `"bold 208"` | 此组件的样式。 | +| `display_private` | `false` | Enable displaying version for packages marked as private. | +| `disabled` | `false` | 禁用 `package` 组件。 | ### Variables @@ -1949,7 +1965,7 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file @@ -1959,15 +1975,16 @@ The `perl` module shows the currently installed version of Perl. By default the ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | -| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | -| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | -| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 149"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `perl` module. | +| Option | 默认值 | 描述 | **** | +| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- | +| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | +| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | +| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | | +| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | | +| `detect_folders` | `[]` | Which folders should trigger this module. | | +| `style` | `"bold 149"` | 此组件的样式。 | | +| `disabled` | `false` | Disables the `perl` module. | | ### Variables @@ -1988,23 +2005,24 @@ format = "via [🦪 $version]($style) " ## PHP -The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `composer.json` file +- 当前目录包含一个 `composer.json` 文件 - The current directory contains a `.php-version` file - The current directory contains a `.php` extension ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | -| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | -| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | -| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"147 bold"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `php` module. | +| Option | 默认值 | 描述 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐘 "` | 这个字段的内容会显示在当前 PHP 版本之前。 | +| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | +| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"147 bold"` | 此组件的样式。 | +| `disabled` | `false` | 禁用 `php` 组件。 | ### Variables @@ -2027,22 +2045,23 @@ format = "via [🔹 $version](147 bold) " ## PureScript -The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: -- The current directory contains a `spago.dhall` file +- 当前目录包含一个 `spago.dhall` 文件 - The current directory contains a file with the `.purs` extension ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | ------------------------------------ | ------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | -| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | -| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold white"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `purescript` module. | +| Option | 默认值 | 描述 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | +| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold white"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `purescript` module. | ### Variables @@ -2065,21 +2084,21 @@ format = "via [$symbol$version](bold white)" ## Python -The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. -If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. +如果`pyenv_version_name`被设置为`true`, 本组件将会展示pyenv版本名。 否则则显示通过`python --version`获得的版本号 By default the module will be shown if any of the following conditions are met: -- The current directory contains a `.python-version` file -- The current directory contains a `Pipfile` file -- The current directory contains a `__init__.py` file -- The current directory contains a `pyproject.toml` file -- The current directory contains a `requirements.txt` file -- The current directory contains a `setup.py` file -- The current directory contains a `tox.ini` file -- The current directory contains a file with the `.py` extension. -- A virtual environment is currently activated +- 当前目录包含 `.python-version` 文件 +- 当前目录包含 `Pipfile` 文件 +- 当前目录包含一个名为`__init__.py`的文件 +- 当前目录包含 `pyproject.toml` 文件 +- 当前目录包含 `requirements.txt` 文件 +- 当前目录包含一个 `setup.py` 文件 +- 当前目录包含一个 `tox.ini` 文件 +- 当前目录包含一个使用 `.py` 扩展名的文件. +- 当前处于一个活跃的 python 虚拟环境中 ### 配置项 @@ -2087,15 +2106,15 @@ By default the module will be shown if any of the following conditions are met: | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | | `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | 组件格式化模板。 | | `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🐍 "` | A format string representing the symbol of Python | +| `symbol` | `"🐍 "` | 用于表示Python的格式化字符串。 | | `style` | `"yellow bold"` | 此组件的样式。 | -| `pyenv_version_name` | `false` | Use pyenv to get Python version | +| `pyenv_version_name` | `false` | 使用 pyenv 获取 Python 版本 | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | -| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | +| `detect_extensions` | `["py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | -| `disabled` | `false` | Disables the `python` module. | +| `disabled` | `false` | 禁用 `python` 组件。 | ::: tip @@ -2109,11 +2128,11 @@ The default values and order for `python_binary` was chosen to first identify th | 字段 | 示例 | 描述 | | ------------ | --------------- | ------------------------------------------ | -| version | `"v3.8.1"` | The version of `python` | +| version | `"v3.8.1"` | `python`版本 | | symbol | `"🐍 "` | `symbol`对应值 | | style | `"yellow bold"` | `style`对应值 | | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | -| virtualenv | `"venv"` | The current `virtualenv` name | +| virtualenv | `"venv"` | 当前`virtualenv`名称 | ### 示例 @@ -2143,7 +2162,7 @@ detect_extensions = [] ## Red -By default the `red` module shows the currently installed version of Red. The module will be shown if any of the following conditions are met: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). 此组件将在符合以下任意条件之一时显示： - The current directory contains a file with `.red` or `.reds` extension @@ -2181,11 +2200,11 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). 此组件将在符合以下任意条件之一时显示： -- The current directory contains a `Gemfile` file +- 当前目录包含 `Gemfile` 文件 - The current directory contains a `.ruby-version` file -- The current directory contains a `.rb` file +- 当前目录包含 `.rb` 文件 ### 配置项 @@ -2198,7 +2217,7 @@ By default the `ruby` module shows the currently installed version of Ruby. The | `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold red"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `ruby` module. | +| `disabled` | `false` | 禁用 `ruby` 组件。 | ### Variables @@ -2221,10 +2240,10 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). 此组件将在符合以下任意条件之一时显示： -- The current directory contains a `Cargo.toml` file -- The current directory contains a file with the `.rs` extension +- 当前目录包含 `Cargo.toml` 文件 +- 当前目录包含一个使用 `.rs` 扩展名的文件 ### 配置项 @@ -2237,7 +2256,7 @@ By default the `rust` module shows the currently installed version of Rust. The | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold red"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `rust` module. | +| `disabled` | `false` | 禁用 `rust` 组件。 | ### Variables @@ -2260,7 +2279,7 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension @@ -2268,15 +2287,16 @@ The `scala` module shows the currently installed version of Scala. By default th ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | ---------------------------------------- | ------------------------------------------------- | -| `format` | `"via [${symbol}(${version} )]($style)"` | 组件格式化模板。 | -| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | -| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | -| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | -| `style` | `"red dimmed"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `scala` module. | +| Option | 默认值 | 描述 | +| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | 组件格式化模板。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `style` | `"red dimmed"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `scala` module. | ### Variables @@ -2303,23 +2323,24 @@ The `shell` module shows an indicator for currently used shell. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 ::: ### 配置项 -| Option | 默认值 | 描述 | -| ---------------------- | ------------ | --------------------------------------------- | -| `bash_indicator` | `bsh` | A format string used to represent bash. | -| `fish_indicator` | `fsh` | A format string used to represent fish. | -| `zsh_indicator` | `zsh` | A format string used to represent zsh. | -| `powershell_indicator` | `psh` | A format string used to represent powershell. | -| `ion_indicator` | `ion` | A format string used to represent ion. | -| `elvish_indicator` | `esh` | A format string used to represent elvish. | -| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | -| `format` | `$indicator` | 组件格式化模板。 | -| `disabled` | `true` | Disables the `shell` module. | +| Option | 默认值 | 描述 | +| ---------------------- | ------------ | ------------------------------------------------------------ | +| `bash_indicator` | `bsh` | A format string used to represent bash. | +| `fish_indicator` | `fsh` | A format string used to represent fish. | +| `zsh_indicator` | `zsh` | A format string used to represent zsh. | +| `powershell_indicator` | `psh` | A format string used to represent powershell. | +| `ion_indicator` | `ion` | A format string used to represent ion. | +| `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | +| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `format` | `$indicator` | 组件格式化模板。 | +| `disabled` | `true` | Disables the `shell` module. | ### Variables @@ -2335,6 +2356,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [shell] fish_indicator = "" powershell_indicator = "_" +unknown_indicator = "mystery shell" disabled = false ``` @@ -2376,7 +2398,7 @@ threshold = 3 ## Singularity -The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### 配置项 @@ -2391,7 +2413,7 @@ The `singularity` module shows the current singularity image, if inside a contai | 字段 | 示例 | 描述 | | --------- | ------------ | ----------------------------- | -| env | `centos.img` | The current singularity image | +| env | `centos.img` | The current Singularity image | | symbol | | `symbol`对应值 | | style\* | | `style`对应值 | @@ -2412,7 +2434,7 @@ The `status` module displays the exit code of the previous command. The module w ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 ::: @@ -2465,22 +2487,23 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). 此组件将在符合以下任意条件之一时显示： - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | ------------------------------------ | ------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | -| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | -| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 202"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `swift` module. | +| Option | 默认值 | 描述 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | +| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold 202"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `swift` module. | ### Variables @@ -2503,37 +2526,38 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: 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). +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-terraform-version). ::: By default the module will be shown if any of the following conditions are met: -- The current directory contains a `.terraform` folder +- 当前目录包含 `.terraform` 目录 - Current directory contains a file with the `.tf` or `.hcl` extensions ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | -| `symbol` | `"💠"` | A format string shown before the terraform workspace. | -| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | -| `style` | `"bold 105"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | 默认值 | 描述 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | +| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | +| `style` | `"bold 105"` | 此组件的样式。 | +| `disabled` | `false` | 禁用 `terraform` 组件。 | ### Variables | 字段 | 示例 | 描述 | | --------- | ---------- | ------------------------------- | | version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current terraform workspace | +| workspace | `default` | The current Terraform workspace | | symbol | | `symbol`对应值 | | style\* | | `style`对应值 | @@ -2541,7 +2565,7 @@ By default the module will be shown if any of the following conditions are met: ### 示例 -#### With Version +#### With Terraform Version ```toml # ~/.config/starship.toml @@ -2550,7 +2574,7 @@ By default the module will be shown if any of the following conditions are met: format = "[🏎💨 $version$workspace]($style) " ``` -#### Without version +#### Without Terraform version ```toml # ~/.config/starship.toml @@ -2561,27 +2585,27 @@ 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 -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 ::: ### 配置项 -| Option | 默认值 | 描述 | -| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `format` | `"at [$time]($style) "` | The format string for the module. | -| `use_12hr` | `false` | Enables 12 hour formatting | -| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | -| `style` | `"bold yellow"` | The style for the module time | -| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | -| `disabled` | `true` | Disables the `time` module. | -| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| Option | 默认值 | 描述 | +| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | +| `format` | `"at [$time]($style) "` | The format string for the module. | +| `use_12hr` | `false` | 启用 12 小时格式 | +| `time_format` | 见下文解释 | 用来格式化时间显示的 [chrono 格式字符串](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) | +| `style` | `"bold yellow"` | 显示时间的样式。 | +| `utc_time_offset` | `"local"` | 设置所用 UTC 偏移量。 Range from -24 < x < 24. 允许使用浮点数来得到 30/45 分钟的时区偏移。 | +| `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 @@ -2607,12 +2631,12 @@ time_range = "10:00:00-14:00:00" ## Username -The `username` module shows active user's username. The module will be shown if any of the following conditions are met: +`username` 组件显示当前活跃的用户名。 此组件将在符合以下任意条件之一时显示： -- The current user is root -- The current user isn't the same as the one that is logged in -- The user is currently connected as an SSH session -- The variable `show_always` is set to true +- 当前用户是 root +- 当前用户与登录用户不相同 +- 用户正通过 SSH 会话连接访问 +- 字段 `show_always` 被设置为 true ::: tip @@ -2622,13 +2646,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### 配置项 -| Option | 默认值 | 描述 | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `style_user` | `"bold yellow"` | The style used for non-root users. | -| `format` | `"[$user]($style) in "` | 组件格式化模板。 | -| `show_always` | `false` | Always shows the `username` module. | -| `disabled` | `false` | Disables the `username` module. | +| Option | 默认值 | 描述 | +| ------------- | ----------------------- | ------------------- | +| `style_root` | `"bold red"` | 当前用户为 root 时使用的样式。 | +| `style_user` | `"bold yellow"` | 非 root 用户使用的样式。 | +| `format` | `"[$user]($style) in "` | 组件格式化模板。 | +| `show_always` | `false` | 总是显示 `username` 组件。 | +| `disabled` | `false` | 禁用 `username` 组件。 | ### Variables @@ -2652,21 +2676,22 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Vagrantfile` file ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | ------------------------------------ | --------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | -| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"cyan bold"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `vagrant` module. | +| Option | 默认值 | 描述 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"cyan bold"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2689,7 +2714,7 @@ format = "via [⍱ $version](bold white) " ## VCSH -The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### 配置项 @@ -2721,21 +2746,22 @@ format = "[🆅 $repo](bold blue) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). 此组件将在符合以下任意条件之一时显示： - The current directory contains a `.zig` file ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | -| `style` | `"bold yellow"` | 此组件的样式。 | -| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | -| `disabled` | `false` | Disables the `zig` module. | -| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | 默认值 | 描述 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | +| `style` | `"bold yellow"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `zig` module. | +| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables @@ -2792,7 +2818,7 @@ The order in which custom modules are shown can be individually set by including | `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | | `shell` | | [See below](#custom-command-shell) | -| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `描述` | `""` | The description of the module that is shown when running `starship explain`. | | `files` | `[]` | The files that will be searched in the working directory for a match. | | `directories` | `[]` | The directories that will be searched in the working directory for a match. | | `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | diff --git a/docs/zh-CN/faq/README.md b/docs/zh-CN/faq/README.md index 98d6524e..f275123a 100644 --- a/docs/zh-CN/faq/README.md +++ b/docs/zh-CN/faq/README.md @@ -1,16 +1,16 @@ # 常见问题 -## 主页 GIF 示例中的效果用的是什么配置？ +## 主页示例图中的效果用的是什么配置？ - **终端模拟器**：[iTerm2](https://iterm2.com/) - **主题**：Minimal - **颜色方案**：[Snazzy](https://github.com/sindresorhus/iterm2-snazzy) - - **Font**: [FiraCode Nerd Font](https://www.nerdfonts.com/font-downloads) + - **字体**：[Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads) - **Shell**：[Fish Shell](https://fishshell.com/) - **fish 配置**：[matchai's Dotfiles](https://github.com/matchai/dotfiles/blob/b6c6a701d0af8d145a8370288c00bb9f0648b5c2/.config/fish/config.fish) - **提示符工具**：[Starship](https://starship.rs/) -## How do I get command completion as shown in the demo GIF? +## 如何实现示例图中自动补全的功能？ Completion support, or autocomplete, is provided by your shell of choice. In the case of the demo, the demo was done with [Fish Shell](https://fishshell.com/), which provides completions by default. If you use Z Shell (zsh), I'd suggest taking a look at [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions). @@ -62,10 +62,10 @@ If you see symbols that you don't recognise you can use `starship explain` to ex ## Why don't I see a glyph symbol in my prompt? -The most common cause of this is system misconfiguration. Some Linux distros in particular do not come with font support out-of-the-box. You need to ensure that: +最常见的原因是系统配置有问题。 有个别Linux发行版不自带对字体的支持。 请确保： - Your locale is set to a UTF-8 value, like `de_DE.UTF-8` or `ja_JP.UTF-8`. If `LC_ALL` is not a UTF-8 value, [you will need to change it](https://www.tecmint.com/set-system-locales-in-linux/). -- You have an emoji font installed. Most systems come with an emoji font by default, but some (notably Arch Linux) do not. You can usually install one through your system's package manager--[noto emoji](https://www.google.com/get/noto/help/emoji/) is a popular choice. +- 安装了 emoji 字体。 大部分系统都会自带 emoji 字体，但有些系统（例如 Arch Linux）则没有。 字体一般可以用系统的包管理器安装，常见的字体有 [Noto emoji](https://www.google.com/get/noto/help/emoji/) 等。 - You are using a [Nerd Font](https://www.nerdfonts.com/). To test your system, run the following commands in a terminal: @@ -75,20 +75,20 @@ echo -e "\xf0\x9f\x90\x8d" echo -e "\xee\x82\xa0" ``` -The first line should produce a [snake emoji](https://emojipedia.org/snake/), while the second should produce a [powerline branch symbol (e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs). +第一行应该显示出一个[蛇的 emoji](https://emojipedia.org/snake/)，第二行应该显示出 [powerline 的分支符号（e0a0）。](https://github.com/ryanoasis/powerline-extra-symbols#glyphs). If either symbol fails to display correctly, your system is still misconfigured. Unfortunately, getting font configuration correct is sometimes difficult. Users on the Discord may be able to help. If both symbols display correctly, but you still don't see them in starship, [file a bug report!](https://github.com/starship/starship/issues/new/choose) -## How do I uninstall Starship? +## 如何卸载 Starship？ -Starship is just as easy to uninstall as it is to install in the first place. +Starship 的卸载过程与安装过程一样简单。 -1. Remove any lines in your shell config (e.g. `~/.bashrc`) used to initialize Starship. -1. Delete the Starship binary. +1. 将 shell 的配置文件（比如 `~/.bashrc`）中初始化 Starship 的部分全部删除。 +1. 删除 Starship 的二进制文件。 -If Starship was installed using a package manager, please refer to their docs for uninstallation instructions. +如果 Starship 是用包管理器安装的，请到包管理器的文档中查找卸载的步骤。 -If Starship was installed using the install script, the following command will delete the binary: +如果 Starship 是用安装脚本安装的，可以用以下命令删除二进制文件： ```sh # Locate and delete the starship binary diff --git a/docs/zh-CN/installing/README.md b/docs/zh-CN/installing/README.md index e6341087..fc85ff85 100644 --- a/docs/zh-CN/installing/README.md +++ b/docs/zh-CN/installing/README.md @@ -1,11 +1,11 @@ -# 🚀 Advanced Installation +# 🚀 高级安装 -To install starship, you need to do two things: +安装Starship有以下两个步骤： -1. Get the **starship** binary onto your computer -1. Tell your shell to use the starship binary as its prompt by modifying its init scripts +1. 下载 **starship** 的可执行文件 +1. 修改 shell 的初始化脚本，让 starship 显示命令提示符 -For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. +大部分用户按照[主页](/guide/#🚀-installation)上的步骤安装即可， 但有一些特殊系统上的安装步骤不同。 There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! @@ -13,9 +13,9 @@ There are so many platforms out there that they didn't fit into the main README. ### 前置要求 -Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey. +按照 [Chocolatey 安装页面](https://chocolatey.org/install)上的步骤安装 Chocolatey。 -### Installation +### 安装 ```powershell choco install starship @@ -29,7 +29,7 @@ choco install starship pkg install getconf ``` -### Installation +### 安装 ```sh sh -c "$(curl -fsSL https://starship.rs/install.sh)" -- --bin-dir /data/data/com.termux/files/usr/bin diff --git a/docs/zh-TW/README.md b/docs/zh-TW/README.md index e06b87f6..72579e56 100644 --- a/docs/zh-TW/README.md +++ b/docs/zh-TW/README.md @@ -32,7 +32,7 @@ description: Starship 是適合任何 shell 的最小、極速、高度客製化 - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal. -### Quick Install +### 快速安裝 1. 安裝 **starship** 執行檔： diff --git a/docs/zh-TW/advanced-config/README.md b/docs/zh-TW/advanced-config/README.md index f341d074..08e32c05 100644 --- a/docs/zh-TW/advanced-config/README.md +++ b/docs/zh-TW/advanced-config/README.md @@ -81,7 +81,7 @@ starship_precmd_user_func="set_win_title" - `` - `none` -其中 `` 是指定顏色用的（下面解釋）。 `fg:` and `` currently do the same thing, though this may change in the future. `inverted` swaps the background and foreground colors. The order of words in the string does not matter. +其中 `` 是指定顏色用的（下面解釋）。 `fg:` and `` currently do the same thing, though this may change in the future. `inverted` swaps the background and foreground colors. 單詞在字串中的順序不重要。 The `none` token overrides all other tokens in a string if it is not part of a `bg:` specifier, so that e.g. `fg:red none fg:blue` will still create a string with no styling. `bg:none` sets the background to the default color so `fg:red bg:none` is equivalent to `red` or `fg:red` and `bg:green fg:red bg:none` is also equivalent to `fg:red` or `red`. 未來可能會將 `none` 與其他符號一起使用的情形視為是一種錯誤。 diff --git a/docs/zh-TW/config/README.md b/docs/zh-TW/config/README.md index fbd6f00a..6ad87000 100644 --- a/docs/zh-TW/config/README.md +++ b/docs/zh-TW/config/README.md @@ -3,7 +3,7 @@ 為了開始設定 Starship，請建立下右檔案： `~/.config/starship.toml`. ```sh -mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml +mkdir -p ~/.config && touch ~/.config/starship.toml ``` 所有關於 Starship 的設定都在這個 [TOML](https://github.com/toml-lang/toml) 檔案內： @@ -49,9 +49,9 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ### 術語 -**模組 (Module)**： 提示字元中的一個元件，基於你的作業系統提供的背景資訊來提供訊息。 舉例來說，如果你現在的資料夾是一個 NodeJS 專案，"nodejs" 模組會顯示出現在安裝在你的電腦上的 NodeJS 版本。 +**模組 (Module)**： 提示字元中的一個元件，基於你的作業系統提供的背景資訊來提供訊息。 For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project. -**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of NodeJS. +**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js. By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix. @@ -310,7 +310,7 @@ symbol = "🅰 " ## 電池 -The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. +`battery` 模組顯示電池的電量以及現在的充電狀態。 這個模組只會在裝置的電量低於 10% 的時候看見。 ### 選項 @@ -338,7 +338,7 @@ discharging_symbol = "💀 " ### 電池顯示 -The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). If no `display` is provided. 預設如下： +The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). 如果沒有提供 `display`。 預設如下： ```toml [[battery.display]] @@ -350,12 +350,12 @@ The default value for the `charging_symbol` and `discharging_symbol` option is r #### 選項 -The `display` option is an array of the following table. +`display` 選項是一個下列表格的陣列。 | Option | 預設 | 說明 | | -------------------- | ---------- | --------------------------------------------------------------------------------------------------------- | -| `threshold` | `10` | The upper bound for the display option. | -| `style` | `bold red` | The style used if the display option is in use. | +| `threshold` | `10` | 顯示選項的上界。 | +| `style` | `bold red` | 顯示選項使用時的風格。 | | `charging_symbol` | `-` | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. | | `discharging_symbol` | `-` | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. | @@ -377,14 +377,14 @@ discharging_symbol = 💦 ## 字元 -The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. +`character` 模組在你的文字輸入處旁顯示一個字元 (通常是箭頭)。 -The character will tell you whether the last command was successful or not. It can do this in two ways: +這個字元會告訴你最後的指令是成功還是失敗。 It can do this in two ways: - changing color (`red`/`green`) - changing shape (`❯`/`✖`) -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). +By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). ::: warning `error_symbol` is not supported on elvish shell. ::: @@ -437,22 +437,23 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met: +The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met: - The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeCache.txt` file ### 選項 -| Option | 預設 | 說明 | -| ------------------- | -------------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | -| `style` | `"bold blue"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `cmake` module. | +| Option | 預設 | 說明 | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"△ "` | The symbol used before the version of cmake. | +| `detect_extensions` | `[]` | Which extensions should trigger this module | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | +| `detect_folders` | `[]` | Which folders should trigger this module | +| `style` | `"bold blue"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `cmake` module. | ### Variables @@ -466,15 +467,15 @@ The `cmake` module shows the currently installed version of CMake. By default th ## 指令持續時間 -The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. +`cmd_duration` 模組顯示最後一個指令執行所花費的時間。 這個模組只會在指令花費超過兩秒或是有設定 `min_time` 時，超過設定值時出現。 -::: warning Do not hook the DEBUG trap in Bash +::: warning 不要在 Bash 中設置 DEBUG trap -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. +如果你在 `bash` 中使用 Starship，不要在執行 `eval $(starship init $0)` 之後設置 `DEBUG` trap，不然這個模組**會**壞掉。 ::: -Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. +想使用類似 preexec 功能的 Bash 使用者可以 [rcaloras 的 bash_preexec 框架](https://github.com/rcaloras/bash-preexec)。 只要在 `eval $(starship init $0)` 之前簡單地定義 `preexec_functions` 與 `precmd_functions` 兩個陣列，然後就可以照常進行。 ### 選項 @@ -515,7 +516,7 @@ format = "underwent [$duration](bold yellow)" ## Conda -The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. +如果有設定 `$CONDA_DEFAULT_ENV` 時，`conda` 模組顯示現在 conda 的環境。 ::: tip @@ -555,22 +556,23 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met: +The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: - 現在資料夾中含有一個 `shard.yml` 檔案 - 現在資料夾中含有一個`.cr`檔案 ### 選項 -| Option | 預設 | 說明 | -| ------------------- | ------------------------------------ | --------------------------------------------------------- | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | -| `style` | `"bold red"` | 這個模組的風格。 | -| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | -| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `crystal` module. | +| Option | 預設 | 說明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `style` | `"bold red"` | 這個模組的風格。 | +| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | +| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `disabled` | `false` | Disables the `crystal` module. | ### Variables @@ -593,7 +595,7 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory @@ -601,15 +603,16 @@ The `dart` module shows the currently installed version of Dart. By default the ### 選項 -| Option | 預設 | 說明 | -| ------------------- | ------------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `detect_extensions` | `['dart']` | Which extensions should trigger this module. | -| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | -| `style` | `"bold blue"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `dart` module. | +| Option | 預設 | 說明 | +| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | +| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. | +| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | +| `style` | `"bold blue"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `dart` module. | ### Variables @@ -632,20 +635,21 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of Deno. By default the module will be shown if any of the following conditions are met: +The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file ### 選項 -| Option | 預設 | 說明 | -| ------------------- | -------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"green bold"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `deno` module. | +| Option | 預設 | 說明 | +| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"green bold"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `deno` module. | ### Variables @@ -666,33 +670,33 @@ format = "via [🦕 $version](green bold) " ## 資料夾 -The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. +`directory` 模組顯示到現在資料夾的路徑，並裁減到前三層資料夾。 你的資料夾也會被裁減到你所在的 git 儲存庫的根目錄。 -When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. +如果正在使用 fish 風格的 pwd 選項，將不會隱藏被裁減的資料夾，而是會根據你在選項中設定的數字看到每一層資料夾的縮寫。 -For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. +例如，給定一個右列的路徑 `~/Dev/Nix/nixpkgs/pkgs` 其中 `nixpkgs` 是儲存庫的根目錄，而且該選項被設定為 `1`。 你會看到 `~/D/N/nixpkgs/pkgs`，而在這個設定之前則是 `nixpkgs/pkgs`。 ### 選項 -| Option | 預設 | 說明 | -| ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- | -| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | -| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | -| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. | -| `style` | `"bold cyan"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `directory` module. | -| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | -| `read_only_style` | `"red"` | The style for the read only symbol. | -| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | -| `home_symbol` | `"~"` | The symbol indicating home directory. | +| Option | 預設 | 說明 | +| ------------------- | -------------------------------------------------- | ----------------------------------------------------- | +| `truncation_length` | `3` | 到達現在資料夾的路徑中，要被裁減掉的資料夾數目。 | +| `truncate_to_repo` | `true` | 是否要裁減到你現在所在的 git 儲存庫的根目錄。 | +| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. | +| `style` | `"bold cyan"` | 這個模組的風格。 | +| `disabled` | `false` | 停用 `directory` 模組。 | +| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | +| `read_only_style` | `"red"` | The style for the read only symbol. | +| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | +| `home_symbol` | `"~"` | The symbol indicating home directory. |
-This module has a few advanced configuration options that control how the directory is displayed. +這個模組有些進階設定選項可以控制顯示資料夾。 | Advanced Option | 預設 | 說明 | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `substitutions` | | A table of substitutions to be made to the path. | -| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | +| `fish_style_pwd_dir_length` | `0` | 當使用 fish shell 的 pwd 路徑邏輯時使用的字元數量。 | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. | `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. @@ -764,7 +768,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. 如果這個資料夾已經選定一個 SDK，則顯示這個 SDK 的版本。 如果沒有的話，則顯示最新安裝的 SDK 版本。 By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -780,22 +784,23 @@ By default this module will only be shown in your prompt when one or more of the You'll also need the .NET Core SDK installed in order to use it correctly. -Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. +這個模組內部是使用它自己的機制來偵測版本。 一般來說這個模組有 `dotnet --version` 的兩倍快，但是它可能會在你的 .NET 專案有不尋常的資料夾結構時顯示不正確的版本。 如果精確度比速度更重要的話，你可以藉由設定模組中的 `heuristic = false` 選項來停用這個功能。 The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. ### 選項 -| Option | 預設 | 說明 | -| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. | -| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. | -| `heuristic` | `true` | Use faster version detection to keep starship snappy. | -| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. | -| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `style` | `"bold blue"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `dotnet` module. | +| Option | 預設 | 說明 | +| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `".NET "` | 在顯示 dotnet 版本之前用的符號。 | +| `heuristic` | `true` | 使用更快速的版本偵測法來保持 starship 的速度。 | +| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. | +| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold blue"` | 這個模組的風格。 | +| `disabled` | `false` | 停用 `dotnet` 模組。 | ### Variables @@ -821,21 +826,22 @@ heuristic = false ## Elixir -The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. By default the module will be shown if any of the following conditions are met: +The `elixir` module shows the currently installed version of [Elixir](https://elixir-lang.org/) and [Erlang/OTP](https://erlang.org/doc/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `mix.exs` file. +- 現在資料夾中包含一個 `mix.exs` 檔案. ### 選項 -| Option | 預設 | 說明 | -| ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------- | -| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `style` | `"bold purple"` | 這個模組的風格。 | -| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | -| `disabled` | `false` | Disables the `elixir` module. | +| Option | 預設 | 說明 | +| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold purple"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `elixir` module. | ### Variables @@ -859,25 +865,26 @@ symbol = "🔮 " ## Elm -The `elm` module shows the currently installed version of Elm. By default the module will be shown if any of the following conditions are met: +The `elm` module shows the currently installed version of [Elm](https://elm-lang.org/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `elm.json` file -- The current directory contains a `elm-package.json` file +- 現在資料夾中包含一個 `elm.json` 檔案 +- 現在資料夾中包含一個 `elm-package.json` 檔案 - The current directory contains a `.elm-version` file - The current directory contains a `elm-stuff` folder - The current directory contains a `*.elm` files ### 選項 -| Option | 預設 | 說明 | -| ------------------- | -------------------------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | -| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. | -| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. | -| `style` | `"cyan bold"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `elm` module. | +| Option | 預設 | 說明 | +| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | +| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. | +| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. | +| `style` | `"cyan bold"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `elm` module. | ### Variables @@ -900,20 +907,20 @@ format = "via [ $version](cyan bold) " ## 環境變數 -The `env_var` module displays the current value of a selected environment variable. The module will be shown only if any of the following conditions are met: +`env_var`模組顯示一個選擇的環境變數的現在數值。 這個模組只在下列條件其中之一達到時顯示： -- The `variable` configuration option matches an existing environment variable -- The `variable` configuration option is not defined, but the `default` configuration option is +- `variable` 設定選項符合一個存在的環境變數。 +- 沒有設定 `variable` 選項，但是有設定 `default` 選項。 ### 選項 -| Option | 預設 | 說明 | -| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `symbol` | | The symbol used before displaying the variable value. | -| `variable` | | The environment variable to be displayed. | -| `default` | | The default value to be displayed when the selected variable is not defined. | -| `format` | `"with [$env_value]($style) "` | The format for the module. | -| `disabled` | `false` | Disables the `env_var` module. | +| Option | 預設 | 說明 | +| ---------- | ------------------------------ | -------------------------- | +| `symbol` | | 顯示在變數數值之前的符號。 | +| `variable` | | 要顯示的環境變數。 | +| `default` | | 在選擇的變數值沒有定義時，顯示的預設值。 | +| `format` | `"with [$env_value]($style) "` | The format for the module. | +| `disabled` | `false` | 停用 `env_var` 模組。 | ### Variables @@ -937,22 +944,23 @@ default = "unknown shell" ## Erlang -The `erlang` module shows the currently installed version of Erlang/OTP. By default the module will be shown if any of the following conditions are met: +The `erlang` module shows the currently installed version of [Erlang/OTP](https://erlang.org/doc/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `rebar.config` file. -- The current directory contains a `erlang.mk` file. +- 現在資料夾中包含一個 `rebar.config` 檔案. +- 現在資料夾中包含一個 `erlang.mk` 檔案. ### 選項 -| Option | 預設 | 說明 | -| ------------------- | ------------------------------------ | -------------------------------------------------------- | -| `symbol` | `" "` | The symbol used before displaying the version of erlang. | -| `style` | `"bold red"` | 這個模組的風格。 | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `erlang` module. | +| Option | 預設 | 說明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | The symbol used before displaying the version of erlang. | +| `style` | `"bold red"` | 這個模組的風格。 | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `disabled` | `false` | Disables the `erlang` module. | ### Variables @@ -979,24 +987,25 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud ### 選項 -| Option | 預設 | 說明 | -| ---------------- | ------------------------------------------------ | --------------------------------------------------------------- | -| `format` | `'on [$symbol$account(\($region\))]($style) '` | The format for the module. | -| `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. | -| `region_aliases` | | Table of region aliases to display in addition to the GCP name. | -| `style` | `"bold blue"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `gcloud` module. | +| Option | 預設 | 說明 | +| ---------------- | ---------------------------------------------------------- | --------------------------------------------------------------- | +| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | The format for the module. | +| `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. | +| `region_aliases` | | Table of region aliases to display in addition to the GCP name. | +| `style` | `"bold blue"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `gcloud` module. | ### Variables -| 變數 | 範例 | 說明 | -| --------- | ----------------- | ------------------------------------------------------------------ | -| region | `us-central1` | The current GCP region | -| account | `foo@example.com` | The current GCP profile | -| project | | The current GCP project | -| active | `default` | The active config name written in `~/.config/gcloud/active_config` | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | ------------- | ------------------------------------------------------------------ | +| region | `us-central1` | The current GCP region | +| account | `foo` | The current GCP profile | +| domain | `example.com` | The current GCP profile domain | +| project | | The current GCP project | +| active | `default` | The active config name written in `~/.config/gcloud/active_config` | +| 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 @@ -1008,7 +1017,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud # ~/.config/starship.toml [gcloud] -format = 'on [$symbol$account(\($project\))]($style) ' +format = 'on [$symbol$account(@$domain)(\($project\))]($style) ' ``` #### Display active config name only @@ -1033,22 +1042,22 @@ us-central1 = "uc1" asia-northeast1 = "an1" ``` -## Git Branch +## Git 分支 -The `git_branch` module shows the active branch of the repo in your current directory. +`git_branch` 模組顯示現在的資料夾中使用中的儲存庫的分支。 ### 選項 -| Option | 預設 | 說明 | -| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | -| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | -| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | -| `symbol` | `" "` | A format string representing the symbol of git branch. | -| `style` | `"bold purple"` | 這個模組的風格。 | -| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | -| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | -| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | -| `disabled` | `false` | Disables the `git_branch` module. | +| Option | 預設 | 說明 | +| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------ | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | +| `symbol` | `" "` | A format string representing the symbol of git branch. | +| `style` | `"bold purple"` | 這個模組的風格。 | +| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | +| `truncation_symbol` | `"…"` | 用來指示分支名稱被縮減的符號。 You can use `""` for no symbol. | +| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `disabled` | `false` | 停用 `git_branch` 模組。 | ### Variables @@ -1110,7 +1119,7 @@ tag_symbol = "🔖 " ## Git State -The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. +`git_state` 模組會顯示在 git 儲存庫中的資料夾內，以及會在有作業正在進行時顯示，像是：_REBASING_、_BISECTING_ 等等。 如果有進展的資訊 (像是 REBASING 3/10)，也會一併顯示出來。 ### 選項 @@ -1125,7 +1134,7 @@ The `git_state` module will show in directories which are part of a git reposito | `am_or_rebase` | `"AM/REBASE"` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | | `style` | `"bold yellow"` | 這個模組的風格。 | | `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | The format for the module. | -| `disabled` | `false` | Disables the `git_state` module. | +| `disabled` | `false` | 停用 `git_state` 模組。 | ### Variables @@ -1150,14 +1159,14 @@ cherry_pick = "[🍒 PICKING](bold red)" ## Git Status -The `git_status` module shows symbols representing the state of the repo in your current directory. +`git_status` 模組顯示用來表示現在資料夾之中儲存庫狀態的符號。 ### 選項 | Option | 預設 | 說明 | | ------------ | ----------------------------------------------- | ----------------------------------- | | `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | -| `conflicted` | `"="` | This branch has merge conflicts. | +| `conflicted` | `"="` | 這個分支有合併衝突。 | | `ahead` | `"⇡"` | The format of `ahead` | | `behind` | `"⇣"` | The format of `behind` | | `diverged` | `"⇕"` | The format of `diverged` | @@ -1168,7 +1177,7 @@ The `git_status` module shows symbols representing the state of the repo in your | `renamed` | `"»"` | The format of `renamed` | | `deleted` | `"✘"` | The format of `deleted` | | `style` | `"bold red"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `git_status` module. | +| `disabled` | `false` | 停用 `git_status` 模組。 | ### Variables @@ -1233,28 +1242,29 @@ behind = "⇣${count}" ## Golang -The `golang` module shows the currently installed version of Golang. By default the module will be shown if any of the following conditions are met: +The `golang` module shows the currently installed version of [Golang](https://golang.org/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `go.mod` file -- The current directory contains a `go.sum` file -- The current directory contains a `glide.yaml` file -- The current directory contains a `Gopkg.yml` file -- The current directory contains a `Gopkg.lock` file +- 現在資料夾中含有一個 `go.mod` 檔案 +- 現在資料夾中含有一個 `go.sum` 檔案 +- 現在資料夾中含有一個 `glide.yaml` 檔案 +- 現在資料夾中含有一個 `Gopkg.yml` 檔案 +- 現在資料夾中含有一個 `Gopkg.lock` 檔案 - The current directory contains a `.go-version` file -- The current directory contains a `Godeps` directory -- The current directory contains a file with the `.go` extension +- 現在資料夾中含有一個 `Godeps` 資料夾 +- 現在資料夾中含有一個檔案具有 `.go` 副檔名 ### 選項 -| Option | 預設 | 說明 | -| ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | -| `detect_extensions` | `["go"]` | Which extensions should trigger this module. | -| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. | -| `style` | `"bold cyan"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `golang` module. | +| Option | 預設 | 說明 | +| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | +| `detect_extensions` | `["go"]` | Which extensions should trigger this module. | +| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. | +| `style` | `"bold cyan"` | 這個模組的風格。 | +| `disabled` | `false` | 停用 `golang` 模組。 | ### Variables @@ -1277,22 +1287,23 @@ format = "via [🏎💨 $version](bold cyan) " ## Helm -The `helm` module shows the currently installed version of Helm. By default the module will be shown if any of the following conditions are met: +The `helm` module shows the currently installed version of [Helm](https://helm.sh/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `helmfile.yaml` file +- 現在資料夾中包含一個 `helmfile.yaml` 檔案 - The current directory contains a `Chart.yaml` file ### 選項 -| Option | 預設 | 說明 | -| ------------------- | ------------------------------------ | ------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | -| `style` | `"bold white"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `helm` module. | +| Option | 預設 | 說明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | +| `style` | `"bold white"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `helm` module. | ### Variables @@ -1315,17 +1326,17 @@ format = "via [⎈ $version](bold white) " ## 主機名稱 -The `hostname` module shows the system hostname. +`hostname` 模組顯示系統的主機名稱。 ### 選項 -| Option | 預設 | 說明 | -| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | -| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation | -| `format` | `"[$hostname]($style) in "` | The format for the module. | -| `style` | `"bold dimmed green"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `hostname` module. | +| Option | 預設 | 說明 | +| ---------- | --------------------------- | ---------------------------------------------------------- | +| `ssh_only` | `true` | 只在連接到一個 SSH session 時顯示主機名稱。 | +| `trim_at` | `"."` | 擷取出主機名稱的斷點，以第一個符合的為準。 `"."` 會讓它停在第一個點的符號。 `""` 會停用任何的截斷功能。 | +| `format` | `"[$hostname]($style) in "` | The format for the module. | +| `style` | `"bold dimmed green"` | 這個模組的風格。 | +| `disabled` | `false` | 停用 `hostname` 模組。 | ### Variables @@ -1350,7 +1361,7 @@ disabled = false ## Java -The `java` module shows the currently installed version of Java. By default the module will be shown if any of the following conditions are met: +The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension @@ -1366,7 +1377,7 @@ The `java` module shows the currently installed version of Java. By default the | `detect_folders` | `[]` | Which folders should trigger this modules. | | `symbol` | `"☕ "` | A format string representing the symbol of Java | | `style` | `"red dimmed"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `java` module. | +| `disabled` | `false` | 停用 `java` 模組。 | ### Variables @@ -1387,9 +1398,9 @@ The `java` module shows the currently installed version of Java. By default the symbol = "🌟 " ``` -## Jobs +## 工作 -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. +`jobs` 模組顯示現在正在執行中的工作。 這個模組只會在有背景工作正在執行時顯示。 這個模組會在工作數量超過一個，或者有設定 `threshold` 時且數量超過設定值時，顯示工作的數量。 If `threshold` is set to 0, then the module will also show when there are 0 jobs running. ::: warning @@ -1401,11 +1412,11 @@ This module is not supported on tcsh. | Option | 預設 | 說明 | | ----------- | ----------------------------- | ------------------------------------------------ | -| `threshold` | `1` | Show number of jobs if exceeded. | +| `threshold` | `1` | 在超過指定值時顯示工作數量。 | | `format` | `"[$symbol$number]($style) "` | The format for the module. | | `symbol` | `"✦"` | A format string representing the number of jobs. | | `style` | `"bold blue"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `jobs` module. | +| `disabled` | `false` | 停用 `jobs` 模組。 | ### Variables @@ -1429,7 +1440,7 @@ threshold = 4 ## Julia -The `julia` module shows the currently installed version of Julia. By default the module will be shown if any of the following conditions are met: +The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Project.toml` file - The current directory contains a `Manifest.toml` file @@ -1437,15 +1448,16 @@ The `julia` module shows the currently installed version of Julia. By default th ### 選項 -| Option | 預設 | 說明 | -| ------------------- | ------------------------------------ | ------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `detect_extensions` | `["jl"]` | Which extensions should trigger this module. | -| `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this modules. | -| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | -| `style` | `"bold purple"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `julia` module. | +| Option | 預設 | 說明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["jl"]` | Which extensions should trigger this module. | +| `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | +| `style` | `"bold purple"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `julia` module. | ### Variables @@ -1468,7 +1480,7 @@ symbol = "∴ " ## Kotlin -The `kotlin` module shows the currently installed version of Kotlin. By default the module will be shown if any of the following conditions are met: +The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `.kt` or a `.kts` file @@ -1477,6 +1489,7 @@ The `kotlin` module shows the currently installed version of Kotlin. By default | Option | 預設 | 說明 | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `detect_extensions` | `["kt", "kts"]` | Which extensions should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this modules. | @@ -1514,11 +1527,11 @@ kotlin_binary = "kotlinc" ## Kubernetes -Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-cluster --namespace astronaut`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. +Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-cluster --namespace astronaut`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 ::: @@ -1555,15 +1568,15 @@ disabled = false "dev.local.cluster.k8s" = "dev" ``` -## Line Break +## 換行 -The `line_break` module separates the prompt into two lines. +`line_break` 模組將提示字元分成兩行。 ### 選項 -| Option | 預設 | 說明 | -| ---------- | ------- | ------------------------------------------------------------------ | -| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | +| Option | 預設 | 說明 | +| ---------- | ------- | ----------------------------- | +| `disabled` | `false` | 停用 `line_break` 模組，讓提示字元變成一行。 | ### 範例 @@ -1576,7 +1589,7 @@ disabled = true ## Lua -The `lua` module shows the currently installed version of Lua. By default the module will be shown if any of the following conditions are met: +The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `.lua-version` file - The current directory contains a `lua` directory @@ -1587,6 +1600,7 @@ The `lua` module shows the currently installed version of Lua. By default the mo | Option | 預設 | 說明 | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `detect_extensions` | `["lua"]` | Which extensions should trigger this module. | | `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. | @@ -1614,27 +1628,27 @@ The `lua` module shows the currently installed version of Lua. By default the mo format = "via [🌕 $version](bold blue) " ``` -## Memory Usage +## 記憶體使用量 -The `memory_usage` module shows current system memory and swap usage. +`memory_usage` 模組顯示現在系統記憶體與 swap 的使用量。 -By default the swap usage is displayed if the total system swap is non-zero. +預設 swap 使用量會在系統總 swap 使用量不為 0 時顯示出來。 ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 ::: ### 選項 -| Option | 預設 | 說明 | -| ----------- | ----------------------------------------------- | -------------------------------------------------------- | -| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | -| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | The format for the module. | -| `symbol` | `"🐏"` | The symbol used before displaying the memory usage. | -| `style` | `"bold dimmed white"` | 這個模組的風格。 | -| `disabled` | `true` | Disables the `memory_usage` module. | +| Option | 預設 | 說明 | +| ----------- | ----------------------------------------------- | -------------------------- | +| `threshold` | `75` | 將記憶體使用量隱藏，除非使用量超過指定值。 | +| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | The format for the module. | +| `symbol` | `"🐏"` | 顯示在記憶體使用量之前的符號。 | +| `style` | `"bold dimmed white"` | 這個模組的風格。 | +| `disabled` | `true` | 停用 `memory_usage` 模組。 | ### Variables @@ -1673,7 +1687,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc | `style` | `"bold purple"` | 這個模組的風格。 | | `format` | `"on [$symbol$branch]($style) "` | The format for the module. | | `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | -| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. | +| `truncation_symbol` | `"…"` | 用來指示分支名稱被縮減的符號。 | | `disabled` | `true` | Disables the `hg_branch` module. | ### Variables @@ -1699,24 +1713,25 @@ truncation_symbol = "" ## Nim -The `nim` module shows the currently installed version of Nim. By default the module will be shown if any of the following conditions are met: +The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met: -- 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 ### 選項 -| Option | 預設 | 說明 | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module | -| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | -| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. | -| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold yellow"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `nim` module. | +| Option | 預設 | 說明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | +| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. | +| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold yellow"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `nim` module. | ### Variables @@ -1740,7 +1755,7 @@ symbol = "🎣 " ## Nix-shell -The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment. +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. 這個模組會在 nix-shell 環境中顯示。 ### 選項 @@ -1751,7 +1766,7 @@ The `nix_shell` module shows the nix-shell environment. The module will be shown | `style` | `"bold blue"` | 這個模組的風格。 | | `impure_msg` | `"impure"` | A format string shown when the shell is impure. | | `pure_msg` | `"pure"` | A format string shown when the shell is pure. | -| `disabled` | `false` | Disables the `nix_shell` module. | +| `disabled` | `false` | 停用 `nix_shell` 模組。 | ### Variables @@ -1776,30 +1791,30 @@ pure_msg = "[pure shell](bold green)" format = 'via [☃️ $state( \($name\))](bold blue) ' ``` -## NodeJS +## Node.js -The `nodejs` module shows the currently installed version of NodeJS. By default the module will be shown if any of the following conditions are met: +The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `package.json` file +- 現在資料夾中包含一個 `package.json` 檔案 - The current directory contains a `.node-version` file - The current directory contains a `.nvmrc` file -- The current directory contains a `node_modules` directory +- 現在資料夾中包含一個 `node_modules` 資料夾 - The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension - The current directory contains a file with the `.ts` extension ### 選項 -| Option | 預設 | 說明 | -| ------------------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | A format string representing the symbol of NodeJS. | -| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. | -| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | -| `style` | `"bold green"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `nodejs` module. | -| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the NodeJS version. | +| Option | 預設 | 說明 | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | A format string representing the symbol of Node.js. | +| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. | +| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | +| `style` | `"bold green"` | 這個模組的風格。 | +| `disabled` | `false` | 停用 `nodejs` 模組。 | +| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | ### Variables @@ -1822,7 +1837,7 @@ format = "via [🤖 $version](bold green) " ## OCaml -The `ocaml` module shows the currently installed version of OCaml. By default the module will be shown if any of the following conditions are met: +The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a `esy.lock` directory @@ -1833,17 +1848,18 @@ The `ocaml` module shows the currently installed version of OCaml. By default th ### 選項 -| Option | 預設 | 說明 | -| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------- | -| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. | -| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | -| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. | -| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. | -| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this module. | -| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. | -| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. | -| `style` | `"bold yellow"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `ocaml` module. | +| Option | 預設 | 說明 | +| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | +| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. | +| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. | +| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this module. | +| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. | +| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. | +| `style` | `"bold yellow"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `ocaml` module. | ### Variables @@ -1901,32 +1917,32 @@ style = "bold yellow" symbol = "☁️ " ``` -## Package Version +## 套件版本 -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages. +The `package` 模組在現在資料夾是一個套件的儲藏庫時出現，並顯示他的現在版本。 這個模組目前支援 `npm`、`cargo`、`poetry`、`composer`、`gradle`、`julia`、`mix`, 跟 `helm` 套件 -- **npm** – The `npm` package version is extracted from the `package.json` present in the current directory -- **cargo** – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory -- **poetry** – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory -- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory -- **gradle** – The `gradle` package version is extracted from the `build.gradle` present -- **julia** - The package version is extracted from the `Project.toml` present -- **mix** - The `mix` package version is extracted from the `mix.exs` present -- **helm** - The `helm` chart version is extracted from the `Chart.yaml` present -- **maven** - The `maven` package version is extracted from the `pom.xml` present -- **meson** - The `meson` package version is extracted from the `meson.build` present +- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory +- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory +- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory +- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory +- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present +- [**julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present +- [**mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present +- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present +- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present +- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present > ⚠️ 顯示出來的版本是從你的現在資料夾之中擷取出來的，並非從套件管理員取得。 ### 選項 -| Option | 預設 | 說明 | -| ----------------- | --------------------------------- | ---------------------------------------------------------- | -| `format` | `"is [$symbol$version]($style) "` | The format for the module. | -| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | -| `style` | `"bold 208"` | 這個模組的風格。 | -| `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | Disables the `package` module. | +| Option | 預設 | 說明 | +| ----------------- | --------------------------------- | --------------------------------------------------------- | +| `format` | `"is [$symbol$version]($style) "` | The format for the module. | +| `symbol` | `"📦 "` | 顯示在套件的版本之前的符號。 | +| `style` | `"bold 208"` | 這個模組的風格。 | +| `display_private` | `false` | Enable displaying version for packages marked as private. | +| `disabled` | `false` | 停用 `package` 模組。 | ### Variables @@ -1949,7 +1965,7 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file @@ -1959,15 +1975,16 @@ The `perl` module shows the currently installed version of Perl. By default the ### 選項 -| Option | 預設 | 說明 | -| ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | -| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | -| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | -| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 149"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `perl` module. | +| Option | 預設 | 說明 | **** | +| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---- | +| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | +| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | +| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | | +| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | | +| `detect_folders` | `[]` | Which folders should trigger this module. | | +| `style` | `"bold 149"` | 這個模組的風格。 | | +| `disabled` | `false` | Disables the `perl` module. | | ### Variables @@ -1988,23 +2005,24 @@ format = "via [🦪 $version]($style) " ## PHP -The `php` module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `composer.json` file +- 現在資料夾中包含一個 `composer.json` 檔案 - The current directory contains a `.php-version` file - The current directory contains a `.php` extension ### 選項 -| Option | 預設 | 說明 | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | -| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | -| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"147 bold"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `php` module. | +| Option | 預設 | 說明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | +| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"147 bold"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `php` module. | ### Variables @@ -2027,22 +2045,23 @@ format = "via [🔹 $version](147 bold) " ## PureScript -The `purescript` module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: -- The current directory contains a `spago.dhall` file +- 現在資料夾中包含一個 `spago.dhall` 檔案 - The current directory contains a file with the `.purs` extension ### 選項 -| Option | 預設 | 說明 | -| ------------------- | ------------------------------------ | ------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | -| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold white"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `purescript` module. | +| Option | 預設 | 說明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | +| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | +| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold white"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `purescript` module. | ### Variables @@ -2065,20 +2084,20 @@ format = "via [$symbol$version](bold white)" ## Python -The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. By default the module will be shown if any of the following conditions are met: -- The current directory contains a `.python-version` file -- The current directory contains a `Pipfile` file +- 目前資料夾中有一個 `.python-version` 檔案 +- 目前資料夾中有一個 `Pipfile` 檔案 - The current directory contains a `__init__.py` file -- The current directory contains a `pyproject.toml` file -- The current directory contains a `requirements.txt` file -- The current directory contains a `setup.py` file -- The current directory contains a `tox.ini` file -- The current directory contains a file with the `.py` extension. +- 目前資料夾中有一個 `pyproject.toml` 檔案 +- 目前資料夾中有一個 `requirements.txt` 檔案 +- 現在資料夾中包含一個 `setup.py` 檔案 +- 目前資料夾中有一個 `tox.ini` 檔案 +- 目前資料夾中有一個 `.py` 副檔名的檔案. - A virtual environment is currently activated ### 選項 @@ -2089,13 +2108,13 @@ By default the module will be shown if any of the following conditions are met: | `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | 這個模組的風格。 | -| `pyenv_version_name` | `false` | Use pyenv to get Python version | +| `pyenv_version_name` | `false` | 使用 pyenv 取得 Python 的版本。 | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `["python", "python3, "python2"]` | Configures the python binaries that Starship should executes when getting the version. | -| `detect_extensions` | `[".py"]` | Which extensions should trigger this module | +| `detect_extensions` | `["py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | -| `disabled` | `false` | Disables the `python` module. | +| `disabled` | `false` | 停用 `python` 模組。 | ::: tip @@ -2143,7 +2162,7 @@ detect_extensions = [] ## Red -By default the `red` module shows the currently installed version of Red. The module will be shown if any of the following conditions are met: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). 這個模組在下列其中一個條件達成時顯示： - The current directory contains a file with `.red` or `.reds` extension @@ -2181,11 +2200,11 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). 這個模組在下列其中一個條件達成時顯示： -- The current directory contains a `Gemfile` file +- 目前資料夾中有一個 `Gemfile` 檔案 - The current directory contains a `.ruby-version` file -- The current directory contains a `.rb` file +- 目前資料夾中有一個 `.rb` 檔案 ### 選項 @@ -2198,7 +2217,7 @@ By default the `ruby` module shows the currently installed version of Ruby. The | `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold red"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `ruby` module. | +| `disabled` | `false` | 停用 `ruby` 模組。 | ### Variables @@ -2221,10 +2240,10 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). 這個模組在下列其中一個條件達成時顯示： -- The current directory contains a `Cargo.toml` file -- The current directory contains a file with the `.rs` extension +- 目前資料夾中有一個 `Cargo.toml` 檔案 +- 現在資料夾中包含一個檔案具有 `.rs` 副檔名 ### 選項 @@ -2237,7 +2256,7 @@ By default the `rust` module shows the currently installed version of Rust. The | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold red"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `rust` module. | +| `disabled` | `false` | 停用 `rust` 模組。 | ### Variables @@ -2260,7 +2279,7 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension @@ -2268,15 +2287,16 @@ The `scala` module shows the currently installed version of Scala. By default th ### 選項 -| Option | 預設 | 說明 | -| ------------------- | ---------------------------------------- | ------------------------------------------------- | -| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | -| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | -| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | -| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | -| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | -| `style` | `"red dimmed"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `scala` module. | +| Option | 預設 | 說明 | +| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["sbt", "scala"]` | Which extensions should trigger this module. | +| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | +| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `style` | `"red dimmed"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `scala` module. | ### Variables @@ -2303,23 +2323,24 @@ The `shell` module shows an indicator for currently used shell. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 ::: ### 選項 -| Option | 預設 | 說明 | -| ---------------------- | ------------ | --------------------------------------------- | -| `bash_indicator` | `bsh` | A format string used to represent bash. | -| `fish_indicator` | `fsh` | A format string used to represent fish. | -| `zsh_indicator` | `zsh` | A format string used to represent zsh. | -| `powershell_indicator` | `psh` | A format string used to represent powershell. | -| `ion_indicator` | `ion` | A format string used to represent ion. | -| `elvish_indicator` | `esh` | A format string used to represent elvish. | -| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | -| `format` | `$indicator` | The format for the module. | -| `disabled` | `true` | Disables the `shell` module. | +| Option | 預設 | 說明 | +| ---------------------- | ------------ | ------------------------------------------------------------ | +| `bash_indicator` | `bsh` | A format string used to represent bash. | +| `fish_indicator` | `fsh` | A format string used to represent fish. | +| `zsh_indicator` | `zsh` | A format string used to represent zsh. | +| `powershell_indicator` | `psh` | A format string used to represent powershell. | +| `ion_indicator` | `ion` | A format string used to represent ion. | +| `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | +| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `format` | `$indicator` | The format for the module. | +| `disabled` | `true` | Disables the `shell` module. | ### Variables @@ -2335,6 +2356,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [shell] fish_indicator = "" powershell_indicator = "_" +unknown_indicator = "mystery shell" disabled = false ``` @@ -2376,7 +2398,7 @@ threshold = 3 ## Singularity -The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### 選項 @@ -2391,7 +2413,7 @@ The `singularity` module shows the current singularity image, if inside a contai | 變數 | 範例 | 說明 | | --------- | ------------ | ------------------------------------ | -| env | `centos.img` | The current singularity image | +| env | `centos.img` | The current Singularity image | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2412,7 +2434,7 @@ The `status` module displays the exit code of the previous command. The module w ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 ::: @@ -2465,22 +2487,23 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). 這個模組在下列其中一個條件達成時顯示： - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension ### 選項 -| Option | 預設 | 說明 | -| ------------------- | ------------------------------------ | ------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | -| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"bold 202"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `swift` module. | +| Option | 預設 | 說明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | +| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold 202"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `swift` module. | ### Variables @@ -2503,11 +2526,11 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: 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). +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-terraform-version). ::: @@ -2518,22 +2541,23 @@ By default the module will be shown if any of the following conditions are met: ### 選項 -| Option | 預設 | 說明 | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | -| `symbol` | `"💠"` | A format string shown before the terraform workspace. | -| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | -| `style` | `"bold 105"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `terraform` module. | +| Option | 預設 | 說明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | +| `detect_extensions` | `["tf", "hcl"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | +| `style` | `"bold 105"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `terraform` module. | ### Variables | 變數 | 範例 | 說明 | | --------- | ---------- | ------------------------------------ | | version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current terraform workspace | +| workspace | `default` | The current Terraform workspace | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2541,7 +2565,7 @@ By default the module will be shown if any of the following conditions are met: ### 範例 -#### With Version +#### With Terraform Version ```toml # ~/.config/starship.toml @@ -2550,7 +2574,7 @@ By default the module will be shown if any of the following conditions are met: format = "[🏎💨 $version$workspace]($style) " ``` -#### Without version +#### Without Terraform version ```toml # ~/.config/starship.toml @@ -2561,33 +2585,33 @@ 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) crate 用來控制時間如何顯示。 請看 [chrono 的 strftime 文件](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)來了解有那些選項可以使用。 ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 ::: ### 選項 -| Option | 預設 | 說明 | -| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `format` | `"at [$time]($style) "` | The format string for the module. | -| `use_12hr` | `false` | Enables 12 hour formatting | -| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | -| `style` | `"bold yellow"` | The style for the module time | -| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | -| `disabled` | `true` | Disables the `time` module. | -| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| Option | 預設 | 說明 | +| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | +| `format` | `"at [$time]($style) "` | The format string for the module. | +| `use_12hr` | `false` | 啟用 12 小時格式。 | +| `time_format` | 請看下列 | 用來顯示時間的 [chrono 格式字串](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)。 | +| `style` | `"bold yellow"` | 這個模組的時間的風格。 | +| `utc_time_offset` | `"local"` | 設定相對於 UTC 的時差。 Range from -24 < x < 24. 允許使用浮點數來表示 30/45 分鐘時差的時區。 | +| `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 | 變數 | 範例 | 說明 | | --------- | ---------- | ----------------------------------- | -| time | `13:08:10` | The current time. | +| 時間 | `13:08:10` | The current time. | | style\* | | Mirrors the value of option `style` | \*: This variable can only be used as a part of a style string @@ -2605,14 +2629,14 @@ utc_time_offset = "-5" time_range = "10:00:00-14:00:00" ``` -## Username +## 使用者名稱 -The `username` module shows active user's username. The module will be shown if any of the following conditions are met: +`username` 模組顯示現在使用中的使用者名稱。 這個模組在下列其中一個條件達成時顯示： -- The current user is root -- The current user isn't the same as the one that is logged in -- The user is currently connected as an SSH session -- The variable `show_always` is set to true +- 目前使用者為 root +- 目前使用者並非登入時的使用者 +- 使用者透過 SSH session 進行連線 +- 變數 `show_always` 被設為 true ::: tip @@ -2622,13 +2646,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### 選項 -| Option | 預設 | 說明 | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `style_user` | `"bold yellow"` | The style used for non-root users. | -| `format` | `"[$user]($style) in "` | The format for the module. | -| `show_always` | `false` | Always shows the `username` module. | -| `disabled` | `false` | Disables the `username` module. | +| Option | 預設 | 說明 | +| ------------- | ----------------------- | -------------------------- | +| `style_root` | `"bold red"` | 使用者為 root 時使用的風格。 | +| `style_user` | `"bold yellow"` | 非 root 使用者時使用的風格。 | +| `format` | `"[$user]($style) in "` | The format for the module. | +| `show_always` | `false` | 總是顯示 `username` 模組。 | +| `disabled` | `false` | 停用 `username` 模組。 | ### Variables @@ -2652,21 +2676,22 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default the module will be shown if any of the following conditions are met: - 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. | -| `detect_extensions` | `[]` | Which extensions should trigger this module. | -| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | -| `style` | `"cyan bold"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `vagrant` module. | +| Option | 預設 | 說明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"cyan bold"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables @@ -2689,7 +2714,7 @@ format = "via [⍱ $version](bold white) " ## VCSH -The `vcsh` module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### 選項 @@ -2721,21 +2746,22 @@ format = "[🆅 $repo](bold blue) " ## Zig -By default the the `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). 這個模組在下列其中一個條件達成時顯示： - The current directory contains a `.zig` file ### 選項 -| Option | 預設 | 說明 | -| ------------------- | ------------------------------------ | ----------------------------------------------------- | -| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | -| `style` | `"bold yellow"` | 這個模組的風格。 | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables the `zig` module. | -| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | -| `detect_folders` | `[]` | Which folders should trigger this module. | +| Option | 預設 | 說明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | +| `style` | `"bold yellow"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `zig` module. | +| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | ### Variables @@ -2792,7 +2818,7 @@ The order in which custom modules are shown can be individually set by including | `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | | `shell` | | [See below](#custom-command-shell) | -| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `說明` | `""` | The description of the module that is shown when running `starship explain`. | | `files` | `[]` | The files that will be searched in the working directory for a match. | | `directories` | `[]` | The directories that will be searched in the working directory for a match. | | `extensions` | `[]` | The extensions that will be searched in the working directory for a match. |