From fd8f72b27614d48ec06421fb80aff2eb10674a69 Mon Sep 17 00:00:00 2001
From: chenzj <tibazq@gmail.com>
Date: Sun, 14 Jul 2024 01:31:32 +0800
Subject: feat(opentofu): add plugin for OpenTofu (#12285)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- Adds aliases
- Sets up autocompletion
- Adds promp functions to show workspace and `tofu` version

Co-authored-by: Marc Cornellà <marc@mcornella.com>
---
 plugins/opentofu/README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 plugins/opentofu/README.md

(limited to 'plugins/opentofu/README.md')

diff --git a/plugins/opentofu/README.md b/plugins/opentofu/README.md
new file mode 100644
index 000000000..9c19501aa
--- /dev/null
+++ b/plugins/opentofu/README.md
@@ -0,0 +1,58 @@
+# OpenTofu plugin
+
+Plugin for OpenTofu, a fork of Terraform that is open-source, community-driven, and managed by the Linux Foundation. It adds
+completion for `tofu` command, as well as aliases and a prompt function.
+
+To use it, add `opentofu` to the plugins array of your `~/.zshrc` file:
+
+```shell
+plugins=(... opentofu)
+```
+
+## Requirements
+
+- [OpenTofu](https://opentofu.org/)
+
+## Aliases
+
+| Alias | Command         |
+| ----- | --------------- |
+| `tt`  | `tofu`          |
+| `tta` | `tofu apply`    |
+| `ttc` | `tofu console`  |
+| `ttd` | `tofu destroy`  |
+| `ttf` | `tofu fmt`      |
+| `tti` | `tofu init`     |
+| `tto` | `tofu output`   |
+| `ttp` | `tofu plan`     |
+| `ttv` | `tofu validate` |
+| `tts` | `tofu state`    |
+| `ttsh`| `tofu show`     |
+| `ttr` | `tofu refresh`  |
+| `ttt` | `tofu test`     |
+| `ttws`| `tofu workspace`|
+
+
+## Prompt functions
+
+- `tofu_prompt_info`: shows the current workspace when in an OpenTofu project directory.
+
+- `tofu_version_prompt_info`: shows the current version of the `tofu` commmand.
+
+To use them, add them to a `PROMPT` variable in your theme or `.zshrc` file:
+
+```sh
+PROMPT='$(tofu_prompt_info)'
+RPROMPT='$(tofu_version_prompt_info)'
+```
+
+You can also specify the PREFIX and SUFFIX strings for both functions, with the following variables:
+
+```sh
+# for tofu_prompt_info
+ZSH_THEME_TOFU_PROMPT_PREFIX="%{$fg[white]%}"
+ZSH_THEME_TOFU_PROMPT_SUFFIX="%{$reset_color%}"
+# for tofu_version_prompt_info
+ZSH_THEME_TOFU_VERSION_PROMPT_PREFIX="%{$fg[white]%}"
+ZSH_THEME_TOFU_VERSION_PROMPT_SUFFIX="%{$reset_color%}"
+```
-- 
cgit v1.2.3-70-g09d2