spaceship-prompt 3.16.5 → 4.0.0

package/CHANGELOG.md

@@ -1,3 +1,109 @@
+# [4.0.0](https://github.com/spaceship-prompt/spaceship-prompt/compare/v3.16.7...v4.0.0) (2022-09-01)
+
+
+### Bug Fixes
+
+* add permissions to scripts ([7c3e427](https://github.com/spaceship-prompt/spaceship-prompt/commit/7c3e42727531ff612588722c509da643566f57fd))
+* add x permissions to files ([9a34149](https://github.com/spaceship-prompt/spaceship-prompt/commit/9a341498bb6d31bf6d179121adbe781972fcde26))
+* **async:** remove obsolete runtime variables ([2128ab0](https://github.com/spaceship-prompt/spaceship-prompt/commit/2128ab0046080d633c29a69f86322ca4ca9bed90))
+* cherry pick [#1089](https://github.com/spaceship-prompt/spaceship-prompt/issues/1089) ([52448c1](https://github.com/spaceship-prompt/spaceship-prompt/commit/52448c121f7d3602e2e046ae674b70c5a8bbdafa))
+* **cli:** Add missing commands in help message ([c2eb3e3](https://github.com/spaceship-prompt/spaceship-prompt/commit/c2eb3e35e8088c014cc0ed04aaab8133afaa3dd6))
+* compdef only when compdef is available ([c309af6](https://github.com/spaceship-prompt/spaceship-prompt/commit/c309af62cbb8411583228a179ccb37d8329d2af6))
+* **docker:** add additional utils inside docker image ([8813eb0](https://github.com/spaceship-prompt/spaceship-prompt/commit/8813eb0b691d1ccab1042c93edffc1c43764a0b5))
+* fix command-line completion leving one letter on the beginning of prompt ([6a4abd5](https://github.com/spaceship-prompt/spaceship-prompt/commit/6a4abd5c3489ef3a1f1387673bafdb2ab0298887)), closes [#1064](https://github.com/spaceship-prompt/spaceship-prompt/issues/1064)
+* **git:** Add explicit variable for async rendering ([cfa95e6](https://github.com/spaceship-prompt/spaceship-prompt/commit/cfa95e6c80ee9d5d9dfa486daf892c1021278140))
+* **git:** fix ahead/behind indicators ([a067c4d](https://github.com/spaceship-prompt/spaceship-prompt/commit/a067c4df0b663410f7e617e9a2240393f9219095))
+* **git:** Fix typo in a section signature ([f8ed612](https://github.com/spaceship-prompt/spaceship-prompt/commit/f8ed612d8b5328d934a86c5664a745e9fbc0628d))
+* **hg:** Add options for async rendering ([d5bdfa4](https://github.com/spaceship-prompt/spaceship-prompt/commit/d5bdfa42dc969fe9098792a305b34352d1ba4048))
+* **kubectl:** fix kubectl section ([1b71e09](https://github.com/spaceship-prompt/spaceship-prompt/commit/1b71e096dd68be80672173686ea1974d8095ea45))
+* make core variables readonly ([1cd4756](https://github.com/spaceship-prompt/spaceship-prompt/commit/1cd4756caf2080f8a13bd5aab15d927660f3d836))
+* NEWLINE variable doesn't work ([28b37f5](https://github.com/spaceship-prompt/spaceship-prompt/commit/28b37f566ebc141c93395d003601e1447f6bf91f))
+* **ps2:** print PS2 properly ([0d9766c](https://github.com/spaceship-prompt/spaceship-prompt/commit/0d9766c8b65707cb3e7eef19f78bb080cdda3e1b))
+* put user config loading in a proper place ([5c68702](https://github.com/spaceship-prompt/spaceship-prompt/commit/5c68702d6e695b517ca89593777651d665c8719e))
+* **python:** use python3 command ([0466bb8](https://github.com/spaceship-prompt/spaceship-prompt/commit/0466bb8a9c443e930d9ba11318b5fe6b0f8a6cca))
+* **renderer:** fix missing options for globes ([107429c](https://github.com/spaceship-prompt/spaceship-prompt/commit/107429ce5ea936d25fc8cbf813fcf256be75c683))
+* rendering docker context ([b6a49f8](https://github.com/spaceship-prompt/spaceship-prompt/commit/b6a49f8e00f28f265c13340183d102a1bbe5252f))
+* Resolve newline issue with command expansion ([bcfce70](https://github.com/spaceship-prompt/spaceship-prompt/commit/bcfce70c8552d4b8e378e7b542754da4115ce7b8))
+* **scripts:** Stop on errors ([ccee8e9](https://github.com/spaceship-prompt/spaceship-prompt/commit/ccee8e994d5bd1ddda8c3ed89e9d6767792a7b67))
+* set proper message if no account ([#1099](https://github.com/spaceship-prompt/spaceship-prompt/issues/1099)) ([69f906c](https://github.com/spaceship-prompt/spaceship-prompt/commit/69f906caa21af14b7ae199f2252629331485b8cd))
+* support CLOUDSDK_CONFIG env ([#1122](https://github.com/spaceship-prompt/spaceship-prompt/issues/1122)) ([ae348f9](https://github.com/spaceship-prompt/spaceship-prompt/commit/ae348f9a3df50b13134f1dc7f5eaa574f215cf74)), closes [#1117](https://github.com/spaceship-prompt/spaceship-prompt/issues/1117)
+* **tests:** render prefixes and suffixes only when they are not empty ([73c2c71](https://github.com/spaceship-prompt/spaceship-prompt/commit/73c2c7135edfeadb92b285c7db70af63566f7852))
+* **upsearch:** Check repo properly ([4764ed9](https://github.com/spaceship-prompt/spaceship-prompt/commit/4764ed921d2b6a78c2ea72641ba91ed072e7b3b5))
+
+
+### Code Refactoring
+
+* **ember:** remove ember from built-in sections ([05beb8b](https://github.com/spaceship-prompt/spaceship-prompt/commit/05beb8b56f6203d215c50c0b26ff27174b9104ab))
+* **gradle:** migrate Gradle to a separate repo ([984bc01](https://github.com/spaceship-prompt/spaceship-prompt/commit/984bc01c073c399dfb7484c5ecdff672062a213f))
+* **install:** simplify the installation process ([824f876](https://github.com/spaceship-prompt/spaceship-prompt/commit/824f87657309b1f2579173252667a3cfb88c881e))
+* **maven:** migrate Maven to a separate repo ([3efd48b](https://github.com/spaceship-prompt/spaceship-prompt/commit/3efd48b55029ae2c68bbf4e3a43fb922c8b3e942))
+* **vi_mode:** move vi_mode to external section ([9ce611b](https://github.com/spaceship-prompt/spaceship-prompt/commit/9ce611b10ba3766f149abe8a1c1d27f488845b6e)), closes [#586](https://github.com/spaceship-prompt/spaceship-prompt/issues/586)
+
+
+### Features
+
+* add ability to forcefully render a section synchronously ([216f0f2](https://github.com/spaceship-prompt/spaceship-prompt/commit/216f0f2c710191b1f3436c744c52b7de21129b4b))
+* add IBM Cloud CLI section ([#912](https://github.com/spaceship-prompt/spaceship-prompt/issues/912)) ([30b4b60](https://github.com/spaceship-prompt/spaceship-prompt/commit/30b4b60176e727cbf7b1fc7d1bccadcd61139c0b))
+* Add is_async util ([d539ee5](https://github.com/spaceship-prompt/spaceship-prompt/commit/d539ee5d61714addb80ba2d531a36d1029cc3d18))
+* Add java section ([713f406](https://github.com/spaceship-prompt/spaceship-prompt/commit/713f406a3f1bdbeda50bf6924dbf957230361595))
+* **async:** add an option to globaly disable/enable async rendering ([0ca1463](https://github.com/spaceship-prompt/spaceship-prompt/commit/0ca1463b1891edfcad0d25897a0c733dfdd19d73))
+* **async:** introduce async jobs indicator ([f0a75ce](https://github.com/spaceship-prompt/spaceship-prompt/commit/f0a75cece5361963b4c9a39fbd9151093ec3502d))
+* **cli:** add a print command for CLI ([6843105](https://github.com/spaceship-prompt/spaceship-prompt/commit/6843105f2a061629cc912d255f6e9ace98cc485b))
+* **cli:** add CLI ([205cb16](https://github.com/spaceship-prompt/spaceship-prompt/commit/205cb16eef6783d6e37af47d2492861d5c5aba7a))
+* **cli:** add command completions for cli ([2ae45a4](https://github.com/spaceship-prompt/spaceship-prompt/commit/2ae45a4ec0c4231b69c2090d3a7ed2211051945a))
+* **cli:** Add edit command ([b029587](https://github.com/spaceship-prompt/spaceship-prompt/commit/b029587ed9473ba9b8efc19ddaf8135636ae2d08))
+* **cli:** CLI for inserting and removing sections ([5dcce40](https://github.com/spaceship-prompt/spaceship-prompt/commit/5dcce40e99e0595453133862b95720882ab07fe7)), closes [#318](https://github.com/spaceship-prompt/spaceship-prompt/issues/318)
+* **config:** Add ability to store config in ~/.config/spaceship ([b5dee37](https://github.com/spaceship-prompt/spaceship-prompt/commit/b5dee377c85b54e4f70071de42bc1cff52816f82))
+* **config:** introduce config file resolution ([e087459](https://github.com/spaceship-prompt/spaceship-prompt/commit/e087459d316aa445506cf41b3d58be4b0b4b854a)), closes [#508](https://github.com/spaceship-prompt/spaceship-prompt/issues/508)
+* **docker:** add docker image and publishing it to ghcr.io ([77d7457](https://github.com/spaceship-prompt/spaceship-prompt/commit/77d74570b7a68c934bb4e5c5ac1a7b36e9fd96cb))
+* **exec_time:** display exec time with precision ([7b04aed](https://github.com/spaceship-prompt/spaceship-prompt/commit/7b04aed499175e22ec37b9af55fb3375d5fd48b1))
+* **git:** add ability to customize git and hg orders ([8a54cb3](https://github.com/spaceship-prompt/spaceship-prompt/commit/8a54cb39036b173be143b134f1ce00760813fe2d)), closes [#391](https://github.com/spaceship-prompt/spaceship-prompt/issues/391)
+* **haskell:** Look for .hs files ([b2eb8a3](https://github.com/spaceship-prompt/spaceship-prompt/commit/b2eb8a35f3c41b73a7d48787a3f4f413c390407f))
+* **ibmcloud:** Enable async rendering for ibmcloud ([8391054](https://github.com/spaceship-prompt/spaceship-prompt/commit/8391054c79bacd68c87032ae9011f9c8deb424c6))
+* **package:** Add composer and julia support ([3f8bb1e](https://github.com/spaceship-prompt/spaceship-prompt/commit/3f8bb1e5a41ad33f55f5c078ed893a4ef7cee214))
+* **perf:** Compile to zwc ([3549bbf](https://github.com/spaceship-prompt/spaceship-prompt/commit/3549bbf9050670b70f79b61c6c90755022448b7e))
+* **registry:** Add custom sections registry ([86d64dd](https://github.com/spaceship-prompt/spaceship-prompt/commit/86d64ddbba4c42092a6fcb98dc06822726531a49))
+* **renderer:** render sync section on every render ([4e93ae0](https://github.com/spaceship-prompt/spaceship-prompt/commit/4e93ae0ccbb7cd692995b5e78942e783bb25aa71))
+* **section:** migrate default section to v4 ([0684171](https://github.com/spaceship-prompt/spaceship-prompt/commit/0684171c41783c278cfaa84fbc844a18a1b4a7ed))
+* **section:** Migrate sections to new signature ([b3249fb](https://github.com/spaceship-prompt/spaceship-prompt/commit/b3249fb756a31dec21f1c11beca1a37bf961332d))
+* **section:** Named arguments for section ([201496b](https://github.com/spaceship-prompt/spaceship-prompt/commit/201496b4311852e070b315b473dcfbe1d9a792cc))
+* **testkit:** add a simple testkit ([1ceca85](https://github.com/spaceship-prompt/spaceship-prompt/commit/1ceca858ddfe8888418e7096e3f863df5d611d6e))
+* Upsearch for project files up the tree ([08f6d70](https://github.com/spaceship-prompt/spaceship-prompt/commit/08f6d70e972fc56fa47dccb42f1e44b0bdce352b))
+* **vsc:** Make git and hg async ([9ddb9be](https://github.com/spaceship-prompt/spaceship-prompt/commit/9ddb9be29df8058e06b43a4a7504b4faa87cd677))
+
+
+### Performance Improvements
+
+* **zwc:** Precompile root file and async ([ee5afc5](https://github.com/spaceship-prompt/spaceship-prompt/commit/ee5afc5caf87b22bf3467679f8a6849c04956b03))
+* **zwc:** spaceship::precompile compiles sources to zwc ([58758e7](https://github.com/spaceship-prompt/spaceship-prompt/commit/58758e785d948ba3d5a1718dc5cc11321339ab81))
+
+
+### BREAKING CHANGES
+
+* **section:** spaceship::section:v4 uses flags instead of arguments order to pass section params.
+* **vi_mode:** vi_mode section is not include in core anymore
+* **gradle:** Gradle section is not included by default. It can be installed additionally from:
+https://github.com/spaceship-prompt/spaceship-gradle
+* **maven:** Maven section is no longer available by default. It can be additionally installed
+from: https://github.com/spaceship-prompt/spaceship-maven
+* **install:** Now users have to manually enable prompt system and choose spaceship
+* **ember:** ember section is no longer available out of the box. It needs to be installed
+additionally.
+
+## [3.16.7](https://github.com/spaceship-prompt/spaceship-prompt/compare/v3.16.6...v3.16.7) (2022-05-10)
+
+
+### Bug Fixes
+
+* revert problem with publishing to brew ([d76cc7b](https://github.com/spaceship-prompt/spaceship-prompt/commit/d76cc7ba804471c78dfc1d471f688019a65934a6))
+
+## [3.16.6](https://github.com/spaceship-prompt/spaceship-prompt/compare/v3.16.5...v3.16.6) (2022-05-09)
+
+
+### Bug Fixes
+
+* **brew:** Attempt to bump homebrew formula with main release ([5f476b1](https://github.com/spaceship-prompt/spaceship-prompt/commit/5f476b1d2942c778a9ca4d7609f4db2526c9430d))
+
 ## [3.16.5](https://github.com/spaceship-prompt/spaceship-prompt/compare/v3.16.4...v3.16.5) (2022-03-28)
 
 

package/README.md

@@ -1,12 +1,14 @@
+[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct-single.svg)](https://stand-with-ukraine.pp.ua/)
+
 <h1 align="center">
   <a href="https://github.com/spaceship-prompt/spaceship-prompt">
     <img alt="spaceship →~ prompt" src="https://cloud.githubusercontent.com/assets/3459374/21679181/46e24706-d34b-11e6-82ee-5efb3d2ba70f.png" width="400">
   </a>
-  <br>🚀⭐ Spaceship ZSH <br>
+  <br>Spaceship Prompt 🚀⭐<br>
 </h1>
 
 <h4 align="center">
-  <a href="http://zsh.org" target="_blank"><code>Zsh</code></a> prompt for Astronauts.
+  Minimalistic, powerful and extremely customizable <a href="http://zsh.org" target="_blank"><code>Zsh</code></a> prompt
 </h4>
 
 <p align="center">
@@ -46,10 +48,9 @@
 <div align="center">
   <h4>
     <a href="https://spaceship-prompt.sh">Website</a> |
-    <a href="https://spaceship-prompt.sh/getting-started">Installing</a> |
-    <a href="#features">Features</a> |
-    <a href="https://spaceship-prompt.sh/options">Options</a> |
-    <a href="https://spaceship-prompt.sh/api">API</a>
+    <a href="https://spaceship-prompt.sh/getting-started">Installation</a> |
+    <a href="https://spaceship-prompt.sh/config/intro">Configuration</a> |
+    <a href="https://spaceship-prompt.sh/advanced/creating-section">Advanced Usage</a>
   </h4>
 </div>
 
@@ -60,116 +61,67 @@
 </div>
 <br>
 
-[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct-single.svg)](https://stand-with-ukraine.pp.ua/)
-  
-Spaceship is a minimalistic, powerful and extremely customizable [Zsh][zsh-url] prompt. It combines everything you may need for convenient work, without unnecessary complications, like a real spaceship.
+Spaceship is a minimalistic, powerful and extremely customizable [Zsh][zsh-url] prompt. Prompt is what you see when you type a command. It can show a lot of useful tips, saving your time and making user experience smooth and pleasant. It combines everything you may need for convenient work, without unnecessary complications, like a real spaceship.
 
 <p align="center">
-  <img alt="Spaceship with Hyper and One Dark" src="https://user-images.githubusercontent.com/10276208/36086434-5de52ace-0ff2-11e8-8299-c67f9ab4e9bd.gif" width="980px">
+  <a href="https://asciinema.org/a/513451">
+    <img alt="Spaceship with One Dark, zsh-autosuggestions and zsh-syntax-highlight" src="https://user-images.githubusercontent.com/3459374/183478313-5aa02cbe-fafc-42e0-a791-ea08a0902f56.gif" width="80%">
+  </a>
+  <br>
+  <sup>Visit <a href="https://deploy-preview-963--spaceship-prompt.netlify.app/faq/#why-doesnt-my-prompt-look-like-the-preview">Frequently Asked Question</a> for similar setup and find more examples with different color schemes in <a href="https://github.com/spaceship-prompt/spaceship-prompt/wiki/Screenshots">Screenshots </a>wiki-page.
+  </sup>
 </p>
 
-<sub>Visit <a href="./docs/troubleshooting.md#why-doesnt-my-prompt-look-like-the-preview">Troubleshooting</a> for similar setup and find more examples with different color schemes in <a href="https://github.com/spaceship-prompt/spaceship-prompt/wiki/Screenshots">Screenshots </a>wiki-page.</sub>
-
-## Features
-
-- Clever hostname and username displaying.
-- Prompt character turns red if the last command exits with non-zero code.
-- Current Git branch and rich repo status:
-  - `?` — untracked changes;
-  - `+` — uncommitted changes in the index;
-  - `!` — unstaged changes;
-  - `»` — renamed files;
-  - `✘` — deleted files;
-  - `$` — stashed changes;
-  - `=` — unmerged changes;
-  - `⇡` — ahead of remote branch;
-  - `⇣` — behind of remote branch;
-  - `⇕` — diverged changes.
-- Current Mercurial bookmark/branch and rich repo status:
-  - `?` — untracked changes;
-  - `+` — uncommitted changes in the index;
-  - `!` — unstaged changes;
-  - `✘` — deleted files;
-- Indicator for jobs in the background (`✦`).
-- Current Node.js version, through fnm/nvm/nodenv/n (`⬢`).
-- Current Ruby version, through rvm/rbenv/chruby/asdf (`💎`).
-- Current Elm version (`🌳`)
-- Current Elixir version, through kiex/exenv/elixir (`💧`).
-- Current Swift version, through swiftenv (`🐦`).
-- Current Xcode version, through xenv (`🛠`).
-- Current Go version (`🐹`).
-- Current PHP version (`🐘`).
-- Current Rust version (`🦀`).
-- Current version of Haskell GHC Compiler, defined in stack.yaml file (`λ`).
-- Current Julia version (`ஃ`).
-- Current Docker version and connected machine (`🐳`).
-- Current Amazon Web Services (AWS) profile (`☁️`) ([Using named profiles](http://docs.aws.amazon.com/cli/latest/userguide/cli-multiple-profiles.html)).
-- Current Google Cloud Platform gcloud active configuration (`☁️`).
-- Current Python virtualenv.
-- Current Conda virtualenv (`🅒`).
-- Current Python pyenv (`🐍`).
-- Current .NET SDK version, through dotnet-cli (`.NET`).
-- Current Ember.js version, through ember-cli (`🐹`).
-- Current Kubectl context (`☸️`).
-- Current Terraform workspace (`🛠`).
-- Current IBM Cloud account (`👔`).
-- Package version, if there's is a package in current directory (`📦`).
-- Current battery level and status:
-  - `⇡` - charging;
-  - `⇣` - discharging;
-  - `•` - fully charged.
-- Current Vi-mode mode ([with handy aliases for temporarily enabling](./docs/options.md#vi-mode-vi_mode)).
-- Optional exit-code of last command ([how to enable](./docs/options.md#exit-code-exit_code)).
-- Optional time stamps 12/24hr in format ([how to enable](./docs/options.md#time-time)).
-- Execution time of the last command if it exceeds the set threshold.
-- Optional AWS now supports aws-vault ([aws-vault](https://github.com/99designs/aws-vault))
-
-Want more features? Please, [open an issue](https://github.com/spaceship-prompt/spaceship-prompt/issues/new/choose) or send pull request.
+## ✨ Features
 
-**💡 Tip:** Follow [our Twitter](https://twitter.com/SpaceshipPrompt) to keep yourself updated about new features, improvements, and bugfixes.
+Here are some sneak picks of what **Spaceship** can show:
 
-## Requirements
+- Clever hostname and username displaying
+- Repository statuses (Git and Mercurial are supported)
+- Runtime environments for various languages (Node.js, Rust, Python, Ruby, Swift, Go, PHP and many others)
+- Docker version, Kubernetes context and connected machine
+- Package version (npm, lerna, cargo, composer and others)
+- Battery level and status
+- Indicator for jobs in the background `✦`
+- A lot of [useful information](https://spaceship-prompt.sh/sections)
+- Custom [information of your choice](https://spaceship-prompt.sh/advanced/creating-section)
 
-To work correctly, you will first need:
+Want more features? Please, [open an issue](https://github.com/spaceship-prompt/spaceship-prompt/issues/new/choose) or send pull request.
 
-- [`zsh`](http://www.zsh.org/) (v5.2 or recent) must be installed.
-- [Powerline Font](https://github.com/powerline/fonts) must be installed and used in your terminal (for example, switch font to [Fira Code](https://github.com/tonsky/FiraCode)).
+## 🤝 Requirements
 
-## Installing
+Before we begin, let's make sure you have the following installed:
 
-Now that the requirements are satisfied, you can install Spaceship ZSH via any of the following tools.
+- [Zsh](http://www.zsh.org/) (v5.2 or recent) must be installed. Run the following command to check you version of Zsh:
+  ```zsh
+  echo $ZSH_VERSION #> 5.8.1
+  ```
+- [Powerline Font](https://github.com/powerline/fonts) or [Nerd Font](https://www.nerdfonts.com/) (even better) must be installed and used in your terminal. [Fira Code](https://github.com/tonsky/FiraCode) is a popular choice. To check if Powerline Font works for you, run:
+  ```zsh
+  echo -e "\xee\x82\xa0" #> 
+  ```
 
-**💡 Tip:** If you like this project ~~and want to get some stickers and postcards~~, consider becoming a patron:
+## 🚀 Installation
 
-<a href="https://patreon.com/denysdovhan">
-  <img alt="Become a patron" src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="150px">
-</a>
+Here's a few popular methods to install Spaceship. Select the one you use from the list below:
 
-### [Homebrew]
+<details>
+<summary>Homebrew</summary>
+Installing Spaceship via Homebrew is a simple command:
 
-```
+```zsh title="Terminal"
 brew install spaceship
 ```
 
-You can also add the following to your [`Brewfile`](https://github.com/Homebrew/homebrew-bundle#usage):
+Add prompt initialization to your `.zshrc`:
 
-```ruby
-brew "spaceship"
+```zsh title="Terminal"
+echo "source $(brew --prefix)/opt/spaceship/spaceship.zsh" >>! ~/.zshrc
 ```
+</details>
 
-### [npm]
-
-```
-npm install -g spaceship-prompt
-```
-
-Done. This command should link `spaceship.zsh` as `prompt_spaceship_setup` to your `$fpath` and set `prompt spaceship` in `.zshrc`. Just reload your terminal.
-Ensure that you have enabled post-scripts in npm by `npm config set ignore-scripts false` before starting installation.
-
-**💡 Tip:** Update Spaceship to new versions as you would any other package.
-
-### [oh-my-zsh]
-
+<details>
+<summary>Oh-My-Zsh</summary>
 Clone this repo:
 
 ```zsh
@@ -183,61 +135,108 @@ ln -s "$ZSH_CUSTOM/themes/spaceship-prompt/spaceship.zsh-theme" "$ZSH_CUSTOM/the
 ```
 
 Set `ZSH_THEME="spaceship"` in your `.zshrc`.
+</details>
+
+<details>
+<summary>npm</summary>
+Install Spaceship via npm as you would with any other global package:
+
+```
+npm install -g spaceship-prompt
+```
+
+This command will download Spaceship. It will also ask you to source Spaceship in your `~/.zshrc` file.
 
-### [prezto]
+</details>
+
+<details>
+<summary>prezto</summary>
 
 - Follow [prezto-contrib#usage](https://github.com/belak/prezto-contrib#usage) to clone `prezto-contrib` to the proper location.
 - Enable the `contrib-prompt` module (before the `prompt` module).
 - Set `zstyle ':prezto:module:prompt' theme 'spaceship'` in your `.zpreztorc`.
 
-### [zim]
+</details>
 
-Add `zmodule spaceship-prompt/spaceship-prompt --name spaceship` to your `.zimrc` and run `zimfw install`.
+<details>
+<summary>zim</summary>
+Add Spaceship to your `.zimrc`:
 
-### [antigen]
+```zsh
+zmodule spaceship-prompt/spaceship-prompt --name spaceship
+```
 
-Add the following snippet in your `.zshrc`:
+Then install Spaceship:
 
+```zsh
+zim install
 ```
+</details>
+
+<details>
+<summary>antigen</summary>
+Add the following snippet in your `.zshrc`:
+
+```zsh
 antigen theme spaceship-prompt/spaceship-prompt
 ```
+</details>
 
-### [antibody]
-
+<details>
+<summary>antibody</summary>
 Update your `.zshrc` file with the following line:
 
-```
+```zsh
 antibody bundle spaceship-prompt/spaceship-prompt
 ```
+</details>
 
-### [zinit]
-
+<details>
+<summary>zinit</summary>
 Add the following line to your `.zshrc` where you're adding your other Zsh plugins:
 
-```
+```zsh
 zinit light spaceship-prompt/spaceship-prompt
 ```
+</details>
 
-### [zgen]
-
+<details>
+<summary>zgen</summary>
 Add the following line to your `.zshrc` where you're adding your other Zsh plugins:
 
-```
+```zsh
 zgen load spaceship-prompt/spaceship-prompt spaceship
 ```
+</details>
 
-### [zplug]
-
+<details>
+<summary>zplug</summary>
 Use this command in your `.zshrc` to load Spaceship as prompt theme:
 
-```
+```zsh
 zplug "spaceship-prompt/spaceship-prompt", use:spaceship.zsh, from:github, as:theme
 ```
+</details>
 
-### Linux package manager
+<details>
+<summary>sheldon</summary>
+Add the following to your `plugins.toml` file (open it with `sheldon edit`):
 
-#### Arch Linux
+```toml
+[plugins.spaceship]
+github = "spaceship-prompt/spaceship-prompt"
+```
+</details>
+
+Or run the following to automatically add it:
+
+```zsh
+sheldon add spaceship --github spaceship-prompt/spaceship-prompt
+```
+</details>
 
+<details>
+<summary>Arch</summary>
 Install the latest master from the AUR package [`spaceship-prompt-git`](https://aur.archlinux.org/packages/spaceship-prompt-git/):
 
 ```
@@ -245,138 +244,84 @@ git clone https://aur.archlinux.org/spaceship-prompt-git.git --depth=1
 cd spaceship-prompt-git
 makepkg -si
 ```
+</details>
 
-### Manual
+<details>
+<summary>Manual</summary>
 
-If you have problems with approaches above, follow these instructions:
+If none of the above methods works for you, you can install Spaceship manually.
 
-- Clone this repo `git clone https://github.com/spaceship-prompt/spaceship-prompt.git --depth=1`
-- Symlink `spaceship.zsh` to somewhere in [`$fpath`](http://www.refining-linux.org/archives/46/ZSH-Gem-12-Autoloading-functions/) as `prompt_spaceship_setup`.
-- Initialize prompt system and choose `spaceship`.
-
-#### Example
-
-Run `echo $fpath` to see possible location and link `spaceship.zsh` there, like:
-
-```zsh
-$ ln -sf "$PWD/spaceship.zsh" "/usr/local/share/zsh/site-functions/prompt_spaceship_setup"
-```
-
-For a user-specific installation, simply add a directory to `$fpath` for that user in `.zshrc`:
-
-```zsh
-fpath=( "${ZDOTDIR:-$HOME}/.zfunctions" $fpath )
-```
+1. Clone this repo somewhere, for example to `$HOME/.zsh/spaceship`.
+2. Add the path of the cloned repo to `$fpath` in `$HOME/.zshrc`.
+3. Activate Spaceship prompt by `promptinit`.
 
-Then install the theme like this:
+### Example
 
 ```zsh
-$ ln -sf "$PWD/spaceship.zsh" "${ZDOTDIR:-$HOME}/.zfunctions/prompt_spaceship_setup"
+mkdir -p "$HOME/.zsh"
+git clone --depth=1 https://github.com/spaceship-prompt/spaceship-prompt.git "$HOME/.zsh/spaceship"
 ```
 
 For initializing prompt system add this to your `.zshrc`:
 
-```zsh
-# .zshrc
-autoload -U promptinit; promptinit
-prompt spaceship
+```zsh title=".zshrc"
+source "~/.zsh/spaceship/spaceship.zsh"
 ```
+</details>
 
-## Customization
+## ⚙️ Configuration
 
 Spaceship works well out of the box, but you can customize almost everything if you want.
 
-- [**Options**](./docs/options.md) — Tweak section's behavior with tons of options.
-- [**API**](./docs/api.md) — Define a custom section that will do exactly what you want.
+- [**⚙️ Configuration**](https://spaceship-prompt.sh/config/intro) — Tweak section's behavior with tons of options.
+- [**😎 Advanced Usage**](https://spaceship-prompt.sh/advanced/creating-section) — Learn how to create a custom section, benefit of per-directory configuration and more.
 
-You have the ability to customize or disable specific elements of Spaceship. Set options and define new sections in your `.zshrc` file, **after** the theme. To include a custom section you have defined in your prompt, add it to the `SPACESHIP_PROMPT_ORDER`.
+Additionally, join our community in [Discord](https://discord.gg/NTQWz8Dyt9) and follow our [Twitter](https//twitter.com/SpaceshipPrompt) for updates.
 
-For example:
+## 🫶 Contributing
 
-```shell
-# .zshrc
+We're glad to accept contributions from developers of **all skill levels**! If you are interested in contributing to Spaceship, please take a look at our [Contribution Guide](./CONTRIBUTING.md) for more details. If you're looking for an easy way into the project, take one of the issues with [**good first issue**](https://github.com/spaceship-prompt/spaceship-prompt/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) label.
 
-# add Spaceship (differs by setup, see Installating above)
+If you are fluent in any other language besides English, we greatly appreciate any help with translating our documentation in other languages. If you would like to help, join the [team of translators on our Crowdin](https://translate.spaceship-prompt.sh).
 
-section_mysection() {
-  # ...
-}
+If you're interested in helping other people, answer questions asked by other users of Spaceship and help to solve their issues. Additionally, join our [**Discord**](https://discord.gg/NTQWz8Dyt9) to discuss Spaceship and help people who need help.
 
-SPACESHIP_PROMPT_ORDER=(<any preceding sections> mysection <any following sections>)
-```
+## 💌 Sponsoring
 
-To append custom sections to the default Spaceship prompt, follow the form:
+If you really enjoy this project, you can contribute financially. Any contribution is highly appreciated, even the smallest one. There are several ways to donate:
 
-```shell
-SPACESHIP_PROMPT_ORDER=($SPACESHIP_PROMPT_ORDER mysection)
-```
+* **Recurring donations**:
+  * [GitHub Sponsors](https://github.com/sponsors/denysdovhan?frequency=recurring)
+  * [Open Collective](https://opencollective.com/spaceship-prompt)
+  * [Patreon](https://patreon.com/denysdovhan)
+* **One-time donations**:
+  * [GitHub Sponsors](https://github.com/sponsors/denysdovhan?frequency=one-time)
+  * [Buy Me A Coffee](https://buymeacoffee.com/denysdovhan)
+  * [Monobank Jar](https://send.monobank.ua/jar/2N46sWTaZZ)
+* **Crypto donations**:
+  * Ethereum: `0x5C9496De5E51D48daf28354DC04d8f9D33955559`
+  * Bitcoin: `bc1q5ezjvpgftmx42f9qgdf5lscjz43uh4jf02uvje`
 
-To prepend custom sections to the default Spaceship prompt, follow the form:
-
-```shell
-SPACESHIP_PROMPT_ORDER=(mysection $SPACESHIP_PROMPT_ORDER)
-```
+## 🤔 Having trouble?
 
-**💡 Tip:** Take a look at popular option presets or share your own configuration on [Presets](https://github.com/spaceship-prompt/spaceship-prompt/wiki/Presets) wiki page.
+Find answers on our troubleshooting page or get help by our community.
 
-## Troubleshooting
+[**Issues**](https://github.com/spaceship-prompt/spaceship-prompt/issues) • [**Discussions**](https://github.com/spaceship-prompt/spaceship-prompt/discussions/) • [**Discord**](https://discord.gg/NTQWz8Dyt9)
 
-Having trouble? Take a look at out [Troubleshooting](./docs/troubleshooting.md) page.
+Still struggling? Please, [*file an issue*](https://github.com/spaceship-prompt/spaceship-prompt/issues/new/choose), describe your problem, and we will gladly help you.
 
-Still struggling? Please, [file an issue](https://github.com/spaceship-prompt/spaceship-prompt/issues/new/choose), describe your problem and we will gladly help you.
-
-## Related Projects
+## 👀 Derived Projects
 
 Here's a list of related projects that have been inspired by Spaceship ZSH.
 
+- [**denysdovhan/dotfiles**](https://github.com/denysdovhan/dotfiles) - Dotfiles of Spaceship's author from which Spaceship is originated.
 - [**matchai/spacefish**](https://github.com/matchai/spacefish) - A port of Spaceship ZSH for fish shell intending to achieve complete feature parity.
 - [**starship/starship**](https://github.com/starship/starship) - A blazing-fast, cross-shell prompt written in Rust, heavily inspired by Spaceship ZSH.
 
-## Team
-
-| [![Denys Dovhan](https://github.com/denysdovhan.png?size=100)](http://denysdovhan.com) | [![Salmanul Farzy](https://github.com/salmanulfarzy.png?size=100)](https://github.com/salmanulfarzy) | [![Maxim Baz](https://github.com/maximbaz.png?size=100)](https://github.com/maximbaz) | [![Runrioter Wung](https://github.com/Runrioter.png?size=100)](https://github.com/Runrioter) |
-| :------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------: |
-|                     [Denys Dovhan](https://github.com/denysdovhan)                     |                          [Salmanul Farzy](https://github.com/salmanulfarzy)                          |                       [Maxim Baz](https://github.com/maximbaz)                        |                        [Runrioter Wung](https://github.com/Runrioter)                        |
-
-## Donate
-
-Hi! I work on this project in my spare time, in addition to my primary job. I hope you enjoy using Spaceship ZSH. If you do, please, [become my patron 🤝][patreon-url].
-
-|                                                                    Patreon                                                                     |                                                            Bitcoin                                                             |                                                            Ethereum                                                            |
-| :--------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------: |
-|                                                         [Become a patron][patreon-url]                                                         |                                              `1FrPrQb6ACTkbSBAz9PduJWrDFfq41Ggb4`                                              |                                          `0x6aF39C917359897ae6969Ad682C14110afe1a0a1`                                          |
-| <a href="https://www.patreon.com/denysdovhan"><img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="150px"></a> | <img src="https://user-images.githubusercontent.com/3459374/33760933-1c9b81b4-dc10-11e7-8e4b-22d81f98c138.png" width="100px"/> | <img src="https://user-images.githubusercontent.com/3459374/33760932-1c7b3fb2-dc10-11e7-9774-411264d533da.png" width="100px"/> |
-
-This is your way make a clear statement: **My work is valued.**
-
-I would appreciate your support! _Thank you!_
-
-## License
+## 📄 License
 
 MIT © [Denys Dovhan](http://denysdovhan.com)
 
-<!-- Badges -->
-
-[npm-url]: https://npmjs.org/package/spaceship-prompt
-[npm-image]: https://img.shields.io/npm/v/spaceship-prompt.svg?style=flat-square
+<!-- References -->
 [zsh-url]: http://zsh.org/
-[zsh-image]: https://img.shields.io/badge/zsh-%3E%3Dv5.2-777777.svg?style=flat-square
 [patreon-url]: https://www.patreon.com/denysdovhan
-[patreon-image]: https://img.shields.io/badge/zsh-%3E%3Dv5.2-777777.svg?style=flat-square
-
-<!-- References -->
-
-[oh-my-zsh]: http://ohmyz.sh/
-[prezto]: https://github.com/sorin-ionescu/prezto
-[zim]: https://github.com/zimfw/zimfw
-[antigen]: http://antigen.sharats.me/
-[zgen]: https://github.com/tarjoilija/zgen
-[npm]: https://www.npmjs.com/
-[antibody]: https://github.com/getantibody/antibody
-[zplug]: https://github.com/zplug/zplug
-[homebrew]: https://brew.sh
-[n]: https://github.com/tj/n
-[xcenv]: http://xcenv.org/
-[swiftenv]: https://github.com/kylef/swiftenv
-[powerline]: https://github.com/powerline/fonts
-[zinit]: https://github.com/zdharma/zinit

package/lib/cache.zsh

@@ -0,0 +1,30 @@
+# ------------------------------------------------------------------------------
+# CACHE
+# Spaceship storage for data
+# ------------------------------------------------------------------------------
+
+# Declare a cache variable
+typeset -gAh SPACESHIP_CACHE
+
+# Get cache value from a given key
+# USAGE:
+#   spaceship::cache::get <key>
+spaceship::cache::get() {
+  local key="$1"
+  echo -n "${SPACESHIP_CACHE[$key]}"
+}
+
+# Set cache value for a given key
+# USAGE:
+#   spaceship::cache::set <key> <value>
+spaceship::cache::set() {
+  local key="$1" value="$2"
+  SPACESHIP_CACHE[$key]="$value"
+}
+
+# Clear cache
+# USAGE:
+#   spaceship::cache::clear
+spaceship::cache::clear() {
+  SPACESHIP_CACHE=( )
+}