tabcompletion: sort commands on generated scripts

Author: schettino72

bash_completion_doit

@@ -1,5 +1,5 @@
 # bash completion for doit
-# auto-generate by `doit tabcomplention`
+# auto-generate by `doit tabcompletion`
 
 # to activate it you need to 'source' the generate script
 # $ source <generated-script>
@@ -14,7 +14,7 @@ _doit()
     # remove colon from word separator list because doit uses colon on task names
     _get_comp_words_by_ref -n : cur prev words cword
     # list of sub-commands
-    sub_cmds="dumpdb run help strace auto list ignore clean tabcompletion forget reset-dep"
+    sub_cmds="auto clean dumpdb forget help ignore info list reset-dep run strace tabcompletion"
 
 
     # options that take file/dir as values should complete file-system
@@ -77,48 +77,52 @@ _doit()
 
     case ${words[1]} in
 
+        auto)
+            COMPREPLY=( $(compgen -W "${tasks}" -- $cur) )
+            return 0
+            ;;
+        clean)
+            COMPREPLY=( $(compgen -W "${tasks}" -- $cur) )
+            return 0
+            ;;
         dumpdb)
             COMPREPLY=( $(compgen -f -- $cur) )
             return 0
             ;;
-        run)
+        forget)
             COMPREPLY=( $(compgen -W "${tasks}" -- $cur) )
             return 0
             ;;
         help)
             COMPREPLY=( $(compgen -W "${tasks} ${sub_cmds}" -- $cur) )
             return 0
             ;;
-        strace)
+        ignore)
             COMPREPLY=( $(compgen -W "${tasks}" -- $cur) )
             return 0
             ;;
-        auto)
+        info)
             COMPREPLY=( $(compgen -W "${tasks}" -- $cur) )
             return 0
             ;;
         list)
             COMPREPLY=( $(compgen -W "${tasks}" -- $cur) )
             return 0
             ;;
-        ignore)
+        reset-dep)
             COMPREPLY=( $(compgen -W "${tasks}" -- $cur) )
             return 0
             ;;
-        clean)
+        run)
             COMPREPLY=( $(compgen -W "${tasks}" -- $cur) )
             return 0
             ;;
-        tabcompletion)
-            COMPREPLY=( $(compgen -f -- $cur) )
-            return 0
-            ;;
-        forget)
+        strace)
             COMPREPLY=( $(compgen -W "${tasks}" -- $cur) )
             return 0
             ;;
-        reset-dep)
-            COMPREPLY=( $(compgen -W "${tasks}" -- $cur) )
+        tabcompletion)
+            COMPREPLY=( $(compgen -f -- $cur) )
             return 0
             ;;
     esac

doit/cmd_base.py

@@ -58,13 +58,17 @@ class Command(object):
     execute_tasks = False
 
     def __init__(self):
-        self.name = self.name or self.__class__.__name__.lower()
+        self.name = self.get_name()
         Command.CMD_LIST.append(self.name)
         self.options = self.set_options()
         # Use post-mortem PDB in case of error loading tasks.
         # Only available for `run` command.
         self.pdb = False
 
+    @classmethod
+    def get_name(cls):
+        return cls.name or cls.__name__.lower()
+
     def set_options(self):
         """@reutrn list of CmdOption
         """

doit/cmd_completion.py

@@ -84,7 +84,7 @@ def _generate_bash(self, opt_values, pos_args):
         pt_bin_name = sys.argv[0].split('/')[-1]
         tmpl_vars = {
             'pt_bin_name': pt_bin_name,
-            'pt_cmds': ' '.join(self.doit_app.sub_cmds),
+            'pt_cmds': ' '.join(sorted(self.doit_app.sub_cmds)),
             'pt_list_param': pt_list_param,
             }
 
@@ -101,7 +101,9 @@ def _generate_bash(self, opt_values, pos_args):
 
         # case statement to complete sub-commands
         cmds_args = []
-        for cmd in self.doit_app.sub_cmds.values():
+        cmd_list = sorted(self.doit_app.sub_cmds.values(),
+                          key = lambda c: c.get_name())
+        for cmd in cmd_list:
             cmds_args.append(self._bash_cmd_args(cmd))
         comp_subcmds = ("\n    case ${words[1]} in\n" +
                         "".join(cmds_args) +
@@ -167,7 +169,9 @@ def _generate_zsh(self, opt_values, pos_args):
         # deal with doit commands
         cmds_desc = []
         cmds_args = []
-        for cmd in self.doit_app.sub_cmds.values():
+        cmd_list = sorted(self.doit_app.sub_cmds.values(),
+                          key = lambda c: c.get_name())
+        for cmd in cmd_list:
             cmds_desc.append("    '{0}: {1}'".format(cmd.name, cmd.doc_purpose))
             cmds_args.append(self._zsh_cmd_args(cmd))