Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow to Override Order of Commands in Help #642

Merged
merged 4 commits into from
May 11, 2023
Merged

Allow to Override Order of Commands in Help #642

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d681bb5
Thor: added overridable sort_commands! method
alessio-signorini May 25, 2020
e5031d2
Tests: added tests for Thor.sort_commands!
alessio-signorini May 25, 2020
60abf76
Copy edit the documentation
rafaelfranca May 11, 2023
b2590c1
There is no super method to check
rafaelfranca May 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Thor: added overridable sort_commands! method
  • Loading branch information
@alessio-signorini @rafaelfranca
alessio-signorini authored and rafaelfranca committed May 11, 2023
commit d681bb55436f10c6779740b27d8f33e65f62dcf8
19 changes: 18 additions & 1 deletion lib/thor.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:"
Expand Down Expand Up @@ -495,6 +495,23 @@ 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, for example defining
#
# def self.sort_commands!(list)
# list.sort_by! do |a,b|
# a[0] == :help ? -1 : a[0] <=> b[0]
# end
# end
#
# will put the +help+ command at the top
def sort_commands!(list)
defined?(super) ? super(list) : list.sort! { |a, b| a[0] <=> b[0] }
end

end

include Thor::Base
Expand Down