diff options
| author | jliaoh <48660001+hunterliao29@users.noreply.github.com> | 2023-04-02 10:39:45 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-02 16:39:45 +0200 |
| commit | d29ce7c45d4ea21a6e14ad308bd50cb0e61d1ef8 (patch) | |
| tree | 74ee7d5c91dc389679557752a5ef1a2132c1ea70 /docs/config/README.md | |
| parent | d2801ac44301dcef1f87ab5fd26abee36997f71d (diff) | |
feat(custom): add option to check if pwd is in a repo (#4822)
* feat(custom): add option to check if pwd is in a repo
* Apply suggestions from code review
Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
* change whenrepo to require_repo
* chore: fix doc formatting
---------
Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
Diffstat (limited to 'docs/config/README.md')
| -rw-r--r-- | docs/config/README.md | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 118baf63f..32d3d3afb 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -4346,6 +4346,7 @@ Format strings can also contain shell specific prompt sequences, e.g. | ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | +| `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. | | `shell` | | [See below](#custom-command-shell) | | `description` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. | |