Move our recommended configs into a file that can be inherited #76
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
khiga8
commented
Jun 9, 2023
README.md
Outdated
|
|
||
| ``` ruby | ||
| gem "erb_lint", require: false | ||
| gem "erblint-github" | ||
| ``` | ||
|
|
||
| 2. Require the linters within the `.erb-linters` folder. This could be done by adding a file `.erb-linters/erblint-github.rb` with the following line. | ||
| 2. **Important**: Create a new file with the path `.erb-linters/erblint-github.rb` and add the line: |
There was a problem hiding this comment.
It'd be nice to eventually get rid of this step. I believe this requires updates to erb-lint.
|
👋 Hello and thanks for pinging us! You've entered our first responder queue. An accessibility first responder will review this soon.
|
JoyceZhu
approved these changes
Jun 9, 2023
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.
Fixes: #77
I discovered this
inherit_gemfunctionality exists upon diving into the erb-lint codebase! This lets consumers pull in the lint configs we define.This was not documented in the README and there aren't any custom erb-lint libraries out there, so we never knew this was possible.
This update will help ensure that consumers can pull in configuration we recommend when they bump this gem up.
While we can automatically inherit the specified configs, the custom rules are not automatically registered, so we still need the consumer to require it by creating a file in
.erb-linters/some_ruby_file.rband requiring our rules.