feat(kube-ps1): add kube-ps1 plugin

lib/utils.sh

@@ -347,8 +347,11 @@ _omb_util_unload_hook+=('PS1=$_omb_util_original_PS1')
 
 _omb_util_prompt_command=()
 function _omb_util_prompt_command_hook {
-  local status=$? lastarg=$_ hook
-  for hook in "${_omb_util_prompt_command[@]}"; do
+  local status=$? lastarg=$_ hook i
+  # Use an index loop so hooks registered mid-cycle (e.g. by earlier hooks) are
+  # picked up in the same prompt-render cycle rather than deferred to the next.
+  for ((i = 0; i < ${#_omb_util_prompt_command[@]}; i++)); do
+    hook=${_omb_util_prompt_command[i]}
     _omb_util_setexit "$status" "$lastarg"
     eval -- "$hook"
   done

plugins/README.md

@@ -45,6 +45,7 @@ By leveraging these plugins, you can streamline your workflow and tackle coding
 | golang            | The Go programming language, along with its tools and standard libraries.                                                   |
 | jump              | Jump helps you navigate faster by learning your habits.                                                                     |
 | kubectl           | Command-line tool for interacting with Kubernetes clusters.                                                                 |
+| kube-ps1          | Displays the current Kubernetes context and namespace in the shell prompt.                                                  |
 | npm               | Package manager for Node.js facilitating installation and management of project dependencies.                               |
 | nvm               | Node.js version manager allowing easy switching between different Node.js versions.                                         |
 | progress          | Insufficient information provided to give a precise description.                                                            |

plugins/kube-ps1/LICENSE

@@ -0,0 +1,179 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and the Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or any Work
+      incorporated within the Work constitutes direct or contributory patent
+      infringement, then any patent licenses granted to You under this License
+      for that Work shall terminate as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the Work
+      or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You meet
+      the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative Works
+          a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works that
+          You distribute, all copyright, patent, trademark, and attribution
+          notices from the Source form of the Work, excluding those notices
+          that do not pertain to any part of the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file, You must include a
+          readable copy of the attribution notices contained in such NOTICE
+          file, in at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within the Source
+          form or documentation, if provided along with the Derivative Works;
+          or, within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents of
+          the NOTICE file are for informational purposes only and do not
+          modify the License. You may add Your own attribution notices within
+          Derivative Works that You distribute, alongside or as an addendum
+          to the NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the License.
+
+      You may add Your own license statement for Your modifications and may
+      provide additional grant of rights to use, copy, modify, merge, publish,
+      distribute, sublicense, and/or sell copies of Your modifications, and
+      to permit persons to whom the Software is furnished to do so, subject to
+      the conditions in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work by
+      You to the Licensor shall be under the terms and conditions of this
+      License, without any additional terms or conditions. Notwithstanding
+      the above, nothing herein shall supersede or modify the terms of any
+      separate license agreement you may have executed with Licensor regarding
+      such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or agreed
+      to in writing, Licensor provides the Work (and each Contributor provides
+      its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+      CONDITIONS OF ANY KIND, either express or implied, including, without
+      limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT,
+      MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely
+      responsible for determining the appropriateness of using or reproducing
+      the Work and assume any risks associated with Your exercise of
+      permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise, unless
+      required by applicable law (such as deliberate and grossly negligent
+      acts) or agreed to in writing, shall any Contributor be liable to You
+      for damages, including any direct, indirect, special, incidental, or
+      consequential damages of any character arising as a result of this
+      License or out of the use or inability to use the Work (including but
+      not limited to damages for loss of goodwill, work stoppage, computer
+      failure or malfunction, or all other commercial damages or losses), even
+      if such Contributor has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing the
+      Work or Derivative Works thereof, You may choose to offer, and charge a
+      fee for, acceptance of support, warranty, indemnity, or other liability
+      obligations and/or rights consistent with this License. However, in
+      accepting such obligations, You may offer such obligations only on Your
+      own behalf and on Your sole responsibility, not on behalf of any other
+      Contributor, and only if You agree to indemnify, defend, and hold each
+      Contributor harmless for any liability incurred by, or claims asserted
+      against, such Contributor by reason of your accepting any warranty or
+      additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2020 Jon Mosco
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

plugins/kube-ps1/README.md

@@ -0,0 +1,120 @@
+# kube-ps1 plugin
+
+Displays the current [Kubernetes](https://kubernetes.io) context and namespace
+in the shell prompt.
+
+This plugin is a derivative work of
+[kube-ps1](https://github.com/jonmosco/kube-ps1) by Jon Mosco, adapted for
+Oh My Bash.
+
+## License & notices
+
+The original `kube-ps1` is Copyright 2020 Jon Mosco and is distributed under
+the [Apache License, Version 2.0](LICENSE).  A copy of that license is
+included in this directory (`plugins/kube-ps1/LICENSE`).
+
+This adapted version is also provided under the Apache License 2.0 alongside
+the MIT license that covers Oh My Bash as a whole.
+
+The original script can be found at
+<https://github.com/jonmosco/kube-ps1/blob/master/kube-ps1.sh>.
+
+---
+
+## Requirements
+
+* `kubectl` (or the binary set in `KUBE_PS1_BINARY`) must be installed and
+  reachable in `$PATH`.
+
+## Enable the plugin
+
+Add `kube-ps1` to the `plugins` array in your `~/.bashrc`:
+
+```bash
+plugins=(... kube-ps1)
+```
+
+## How the segment appears in your prompt
+
+Enabling the plugin is all that is required — no changes to `PS1` are needed.
+The plugin automatically prepends the kube segment to whatever `PS1` your
+active theme sets, on every command.
+
+If you prefer to control the exact position of the segment yourself (e.g.
+from a custom theme or a hand-crafted `PS1`), embed `$(kube_ps1)` literally:
+
+```bash
+PS1='[\u@\h \W $(kube_ps1)]\$ '
+```
+
+> **Note:** do not do both. When `$(kube_ps1)` is already present in `PS1`
+> literally, the automatic injection is skipped to prevent duplication.
+
+## Commands
+
+| Command         | Description                                          |
+|:----------------|:-----------------------------------------------------|
+| `kubeon`        | Enable the kube-ps1 prompt for this shell session    |
+| `kubeon -g`     | Enable the kube-ps1 prompt globally (persistent)     |
+| `kubeoff`       | Disable the kube-ps1 prompt for this shell session   |
+| `kubeoff -g`    | Disable the kube-ps1 prompt globally (persistent)    |
+
+## Configuration
+
+All variables can be set in `~/.bashrc` **before** oh-my-bash is sourced.
+
+### Display
+
+| Variable                    | Default   | Description                                           |
+|:----------------------------|:----------|:------------------------------------------------------|
+| `KUBE_PS1_BINARY`           | `kubectl` | Binary used to read context/namespace                 |
+| `KUBE_PS1_SYMBOL_ENABLE`    | `true`    | Show/hide the Kubernetes symbol (⎈)                   |
+| `KUBE_PS1_SYMBOL_PADDING`   | `false`   | Add a trailing space after the symbol                 |
+| `KUBE_PS1_SYMBOL_CUSTOM`    | _(empty)_ | Use a custom symbol: `img`, `k8s`, `oc`, or any char  |
+| `KUBE_PS1_CONTEXT_ENABLE`   | `true`    | Show/hide the context name                            |
+| `KUBE_PS1_NS_ENABLE`        | `true`    | Show/hide the namespace name                          |
+| `KUBE_PS1_PREFIX`           | `(`       | String prepended to the prompt segment                |
+| `KUBE_PS1_SUFFIX`           | `)`       | String appended to the prompt segment                 |
+| `KUBE_PS1_SEPARATOR`        | `\|`      | Separator between symbol and context                  |
+| `KUBE_PS1_DIVIDER`          | `:`       | Separator between context and namespace               |
+| `KUBE_PS1_HIDE_IF_NOCONTEXT`| `false`   | Hide the segment entirely when no context is active   |
+
+### Colours
+
+| Variable                | Default   | Description                                              |
+|:------------------------|:----------|:---------------------------------------------------------|
+| `KUBE_PS1_CTX_COLOR`    | `red`     | Context name colour                                      |
+| `KUBE_PS1_NS_COLOR`     | `cyan`    | Namespace colour                                         |
+| `KUBE_PS1_SYMBOL_COLOR` | `blue`    | Symbol colour                                            |
+| `KUBE_PS1_PREFIX_COLOR` | _(empty)_ | Prefix colour (empty = no colour code)                   |
+| `KUBE_PS1_SUFFIX_COLOR` | _(empty)_ | Suffix colour (empty = no colour code)                   |
+| `KUBE_PS1_BG_COLOR`     | _(empty)_ | Background colour for the whole segment                  |
+
+Accepted colour values: `black`, `red`, `green`, `yellow`, `blue`,
+`magenta`, `cyan`, `white`, or an integer `0`–`255` for 256-colour
+terminals.
+
+### Custom functions
+
+You can provide shell functions to dynamically transform or colour values:
+
+| Variable                      | Signature                              | Description                                       |
+|:------------------------------|:---------------------------------------|:--------------------------------------------------|
+| `KUBE_PS1_CLUSTER_FUNCTION`   | `my_fn <context>  → string`            | Transform the context name before display         |
+| `KUBE_PS1_NAMESPACE_FUNCTION` | `my_fn <namespace> → string`           | Transform the namespace before display            |
+| `KUBE_PS1_CTX_COLOR_FUNCTION` | `my_fn <context>  → colour`            | Return a colour name/number for the context       |
+
+## Example
+
+```bash
+# ~/.bashrc
+
+# Show only the last segment of the context name
+kube_short_ctx() { printf '%s' "${1##*/}"; }
+export KUBE_PS1_CLUSTER_FUNCTION=kube_short_ctx
+
+plugins=(... kube-ps1)
+source "$OSH"/oh-my-bash.sh
+
+PS1='[\u@\h \W $(kube_ps1)]\$ '
+```