From a48bb8b79a0294c7584d635b3434b3f63109b2f9 Mon Sep 17 00:00:00 2001 From: Jonathan Dahan Date: Wed, 21 Aug 2019 01:51:28 -0400 Subject: [PATCH] Cleanup options documentation --- options.md | 271 ++++++++++++++++++++++++++--------------------------- 1 file changed, 135 insertions(+), 136 deletions(-) diff --git a/options.md b/options.md index 59ca6bfd..c4f7b5f4 100644 --- a/options.md +++ b/options.md @@ -8,9 +8,9 @@ and functionality. - [Customization Options](#customization-options) - [Table of Contents](#table-of-contents) - - [`geometry_docker_machine.zsh`](#geometrydockermachinezsh) - - [`geometry_exec_time.zsh`](#geometryexectimezsh) - - [`geometry_git.zsh`](#geometrygitzsh) + - [`geometry_docker_machine`](#geometrydockermachine) + - [`geometry_exec_time`](#geometryexectime) + - [`geometry_git`](#geometrygit) - [`geometry_git_stashes()`](#geometrygitstashes) - [`geometry_git_time()`](#geometrygittime) - [`geometry_git_branch()`](#geometrygitbranch) @@ -20,213 +20,212 @@ and functionality. - [`geometry_git_conflicts()`](#geometrygitconflicts) - [`geometry_git()`](#geometrygit) - [`geometry::git_wrapper`](#geometrygitwrapper) - - [`geometry_hg.zsh`](#geometryhgzsh) - - [`geometry_hostname.zsh`](#geometryhostnamezsh) - - [`geometry_jobs.zsh`](#geometryjobszsh) - - [`geometry_kube.zsh`](#geometrykubezsh) - - [`geometry_node.zsh`](#geometrynodezsh) - - [`geometry_npm_package_version.zsh`](#geometrynpmpackageversionzsh) - - [`geometry_path.zsh`](#geometrypathzsh) - - [`geometry_ruby.zsh`](#geometryrubyzsh) - - [`geometry_rust_version.zsh`](#geometryrustversionzsh) - - [`geometry_rustup.zsh`](#geometryrustupzsh) - - [`geometry_status.zsh`](#geometrystatuszsh) - - [`geometry_virtualenv.zsh`](#geometryvirtualenvzsh) + - [`geometry_hg`](#geometryhg) + - [`geometry_hostname`](#geometryhostname) + - [`geometry_jobs`](#geometryjobs) + - [`geometry_kube`](#geometrykube) + - [`geometry_node`](#geometrynode) + - [`geometry_npm_package_version`](#geometrynpmpackageversion) + - [`geometry_path`](#geometrypath) + - [`geometry_ruby`](#geometryruby) + - [`geometry_rust_version`](#geometryrustversion) + - [`geometry_rustup`](#geometryrustup) + - [`geometry_status`](#geometrystatus) + - [`geometry_virtualenv`](#geometryvirtualenv) -## `geometry_docker_machine.zsh` +## `geometry_docker_machine` Show the docker machine name. -| Variable | Description | Defaults | -| -------------------------------- | ------------------------------- | -------- | -| `GEOMETRY_DOCKER_MACHINE_SYMBOL` | Indicator. | `⚓` | -| `GEOMETRY_DOCKER_MACHINE_COLOR` | Text color of the machine name. | `blue` | +| Variable | Description | Default | +| -------------------------------- | ------------------------- | ------- | +| `GEOMETRY_DOCKER_MACHINE_SYMBOL` | Indicator | `⚓` | +| `GEOMETRY_DOCKER_MACHINE_COLOR` | Color of the machine name | `blue` | -## `geometry_exec_time.zsh` +## `geometry_exec_time` Show the elapsed time for long running commands. -| Variable | Description | Defaults | -| ----------------------------- | --------------------------------------------- | -------- | -| `GEOMETRY_EXEC_TIME_FILE` | Path to temp direcotry, where file is stored. | | -| `GEOMETRY_EXEC_TIME_PATIENCE` | Seconds before the time is shown. | | +| Variable | Description | Default | +| ----------------------------- | -------------------------------------------- | -------- | +| `GEOMETRY_EXEC_TIME_PATIENCE` | Seconds before the time is shown | `5` | -## `geometry_git.zsh` +## `geometry_git` Show git related information, such as branch name, status and time since last commit. -| Variable | Description | Defaults | -| ------------------- | ------------------------------- | -------------------- | -| `GEOMETRY_GIT_GREP` | Used to override our searching. | `rg` > `ag` > `grep` | +| Variable | Description | Default | +| ------------------- | ------------------------------ | -------------------- | +| `GEOMETRY_GIT_GREP` | Used to override our searching | `rg` > `ag` > `grep` | ##### `geometry_git_stashes()` -| Variable | Description | Defaults | -| ----------------------------- | ----------- | -------- | -| `GEOMETRY_GIT_SYMBOL_STASHES` | Indicator. | `●` | -| `GEOMETRY_GIT_COLOR_STASHES` | Color. | `144` | +| Variable | Description | Default | +| ----------------------------- | ----------- | ------- | +| `GEOMETRY_GIT_SYMBOL_STASHES` | Indicator | `●` | +| `GEOMETRY_GIT_COLOR_STASHES` | Color | `144` | ##### `geometry_git_time()` -| Variable | Description | Defaults | -| --------------------------------- | ------------------------------------------- | ------------ | -| `GEOMETRY_COLOR_NO_TIME` | Text color. | `white` | -| `GEOMETRY_GIT_NO_COMMITS_MESSAGE` | Text message shown when there's no commits. | `no-commits` | -| `GEOMETRY_GIT_TIME_DETAILED` | Detailed timestamp instead of simple. | `false` | +| Variable | Description | Default | +| --------------------------------- | ------------------------------------------ | ------------ | +| `GEOMETRY_COLOR_NO_TIME` | Text color | `white` | +| `GEOMETRY_GIT_NO_COMMITS_MESSAGE` | Text message shown when there's no commits | `no-commits` | +| `GEOMETRY_GIT_TIME_DETAILED` | Detailed timestamp instead of simple | `false` | ##### `geometry_git_branch()` -| Variable | Description | Defaults | -| --------------------------- | ---------------------- | -------- | -| `GEOMETRY_GIT_COLOR_BRANCH` | Color for branch name. | `242` | +| Variable | Description | Default | +| --------------------------- | --------------------- | ------- | +| `GEOMETRY_GIT_COLOR_BRANCH` | Color for branch name | `242` | ##### `geometry_git_status()` -| Variable | Description | Defaults | -| --------------------------- | -------------------------- | -------- | -| `GEOMETRY_GIT_COLOR_DIRTY` | Color for dirty indicator. | `red` | -| `GEOMETRY_GIT_SYMBOL_DIRTY` | Indicator when dirty. | `⬡` | -| `GEOMETRY_GIT_COLOR_CLEAN` | Color for clean indicator. | `green` | -| `GEOMETRY_GIT_SYMBOL_CLEAN` | Indicator when clean. | `⬢` | +| Variable | Description | Default | +| --------------------------- | ------------------------- | ------- | +| `GEOMETRY_GIT_COLOR_DIRTY` | Color for dirty indicator | `red` | +| `GEOMETRY_GIT_SYMBOL_DIRTY` | Indicator when dirty | `⬡` | +| `GEOMETRY_GIT_COLOR_CLEAN` | Color for clean indicator | `green` | +| `GEOMETRY_GIT_SYMBOL_CLEAN` | Indicator when clean | `⬢` | ##### `geometry_git_rebase()` -| Variable | Description | Defaults | -| ---------------------------- | ----------- | -------- | -| `GEOMETRY_GIT_SYMBOL_REBASE` | Indicator. | `®` | +| Variable | Description | Default | +| ---------------------------- | ----------- | ------- | +| `GEOMETRY_GIT_SYMBOL_REBASE` | Indicator | `®` | ##### `geometry_git_remote() ` -| Variable | Description | Defaults | -| ------------------------------ | ------------------- | -------- | -| `GEOMETRY_GIT_SYMBOL_UNPUSHED` | Unpushed indicator. | `⇡` | -| `GEOMETRY_GIT_SYMBOL_UNPULLED` | Unpulled indicator. | `⇣` | +| Variable | Description | Default | +| ------------------------------ | ------------------ | ------- | +| `GEOMETRY_GIT_SYMBOL_UNPUSHED` | Unpushed indicator | `⇡` | +| `GEOMETRY_GIT_SYMBOL_UNPULLED` | Unpulled indicator | `⇣` | ##### `geometry_git_conflicts()` -| Variable | Description | Defaults | -| ---------------------------------------- | ----------------------------- | -------- | -| `GEOMETRY_GIT_COLOR_CONFLICTS_UNSOLVED` | Unsolved conflicts color. | `red` | -| `GEOMETRY_GIT_COLOR_CONFLICTS_SOLVED` | Solved conflicts color. | `green` | -| `GEOMETRY_GIT_SYMBOL_CONFLICTS_SOLVED` | Solved conflicts indicator. | `◆` | -| `GEOMETRY_GIT_SYMBOL_CONFLICTS_UNSOLVED` | Unsolved conflicts indicator. | `◈` | +| Variable | Description | Default | +| ---------------------------------------- | ---------------------------- | ------- | +| `GEOMETRY_GIT_COLOR_CONFLICTS_UNSOLVED` | Unsolved conflicts color | `red` | +| `GEOMETRY_GIT_COLOR_CONFLICTS_SOLVED` | Solved conflicts color | `green` | +| `GEOMETRY_GIT_SYMBOL_CONFLICTS_SOLVED` | Solved conflicts indicator | `◆` | +| `GEOMETRY_GIT_SYMBOL_CONFLICTS_UNSOLVED` | Unsolved conflicts indicator | `◈` | ##### `geometry_git()` -| Variable | Description | Defaults | -| -------------------------- | ----------- | -------- | -| `GEOMETRY_GIT_COLOR_BARE` | Color. | `blue` | -| `GEOMETRY_GIT_SYMBOL_BARE` | Indicator. | `⬢` | +| Variable | Description | Default | +| -------------------------- | ----------- | ------- | +| `GEOMETRY_GIT_COLOR_BARE` | Color | `blue` | +| `GEOMETRY_GIT_SYMBOL_BARE` | Indicator | `⬢` | ##### `geometry::git_wrapper` -| Variable | Description | Defaults | -| ------------------------ | ----------------------------- | -------- | -| `GEOMETRY_GIT_SEPARATOR` | Separator for the indicators. | `::` | +| Variable | Description | Default | +| ------------------------ | ---------------------------- | ------- | +| `GEOMETRY_GIT_SEPARATOR` | Separator for the indicators | `::` | -## `geometry_hg.zsh` +## `geometry_hg` Show Mercurial related information, such as branch name, status and time since last commit. -| Variable | Description | Defaults | -| ------------------------------ | ------------------------------- | -------- | -| `GEOMETRY_HG_COLOR_BRANCH` | Color for branch name. | `242` | -| `GEOMETRY_HG_COLOR_DIRTY` | Color for dirty indicator. | `red` | -| `GEOMETRY_HG_SYMBOL_DIRTY` | Indicator for dirty repository. | `⬡` | -| `GEOMETRY_HG_COLOR_CLEAN` | Color for clean indicator. | `green` | -| `GEOMETRY_HG_SYMBOL_CLEAN` | Idicator for clean repository. | `⬢` | -| `GEOMETRY_HG_SYMBOL_SEPARATOR` | Separator for the indicators. | `::` | +| Variable | Description | Default | +| ------------------------------ | ------------------------------ | ------- | +| `GEOMETRY_HG_COLOR_BRANCH` | Color for branch name | `242` | +| `GEOMETRY_HG_COLOR_DIRTY` | Color for dirty indicator | `red` | +| `GEOMETRY_HG_SYMBOL_DIRTY` | Indicator for dirty repository | `⬡` | +| `GEOMETRY_HG_COLOR_CLEAN` | Color for clean indicator | `green` | +| `GEOMETRY_HG_SYMBOL_CLEAN` | Idicator for clean repository | `⬢` | +| `GEOMETRY_HG_SYMBOL_SEPARATOR` | Separator for the indicators | `::` | -## `geometry_hostname.zsh` +## `geometry_hostname` Shows user and hostname information, by default in the `enter` prompt. -| Variable | Description | Defaults | -| ----------------------------- | ------------------------------------------------------------------------- | ----------- | -| `GEOMETRY_HOSTNAME_HIDE_ON` | Don't show the username and hostname indicator when the hostname matches. | `localhost` | -| `GEOMETRY_HOSTNAME_SEPARATOR` | Separator between user and hostname. | `@` | +| Variable | Description | Default | +| ----------------------------- | -------------------------------------------------------- | ----------- | +| `GEOMETRY_HOSTNAME_HIDE_ON` | Hide the username and hostname when the hostname matches | `localhost` | +| `GEOMETRY_HOSTNAME_SEPARATOR` | Separator between user and hostname | `@` | -## `geometry_jobs.zsh` +## `geometry_jobs` Shows background jobs, by default in the `enter` prompt. -| Variable | Description | Defaults | -| ---------------------- | ------------------------ | -------- | -| `GEOMETRY_JOBS_SYMBOL` | Indicator. | `⚙` | -| `GEOMETRY_JOBS_COLOR` | Color for the indicator. | `blue` | +| Variable | Description | Default | +| ---------------------- | --------------- | ------- | +| `GEOMETRY_JOBS_SYMBOL` | Indicator | `⚙` | +| `GEOMETRY_JOBS_COLOR` | Indicator color | `blue` | -## `geometry_kube.zsh` +## `geometry_kube` Show kubectl (Kubernetes) client version and current context/namespace. -| Variable | Description | Defaults | -| ---------------------- | ------------------------------------------ | -------- | -| `GEOMETRY_KUBE_COLOR` | Color for the indicator. | `blue` | -| `GEOMETRY_KUBE_SYMBOL` | Indicator. | `⎈` | -| `GEOMETRY_KUBE_PIN` | Can be set to always show `geometry_kube`. | | +| Variable | Description | Default | +| ---------------------- | --------------------------- | ------- | +| `GEOMETRY_KUBE_COLOR` | Color for the indicator | `blue` | +| `GEOMETRY_KUBE_SYMBOL` | Indicator | `⎈` | +| `GEOMETRY_KUBE_PIN` | Always show `geometry_kube` | `false` | -## `geometry_node.zsh` +## `geometry_node` Show node and npm/yarn version when in a node project context. -| Variable | Description | Defaults | -| ---------------------- | -------------------------------------------------------------------------------------------- | -------- | -| `GEOMETRY_NODE_SYMBOL` | Indicator. | `⬡` | -| `GEOMETRY_NODE_COLOR` | Color for the indicator. | `green` | -| `GEOMETRY_NODE_PIN` | Can be setup to always show `geometry_node` outside of the context of a node project folder. | | +| Variable | Description | Default | +| ---------------------- | --------------------------- | ------- | +| `GEOMETRY_NODE_SYMBOL` | Indicator | `⬡` | +| `GEOMETRY_NODE_COLOR` | Color for the indicator | `green` | +| `GEOMETRY_NODE_PIN` | Always show `geometry_node` | `false` | -## `geometry_npm_package_version.zsh` +## `geometry_npm_package_version` -Display the current folder's npm package version from package.json (by @drager) +Display the current folder's npm package version from package.json (by @drager). -| Variable | Description | Defaults | -| ------------------------------------------- | ------------------------ | -------- | -| `GEOMETRY_NPM_PACKAGE_VERSION_SYMBOL` | Indicator. | `📦` | -| `GEOMETRY_NPM_PACKAGE_VERSION_SYMBOL_COLOR` | Color for the indicator. | `red` | -| `GEOMETRY_NPM_PACKAGE_VERSION_COLOR` | Text color. | `red` | +| Variable | Description | Default | +| ------------------------------------------- | ----------------------- | ------- | +| `GEOMETRY_NPM_PACKAGE_VERSION_SYMBOL` | Indicator | `📦` | +| `GEOMETRY_NPM_PACKAGE_VERSION_SYMBOL_COLOR` | Color for the indicator | `red` | +| `GEOMETRY_NPM_PACKAGE_VERSION_COLOR` | Text color | `red` | -## `geometry_path.zsh` +## `geometry_path` Show the current path. -| Variable | Description | Defaults | -| ----------------------------- | --------------------------------------- | -------- | -| `GEOMETRY_PATH_SYMBOL_HOME` | Symbol representing the home directory. | `%3~` | -| `GEOMETRY_PATH_SHOW_BASENAME` | - | `false` | -| `GEOMETRY_PATH_COLOR` | Color for path. | `blue` | +| Variable | Description | Default | +| ----------------------------- | --------------------------------------- | ------- | +| `GEOMETRY_PATH_SYMBOL_HOME` | Symbol representing the home directory. | `%3~` | +| `GEOMETRY_PATH_SHOW_BASENAME` | - | `false` | +| `GEOMETRY_PATH_COLOR` | Color for path. | `blue` | -## `geometry_ruby.zsh` +## `geometry_ruby` Display the current ruby version, rvm version, and gemset. -| Variable | Description | Defaults | -| ------------------------------- | ---------------- | -------- | -| `GEOMETRY_RUBY_SYMBOL` | Indicator. | `◆` | -| `GEOMETRY_RUBY_COLOR` | Indicator color. | `white` | -| `GEOMETRY_RUBY_RVM_SHOW_GEMSET` | Show RVM gemset. | `true` | +| Variable | Description | Default | +| ------------------------------- | --------------- | ------- | +| `GEOMETRY_RUBY_SYMBOL` | Indicator | `◆` | +| `GEOMETRY_RUBY_COLOR` | Indicator color | `white` | +| `GEOMETRY_RUBY_RVM_SHOW_GEMSET` | Show RVM gemset | `true` | -## `geometry_rust_version.zsh` +## `geometry_rust_version` Display the current version of rust (by @drager). -| Variable | Description | Defaults | -| ----------------------------- | ------------------ | -------- | -| `GEOMETRY_RUST_VERSION_COLOR` | Color for version. | `red` | +| Variable | Description | Default | +| ----------------------------- | ------------------ | ------- | +| `GEOMETRY_RUST_VERSION_COLOR` | Color for version. | `red` | -## `geometry_rustup.zsh` +## `geometry_rustup` Display a symbol colored with the currently selected rustup toolchain. -| Variable | Description | Defaults | -| ------------------------------- | ---------------------------------------------------------- | -------- | -| `GEOMETRY_RUSTUP_SYMBOL` | Indicator. | `⚙` | -| `GEOMETRY_RUSTUP_STABLE_COLOR` | Stable color. | `green` | -| `GEOMETRY_RUSTUP_BETA_COLOR` | Beta color. | `yellow` | -| `GEOMETRY_RUSTUP_NIGHTLY_COLOR` | Nightly color. | `red` | -| `GEOMETRY_RUSTUP_PIN` | Can be setup to keep rustup rendering even out of context. | | +| Variable | Description | Default | +| ------------------------------- | --------------------------------------------------------- | -------- | +| `GEOMETRY_RUSTUP_SYMBOL` | Indicator | `⚙` | +| `GEOMETRY_RUSTUP_STABLE_COLOR` | Stable color | `green` | +| `GEOMETRY_RUSTUP_BETA_COLOR` | Beta color | `yellow` | +| `GEOMETRY_RUSTUP_NIGHTLY_COLOR` | Nightly color | `red` | +| `GEOMETRY_RUSTUP_PIN` | Can be setup to keep rustup rendering even out of context | `false` | -## `geometry_status.zsh` +## `geometry_status` Show a symbol with error/success and root/non-root information. @@ -241,12 +240,12 @@ Show a symbol with error/success and root/non-root information. | `GEOMETRY_STATUS_SYMBOL_COLOR_HASH` | Automatically pick a color based on the hostname | `false` | | `GEOMETRY_STATUS_SYMBOL_COLOR_HASH_COLORS` | Array of colors to choose from | `1..16` | -## `geometry_virtualenv.zsh` +## `geometry_virtualenv` Show the current `virtualenv` or `conda` environment. -| Variable | Description | Defaults | -| ------------------------------------- | --------------- | -------- | -| `GEOMETRY_VIRTUALENV_CONDA_SEPARATOR` | Text separator. | `:` | -| `GEOMETRY_VIRTUALENV_COLOR` | Text color. | `green` | -| `GEOMETRY_VIRUALENV_CONDA_COLOR` | Text color. | `green` | +| Variable | Description | Default | +| ------------------------------------- | -------------- | ------- | +| `GEOMETRY_VIRTUALENV_CONDA_SEPARATOR` | Text separator | `:` | +| `GEOMETRY_VIRTUALENV_COLOR` | Text color | `green` | +| `GEOMETRY_VIRUALENV_CONDA_COLOR` | Text color | `green` |