[Doc] Add config.generators.after_generate Rails config to docs
#956
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
andyw8
reviewed
Mar 17, 2023
README.md
Outdated
| module YourCoolApp | ||
| class Application < Rails::Application | ||
| config.generators.after_generate do |files| | ||
| system('bundle exec rubocop -A ' + files.join(' '), exception: true) |
There was a problem hiding this comment.
Would -a have a different result for this?
There was a problem hiding this comment.
It shows -A intentionally. I've added that intent to the documentation.
There was a problem hiding this comment.
Should this be files.shelljoin instead? What if some homebrew generator spits out filenames with spaces or escape sequences?
Passing raw strings to system is scary. 😨
There was a problem hiding this comment.
Good cath! shelljoin would be a better choice.
koic
force-pushed
the
add_rails_tips_to_docs
branch
2 times, most recently
from
1b30576
to
e55e26a
Compare
This PR adds a Rails feature introduced by rails/rails#38870 to docs.
koic
force-pushed
the
add_rails_tips_to_docs
branch
from
e55e26a
to
ca6f2fe
Compare
tmaier
added a commit
to tmaier/rubocop-rails
that referenced
this pull request
Mar 26, 2023
Without this, the generator would exit with an error, if it found any warning or less severe offenses. Related to rubocop#956
tmaier
added a commit
to tmaier/rubocop-rails
that referenced
this pull request
Apr 5, 2023
Files not supported by rubocop would lead to an error, which in turn would mean that the rails generate command would fail. We are going to filter the files to ensure unsupported files are not sent to rubocop Followup for rubocop#961 and rubocop#956
tmaier
added a commit
to tmaier/rubocop-rails
that referenced
this pull request
Apr 5, 2023
Files not supported by rubocop would lead to an error, which in turn would mean that the rails generate command would fail. We are going to filter the files to ensure unsupported files are not sent to rubocop Follow-up for rubocop#961 and rubocop#956
tmaier
added a commit
to tmaier/rubocop-rails
that referenced
this pull request
Apr 12, 2023
Previously, the 'rails generate' command would send unsupported files to Rubocop,causing errors and failures in the process. To fix this, we added a filter that only sends parsable files to Rubocop. This commit updates the documentation to reflect this change, helping users avoid errors and complete 'rails generate' command successfully. Follow-up to rubocop#961 and rubocop#956
tmaier
added a commit
to tmaier/rubocop-rails
that referenced
this pull request
Apr 12, 2023
Previously, the 'rails generate' command would send unsupported files to Rubocop, causing errors and failures in the process. To fix this, we added a filter that only sends parsable files to Rubocop. This commit updates the documentation to reflect this change, helping users avoid errors and complete 'rails generate' command successfully. Follow-up to rubocop#961 and rubocop#956
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.
This PR adds a Rails feature introduced by rails/rails#38870 to docs.
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.