feat(jira): add help/usage cmd (#12293)

Co-authored-by: Carlo Sala <carlosalag@protonmail.com>
ohmyzsh · Mar 26, 2024 · 7647c79 · 7647c79
1 parent 3e05bef
commit 7647c79
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 1 deletion.
diff --git a/plugins/jira/README.md b/plugins/jira/README.md
@@ -16,18 +16,21 @@ This plugin supplies one command, `jira`, through which all its features are exp
 
 ## Commands
 
+`jira help` or `jira usage` will print the below usage instructions
+
 | Command       | Description                                               |
 | :------------ | :-------------------------------------------------------- |
 | `jira`        | Performs the default action                               |
 | `jira new`    | Opens a new Jira issue dialogue                           |
 | `jira ABC-123`   | Opens an existing issue                                |
 | `jira ABC-123 m` | Opens an existing issue for adding a comment           |
-| `jira dashboard [rapid_view]` |  # opens your JIRA dashboard              |
+| `jira dashboard [rapid_view]` |  Opens your JIRA dashboard              |
 | `jira mine`   | Queries for your own issues                               |
 | `jira tempo`  | Opens your JIRA Tempo                                     |
 | `jira reported [username]`  | Queries for issues reported by a user       |
 | `jira assigned [username]`  | Queries for issues assigned to a user       |
 | `jira branch` | Opens an existing issue matching the current branch name  |
+| `jira help` | Prints usage instructions  |
 
 
 ### Jira Branch usage notes

diff --git a/plugins/jira/_jira b/plugins/jira/_jira
@@ -11,6 +11,7 @@ _1st_arguments=(
   'assigned:search for issues assigned to a user'
   'branch:open the issue named after the git branch of the current directory'
   'dumpconfig:display effective jira configuration'
+  'help:print usage help to stdout'
 )
 
 _arguments -C \

diff --git a/plugins/jira/jira.plugin.zsh b/plugins/jira/jira.plugin.zsh
@@ -2,6 +2,21 @@
 #
 # See README.md for details
 
+function _jira_usage() {
+cat <<EOF
+jira                            Performs the default action
+jira new                        Opens a new Jira issue dialogue
+jira ABC-123                    Opens an existing issue
+jira ABC-123 m                  Opens an existing issue for adding a comment
+jira dashboard [rapid_view]     Opens your JIRA dashboard
+jira mine                       Queries for your own issues
+jira tempo                      Opens your JIRA Tempo
+jira reported [username]        Queries for issues reported by a user
+jira assigned [username]        Queries for issues assigned to a user
+jira branch                     Opens an existing issue matching the current branch name
+EOF
+}
+
 function jira() {
   emulate -L zsh
   local action jira_url jira_prefix
@@ -44,6 +59,8 @@ function jira() {
     open_command "${jira_url}/secure/CreateIssue!default.jspa"
   elif [[ "$action" == "assigned" || "$action" == "reported" ]]; then
     _jira_query ${@:-$action}
+  elif [[ "$action" == "help" || "$action" == "usage" ]]; then
+    _jira_usage
   elif [[ "$action" == "mine" ]]; then
     echo "Opening my issues"
     open_command "${jira_url}/issues/?filter=-1"