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

Conversation

andrewn617
Copy link
Contributor

Motivation / Background

This Pull Request has been created because I want to improve the output of RailsInspector::Cli. The first time I ran into an error from rails inspector, I was confused what it wanted me to do and had to read through the code to understand that I was missing adding my new configuration to cofiguring.md.

Detail

This Pull Request adds and additional line to the output of rails inspector to give the developer more direction, and also prompt them to use the --autocorrect flag.

Additional information

Checklist

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
  • Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
  • Tests are added or updated if you fix a bug or add a feature.
  • CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

Give the developer some direction on how to resolve the error so they don't need to read the code to figure it out.
@andrewn617 andrewn617 force-pushed the better-rails-inspector-message branch from e2911ba to 010600d Compare February 1, 2024 22:57
@gmcgibbon gmcgibbon merged commit 3d887b4 into rails:main Feb 1, 2024
5 checks passed
@gmcgibbon
Copy link
Member

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants