Merge pull request #642 from alessio-signorini/allow-to-override-comm…

…ands-sorting

Allow to Override Order of Commands in Help

lib/thor.rb

@@ -197,7 +197,7 @@ def help(shell, subcommand = false)
  Thor::Util.thor_classes_in(self).each do |klass|
  list += klass.printable_commands(false)
  end
- list.sort! { |a, b| a[0] <=> b[0] }
+ sort_commands!(list)
 
  if defined?(@package_name) && @package_name
  shell.say "#{@package_name} commands:"
@@ -495,6 +495,14 @@ def help(command = nil, subcommand = true); super; end
 "
  end
  alias_method :subtask_help, :subcommand_help
+
+ # Sort the commands, lexicographically by default.
+ #
+ # Can be overridden in the subclass to change the display order of the
+ # commands.
+ def sort_commands!(list)
+ list.sort! { |a, b| a[0] <=> b[0] }
+ end
  end
 
  include Thor::Base

spec/sort_spec.rb

@@ -0,0 +1,75 @@
+require "helper"
+
+describe Thor do
+ def shell
+ @shell ||= Thor::Base.shell.new
+ end
+
+ describe "#sort - default" do
+ my_script = Class.new(Thor) do
+ desc "a", "First Command"
+ def a; end
+
+ desc "z", "Last Command"
+ def z; end
+ end
+
+ before do
+ @content = capture(:stdout) { my_script.help(shell) }
+ end
+
+ it "sorts them lexicographillay" do
+ expect(@content).to match(/:a.+:help.+:z/m)
+ end
+ end
+
+
+ describe "#sort - simple override" do
+ my_script = Class.new(Thor) do
+ desc "a", "First Command"
+ def a; end
+
+ desc "z", "Last Command"
+ def z; end
+
+ def self.sort_commands!(list)
+ list.sort!
+ list.reverse!
+ end
+
+ end
+
+ before do
+ @content = capture(:stdout) { my_script.help(shell) }
+ end
+
+ it "sorts them in reverse" do
+ expect(@content).to match(/:z.+:help.+:a/m)
+ end
+ end
+
+
+ describe "#sort - simple override" do
+ my_script = Class.new(Thor) do
+ desc "a", "First Command"
+ def a; end
+
+ desc "z", "Last Command"
+ def z; end
+
+ def self.sort_commands!(list)
+ list.sort_by! do |a,b|
+ a[0] == :help ? -1 : a[0] <=> b[0]
+ end
+ end
+ end
+
+ before do
+ @content = capture(:stdout) { my_script.help(shell) }
+ end
+
+ it "puts help first then sorts them lexicographillay" do
+ expect(@content).to match(/:help.+:a.+:z/m)
+ end
+ end
+end