MINOR/docs: adds a tip to the README.md stating that config example contains linter configs that might not exist on the dev's machine #407
+5
−0
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
…and rubocop config Users, like in Shopify#354, might simply copy the example configuration from the readme file and then get an error running erb_lint. This adds a tip that it is a) not needed, and b) contains references to config files, that might not exist on the user's machine.
|
I have signed the CLA! |
body-clock
reviewed
Apr 1, 2025
| > [!TIP] | ||
| > Creating an `.erb_lint.yml` config file is _not_ mandatory; **the tool works out of the box with default settings**. | ||
| > | ||
| > Please note that the two config files referenced in the examples above and below _must_ exist, or you will get an error. (Of course, you can ommit the two config file references (i.e. the `better_html_config` key, and the `rubocop_config` section.) |
There was a problem hiding this comment.
Suggested change
| > Please note that the two config files referenced in the examples above and below _must_ exist, or you will get an error. (Of course, you can ommit the two config file references (i.e. the `better_html_config` key, and the `rubocop_config` section.) | |
| > Please note that the two config files referenced in the examples above and below _must_ exist, or you will get an error. (Of course, you can omit the two config file references (i.e. the `better_html_config` key, and the `rubocop_config` section.) |
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.
Users, like
mea friend of mine, or @AndrewKrasnoff in #354, might simply copy the example configuration from the readme file and then get an error running erb_lint.This adds a tip that it is:
a) not needed to provide a config, and
b) that the example config contains references to linter config files, that might not exist on the user's machine.
Not strictly necessary (if you take your time before pasting), but a good hint and better onboarding experience for users who just copy stuff from readme files like monkeys do. 🙊