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.

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

Improve the output of RailsInspect::Cli #50942

Merged
merged 1 commit into from
Feb 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion tools/rail_inspector/lib/rail_inspector/cli.rb
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def configuration(rails_path)
checker = Configuring.new(rails_path)
checker.check

puts checker.errors unless checker.errors.empty?
puts checker.error_message if checker.errors.any?
exit checker.errors.empty? unless options[:autocorrect]

checker.write!
Expand Down
8 changes: 8 additions & 0 deletions tools/rail_inspector/lib/rail_inspector/configuring.rb
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,14 @@ def write!
File.write(doc_path, doc.to_s)
end

def error_message
return unless errors.any?

errors.join("\n") + "\n" +
"Make sure new configurations are added to configuring.md#rails-general-configuration in alphabetical order.\n" +
"Errors may be autocorrectable with the --autocorrect flag"
end

private
def doc_path
@rails_path.join(DOC_PATH)
Expand Down