diff --git a/railties/CHANGELOG.md b/railties/CHANGELOG.md index 01d10615a4c1..f98c4be15ca5 100644 --- a/railties/CHANGELOG.md +++ b/railties/CHANGELOG.md @@ -1,3 +1,17 @@ +* When encountering an Unrecognized Command Error, the developer will be given the option to + run of the suggested corrections instead. + + ```txt + bin/rails action_txt:install + Unrecognized command "action_txt:install" + + Did you mean? action_text:install [Yn] Y + Installing JavaScript dependencies + ... + ``` + + *Andrew Novoselac & Gannon McGibbon* + * Skip generating a `test` job in ci.yml when a new application is generated with the `--skip-test` option. diff --git a/railties/lib/rails/command.rb b/railties/lib/rails/command.rb index 92dcf6a12548..912eed600034 100644 --- a/railties/lib/rails/command.rb +++ b/railties/lib/rails/command.rb @@ -44,6 +44,21 @@ def initialize(name) end end + class UnrecognizedCommandCorrector < Thor::Shell::Basic + def correct(error) + if defined?(DidYouMean::Correctable) && defined?(DidYouMean::SpellChecker) + say error.original_message + + error.corrections.detect do |correction| + correction if yes? DidYouMean.formatter.message_for([correction]) + " [Yn]" + end + else + say error.detailed_message + nil + end + end + end + include Behavior HELP_MAPPINGS = %w(-h -? --help).to_set @@ -76,6 +91,9 @@ def invoke(full_namespace, args = [], **config) rescue UnrecognizedCommandError => error if error.name == full_namespace && command && command_name == full_namespace command.perform("help", [], config) + elsif tty? + correction = UnrecognizedCommandCorrector.new.correct(error) + return invoke(correction, args, **config) if correction else puts error.detailed_message end @@ -167,6 +185,10 @@ def lookup_paths # :doc: def file_lookup_paths # :doc: @file_lookup_paths ||= [ "{#{lookup_paths.join(',')}}", "**", "*_command.rb" ] end + + def tty? + STDOUT.tty? + end end end end diff --git a/railties/test/command/help_integration_test.rb b/railties/test/command/help_integration_test.rb index aad929cd2986..80a442c0943d 100644 --- a/railties/test/command/help_integration_test.rb +++ b/railties/test/command/help_integration_test.rb @@ -15,7 +15,7 @@ class Rails::Command::HelpIntegrationTest < ActiveSupport::TestCase output = rails "vershen", allow_failure: true assert_match %(Unrecognized command "vershen"), output - assert_match "Did you mean? version", output + assert_match "Did you mean? version [Yn]", output end test "loads Rake tasks only once on unrecognized command" do