Clearer readme for configuring a rule #910
Merged
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
|
Thanks, there are actually links in the block above about all of this see here including sample configs but I agree this should follow the pattern of the other examples. Can you do me a quick favour though and make sure you include a DCO with your PR. DCO - https://github.com/sasstools/sass-lint/blob/develop/CONTRIBUTING.md#developer-certificate-of-origin as per our contribution guidelines https://github.com/sasstools/sass-lint/blob/develop/CONTRIBUTING.md#pull-requests Thanks! 👍 |
|
Prompt response there! I've added the DCO, hope that suffices. |
|
(completely overlooked that sample config, thanks for pointing it out) |
1 similar comment
DanPurdy
reviewed
Oct 25, 2016
| @@ -79,13 +79,14 @@ For all [rules](https://github.com/sasstools/sass-lint/tree/master/docs/rules), | |||
|
|
|||
| If you want to configure options, set the rule to an array, where the first item in the array is the severity, and the second item in the array is an object including the options you would like to set. | |||
|
|
|||
| An example configuration of a rule with options look like the following: | |||
| Here an is example configuration of a rule, where we are specifying that breaking the [indentation rule](https://github.com/sasstools/sass-lint/blob/master/docs/rules/indentation.md) should be treated as an error (its severity set to two), and setting the `size` option of the rule to 2 spaces: | |||
|
corrected 😁 |
|
Thanks 👍 |
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.
It took me a few minutes to figure out how to configure a rule, given that there are no complete examples of a
sass-lint.yml(something that perhaps should be addressed?).In particular, it wasn't clear to me that the rule configuration needs to be nested under
rules:, or what the example config shown was doing. I've clarified both of these in this updated readme.Hope it helps, thanks for the great project.
DCO 1.1 Signed-off-by: James Riley webdevjamesriley@gmail.com