Show default help when calling help outside a Rails application #41425
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
p8
commented
Feb 12, 2021
p8
commented
Feb 12, 2021
p8
commented
Feb 12, 2021
p8
commented
Feb 13, 2021
| @@ -1009,7 +1009,7 @@ def test_skip_webpack_install | |||
| assert_no_file "config/webpacker.yml" | |||
|
|
|||
| output = Dir.chdir(destination_root) do | |||
| `bin/rails help` | |||
| `bin/rails -h` | |||
There was a problem hiding this comment.
bin/rails help no longer outputs the extended commands (just the common commands ). So this had to be changed to bin/rails -h which does output the extended commands.
p8
changed the title
p8
changed the title
railties/lib/rails/command.rb
Outdated
Comment on lines
35
to
39
| if char = namespace =~ /:(\w+)$/ | ||
| command_name, namespace = $1, namespace.slice(0, char) | ||
| elsif namespace.blank? | ||
| command_name, namespace = "help", "help" | ||
| elsif HELP_MAPPINGS.include?(namespace) | ||
| command_name, namespace = "help_extended", "help" | ||
| elsif VERSION_MAPPINGS.include?(namespace) | ||
| command_name, namespace = "version", "version" | ||
| else | ||
| command_name = namespace | ||
| end |
There was a problem hiding this comment.
If HELP_MAPPINGS and VERSION_MAPPINGS were Sets or Regexps, we could write:
Suggested change
| if char = namespace =~ /:(\w+)$/ | |
| command_name, namespace = $1, namespace.slice(0, char) | |
| elsif namespace.blank? | |
| command_name, namespace = "help", "help" | |
| elsif HELP_MAPPINGS.include?(namespace) | |
| command_name, namespace = "help_extended", "help" | |
| elsif VERSION_MAPPINGS.include?(namespace) | |
| command_name, namespace = "version", "version" | |
| else | |
| command_name = namespace | |
| end | |
| case namespace | |
| when /^(.+):(\w+)$/ | |
| namespace, command_name = $1, $2 | |
| when "" | |
| namespace, command_name = "help", "help" | |
| when HELP_MAPPINGS | |
| namespace, command_name = "help", "help_extended" | |
| when VERSION_MAPPINGS | |
| namespace, command_name = "version", "version" |
Also, it might be good to factor this out into a method like split_command_name or split_namespace_and_command_name which would return a [namespace, command_name] pair.
There was a problem hiding this comment.
Ah, that looks very nice. 👍
I've extracted it to a split_namespace method.
|
Checking back in on this @p8. Do you need any help getting it across the finish line? |
|
Hi @olivierlacan, sorry for not getting back to you when this issue was raised. 🙇 I think this PR is good to go but more reviews are welcome 😄 I've rebased the PR to main and I'll add some screenshots for extra clarity. BTW the USAGE file is printed on the following line: The definition of desc is here:rails/railties/lib/rails/command/base.rb Line 31 in 94b9545 |
|
Comparing to 6.1.3. 6.1.3.2Outside of a Rails app directory: Inside of a Rails app directory: This PROutside of a Rails app directory: Inside of a rails app directory: I think this makes a lot of sense. But you know what I realized? The order of the "most common Rails command" makes no sense. Why would Anyway, to me this is a great improvement already. 👍 |
|
@p8 You need another rebase but aside from that @jonathanhefner do you think this looks good? |
|
Thanks for the review @olivierlacan ! I've rebased against main. |
|
@olivierlacan I agree that outside an app folder, |
When running `rails -h` or just `rails` outside a Rails application, Rails outputs all options for running the `rails new` command. This can be confusing to users when they probably want to see the common Rails commands. Instead, we should always show the common commands when running `rails -h` inside or outside a Rails application. With this change help works as follows... Outside a Rails application we never show the extended commands: db:migrate, etc... The extended commands require a Rails application. They also take up a lot screen space. - `rails` outputs the help for the common commands - `rails -h` outputs the help for the common commands. - `rails new -h` outputs the help for the new command. Inside a Rails application it works mostly as before. The only change is that calling plain `bin/rails` now only outputs the common commands and not the extended commands. - `bin/rails` outputs the help for the common commands - `bin/rails -h` outputs the help for the common commands and the extended commands
|
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. |
9 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
When running
rails -hor justrailsoutside a Rails application,Rails outputs all options for running the
rails newcommand. This can beconfusing to users when they probably want to see the common Rails commands.
Instead, we should always show the common commands when running
rails -hinside or outside a Rails application.
With this change help works as follows...
Outside a Rails application we always show the default help when calling
railswithout a command like
new.We never show the extended commands: db:migrate, etc...
The extended commands require a Rails application.
They also take up a lot screen space.
railsoutputs the help for the common commandsrails -houtputs the help for the common commands.rails new -houtputs the help for the new command.Inside a Rails application it works mostly as before. The only change is
that calling plain
bin/railsnow only outputs the common commands andnot the extended commands.
bin/railsoutputs the help for the common commandsbin/rails -houtputs the help for the common commands and theextended commands
This is a work in progress for #40823
cc @olivierlacan