Skip to content

Commit

Permalink
clearer readme for configuring a rule
Browse files Browse the repository at this point in the history
  • Loading branch information
mrjamesriley committed Oct 24, 2016
1 parent 47ae2e7 commit 987e096
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

```yml
indentation:
- 2
-
size: 2
rules:
indentation:
- 2
-
size: 2
```

### [Rules Documentation](https://github.com/sasstools/sass-lint/tree/master/docs/rules)
Expand Down

0 comments on commit 987e096

Please sign in to comment.