Indicate options position for all commands

Author: joeyates

lib/imap/backup/cli.rb

@@ -220,7 +220,7 @@ def mirror(source_email, destination_email)
     desc "remote SUBCOMMAND [OPTIONS]", "View info about online accounts"
     subcommand "remote", Remote
 
-    desc "restore EMAIL", "Restores a single account"
+    desc "restore EMAIL [OPTIONS]", "Restores a single account"
     long_desc <<~DESC
       Restores all backed-up emails for the supplied account to
       their original server.
@@ -236,7 +236,7 @@ def restore(email = nil)
       Restore.new(email, non_logging_options).run
     end
 
-    desc "setup", "Configure imap-backup"
+    desc "setup [OPTIONS]", "Configure imap-backup"
     long_desc <<~DESC
       A menu-driven command-line application used to configure imap-backup.
       Configure email accounts to back up.

lib/imap/backup/cli/local.rb

@@ -15,7 +15,7 @@ class CLI::Local < Thor
     include Thor::Actions
     include CLI::Helpers
 
-    desc "accounts", "List locally backed-up accounts"
+    desc "accounts [OPTIONS]", "List locally backed-up accounts"
     config_option
     format_option
     quiet_option
@@ -34,7 +34,7 @@ def accounts
     end
 
     desc(
-      "check",
+      "check [OPTIONS]",
       "Check the integrity of backups for all accounts (or the selected account(s))"
     )
     method_option(
@@ -54,7 +54,7 @@ def check
       Check.new(non_logging_options).run
     end
 
-    desc "folders EMAIL", "List backed up folders"
+    desc "folders EMAIL [OPTIONS]", "List backed up folders"
     config_option
     format_option
     quiet_option
@@ -76,7 +76,7 @@ def folders(email)
       end
     end
 
-    desc "list EMAIL FOLDER", "List emails in a folder"
+    desc "list EMAIL FOLDER [OPTIONS]", "List emails in a folder"
     config_option
     format_option
     quiet_option
@@ -101,7 +101,7 @@ def list(email, folder_name)
       end
     end
 
-    desc "show EMAIL FOLDER UID[,UID]", "Show one or more emails"
+    desc "show EMAIL FOLDER UID[,UID] [OPTIONS]", "Show one or more emails"
     long_desc <<~DESC
       Prints out the requested emails.
       If more than one UID is given, they are separated by a header indicating

lib/imap/backup/cli/remote.rb

@@ -13,7 +13,7 @@ class CLI::Remote < Thor
     include Thor::Actions
     include CLI::Helpers
 
-    desc "folders EMAIL", "List account folders"
+    desc "folders EMAIL [OPTIONS]", "List account folders"
     config_option
     format_option
     quiet_option
@@ -31,7 +31,7 @@ def folders(email)
       end
     end
 
-    desc "capabilities EMAIL", "List server capabilities"
+    desc "capabilities EMAIL [OPTIONS]", "List server capabilities"
     long_desc <<~DESC
       Lists the IMAP capabilities supported by the IMAP server.
     DESC
@@ -49,7 +49,7 @@ def capabilities(email)
       Kernel.puts capabilities.join(", ")
     end
 
-    desc "namespaces EMAIL", "List account namespaces"
+    desc "namespaces EMAIL [OPTIONS]", "List account namespaces"
     long_desc <<~DESC
       Lists namespaces defined for an email account.
 

lib/imap/backup/cli/single.rb

@@ -14,7 +14,7 @@ class CLI < Thor; end
   class CLI::Single < Thor
     include CLI::Helpers
 
-    desc "backup", "Backup a single email account based on command-line parameters"
+    desc "backup [OPTIONS]", "Backup a single email account based on command-line parameters"
     long_desc <<~DESC
       This is a "stand-alone" backup command that doesn't require
       a configuration file.

lib/imap/backup/cli/utils.rb

@@ -18,7 +18,10 @@ class CLI::Utils < Thor
     include Thor::Actions
     include CLI::Helpers
 
-    desc "ignore-history EMAIL", "Skip downloading emails up to today for all configured folders"
+    desc(
+      "ignore-history EMAIL [OPTIONS]",
+      "Skip downloading emails up to today for all configured folders"
+    )
     config_option
     quiet_option
     verbose_option