Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-12-01 01:04:00 +00:00
Code Issues Releases Activity

docs: Update docs w/ details on fish-style truncation (#948)

Browse Source
This commit is contained in:
Kevin Song 2020-02-20 18:08:20 -06:00 committed by GitHub
parent 53c6639540
commit c6d8031f36
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
docs/config/README.md
View File

@ -360,6 +360,12 @@ it would have been `nixpkgs/pkgs`.
| `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` | The number of characters to use when applying fish shell pwd path logic. |
| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. | | `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. |
`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`.
</details> </details>
### Example ### Example
@ -418,11 +424,11 @@ The module will be shown if any of the following conditions are met:
### Options ### Options
| Variable | Default | Description | | Variable | Default | Description |
| ---------- | ------------- | --------------------------------------------------------- | | ---------- | ------------- | ----------------------------------------------------- |
| `symbol` | `"🌳 "` | The symbol used before displaying the version of Elm. | | `symbol` | `"🌳 "` | The symbol used before displaying the version of Elm. |
| `style` | `"bold cyan"` | The style for the module. | | `style` | `"bold cyan"` | The style for the module. |
| `disabled` | `false` | Disables the `elm` module. | | `disabled` | `false` | Disables the `elm` module. |
### Example ### Example
@ -562,7 +568,7 @@ current directory.
| `untracked` | `"?"` | There are untracked files in the working directory. | | `untracked` | `"?"` | There are untracked files in the working directory. |
| `untracked_count` | [link](#git-status-counts) | Show and style the number of untracked files. | | `untracked_count` | [link](#git-status-counts) | Show and style the number of untracked files. |
| `stashed` | `"$"` | A stash exists for the local repository. | | `stashed` | `"$"` | A stash exists for the local repository. |
| `stashed_count` | [link](#git-status-counts) | Show and style the number of stashes. | | `stashed_count` | [link](#git-status-counts) | Show and style the number of stashes. |
| `modified` | `"!"` | There are file modifications in the working directory. | | `modified` | `"!"` | There are file modifications in the working directory. |
| `modified_count` | [link](#git-status-counts) | Show and style the number of modified files. | | `modified_count` | [link](#git-status-counts) | Show and style the number of modified files. |
| `staged` | `"+"` | A new file has been added to the staging area. | | `staged` | `"+"` | A new file has been added to the staging area. |
@ -643,11 +649,11 @@ The module will be shown if any of the following conditions are met:
### Options ### Options
| Variable | Default | Description | | Variable | Default | Description |
| ---------- | ------------- | --------------------------------------------------------- | | ---------- | ------------ | --------------------------------------------------------- |
| `symbol` | `"λ "` | The symbol used before displaying the version of Haskell. | | `symbol` | `"λ "` | The symbol used before displaying the version of Haskell. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `haskell` module. | | `disabled` | `false` | Disables the `haskell` module. |
### Example ### Example
@ -829,7 +835,7 @@ The module will be shown if any of the following conditions are met:
| Variable | Default | Description | | Variable | Default | Description |
| ---------- | -------------- | ------------------------------------------------------ | | ---------- | -------------- | ------------------------------------------------------ |
| `symbol` | `"☕ "` | The symbol used before displaying the version of Java. | | `symbol` | `"☕ "` | The symbol used before displaying the version of Java. |
| `style` | `"dimmed red"` | The style for the module. | | `style` | `"dimmed red"` | The style for the module. |
| `disabled` | `false` | Disables the `java` module. | | `disabled` | `false` | Disables the `java` module. |
@ -891,11 +897,11 @@ The module will be shown if any of the following conditions are met:
### Options ### Options
| Variable | Default | Description | | Variable | Default | Description |
| ---------- | ------------ | ------------------------------------------------------------ | | ---------- | ------------ | --------------------------------------------------------- |
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | | `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `crystal` module. | | `disabled` | `false` | Disables the `crystal` module. |
### Example ### Example