Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-05-28 14:10:53 +00:00
Code Issues Releases Activity

docs: Alphabetic sorting of config subsections (#1877)

Browse Source
This commit is contained in:
Giorgio Gallo 2020-11-14 19:41:58 +01:00 committed by GitHub
parent ac88301294
commit 045ee17817
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 124 additions and 124 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

248
docs/config/README.md
View File

@ -1744,58 +1744,6 @@ The module will be shown if any of the following conditions are met:
format = "via [🤖 $version](bold green) "
```
## 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.
- **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
> ⚠️ The version being shown is that of the package whose source code is in your
> current directory, not your package manager.
### Options
| Option | Default | Description |
| ----------------- | ---------------------------------- | ---------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"📦 "` | The symbol used before displaying the version the package. |
| `style` | `"bold 208"` | The style for the module. |
| `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | Disables the `package` module. |
### Variables
| Variable | Example | Description |
| -------- | -------- | ------------------------------------ |
| version | `v1.0.0` | The version of your package |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[package]
format = "via [🎁 $version](208 bold) "
```
## OCaml
The `ocaml` module shows the currently installed version of OCaml.
@ -1874,6 +1822,58 @@ 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.
- **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
> ⚠️ The version being shown is that of the package whose source code is in your
> current directory, not your package manager.
### Options
| Option | Default | Description |
| ----------------- | ---------------------------------- | ---------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"📦 "` | The symbol used before displaying the version the package. |
| `style` | `"bold 208"` | The style for the module. |
| `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | Disables the `package` module. |
### Variables
| Variable | Example | Description |
| -------- | -------- | ------------------------------------ |
| version | `v1.0.0` | The version of your package |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[package]
format = "via [🎁 $version](208 bold) "
```
## Perl
The `perl` module shows the currently installed version of Perl.
@ -1948,6 +1948,42 @@ The module will be shown if any of the following conditions are met:
format = "via [🔹 $version](147 bold) "
```
## PureScript
The `purescript` module shows the currently installed version of PureScript version.
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 \*.purs files
### Options
| Option | Default | Description |
| ---------- | ---------------------------------- | ------------------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | The style for the module. |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables
| Variable | Example | Description |
| -------- | -------- | ------------------------------------ |
| version | `0.13.5` | The version of `purescript` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[purescript]
format = "via [$symbol$version](bold white)"
```
## Python
The `python` module shows the currently installed version of Python and the
@ -2156,42 +2192,6 @@ and `$SINGULARITY_NAME` is set.
format = '[📦 \[$env\]]($style) '
```
## Swift
The `swift` module shows the currently installed version of Swift.
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 |
| `style` | `"bold 202"` | The style for the module. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables
| Variable | Example | Description |
| -------- | -------- | ------------------------------------ |
| version | `v5.2.4` | The version of `swift` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[swift]
format = "via [🏎 $version](red bold)"
```
## Status
The `status` module displays the exit code of the previous command.
@ -2236,6 +2236,42 @@ disabled = false
```
## Swift
The `swift` module shows the currently installed version of Swift.
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 |
| `style` | `"bold 202"` | The style for the module. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables
| Variable | Example | Description |
| -------- | -------- | ------------------------------------ |
| version | `v5.2.4` | The version of `swift` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[swift]
format = "via [🏎 $version](red bold)"
```
## Terraform
The `terraform` module shows the currently selected terraform workspace and version.
@ -2526,39 +2562,3 @@ command = "time /T"
files = ["*.pst"]
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]
```
## PureScript
The `purescript` module shows the currently installed version of PureScript version.
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 \*.purs files
### Options
| Option | Default | Description |
| ---------- | ---------------------------------- | ------------------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | The style for the module. |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables
| Variable | Example | Description |
| -------- | -------- | ------------------------------------ |
| version | `0.13.5` | The version of `purescript` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[purescript]
format = "via [$symbol$version](bold white)"
```