Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sample sass-lint.yml should contain explicit examples #57

Closed
lozandier opened this issue Aug 31, 2015 · 2 comments
Closed

Sample sass-lint.yml should contain explicit examples #57

lozandier opened this issue Aug 31, 2015 · 2 comments

Comments

@lozandier
Copy link

The readme shows rules with configuration options be set in example like the following code snippet, but does not does so in the sample .sass-lint.yml:

indentation:
  - 2
  -
    size: 2

It seems reasonable that rules such as quotes and indentation—rules commonly needed to be configured explicitly through options be done in the .sass-lint.yml file to reinforce this being done.

Noticed devs less experienced with YAML files & sass-lint I know were confused when they were getting output such as the following screenshot with their attempts of using gulp-sass-lint for the first time I've emulated:

screen shot 2015-08-30 at 9 58 47 pm

@Snugug Snugug changed the title Enhancement: Sample sass-lint.yml perhaps should have a few rules with configuration options explicitly set Sample sass-lint.yml should contain explicit examples Aug 31, 2015
@Snugug
Copy link
Member

Snugug commented Aug 31, 2015

We can improve the documentation to include a proper sample config file instead of pointing to our defaults, but I'm not going to add explicit configuration to the defaults as I want to ensure that that is defined in each rule.

@lozandier
Copy link
Author

That's an understandable stance to me.

@Snugug Snugug added this to the 1.1.0 milestone Aug 31, 2015
@Snugug Snugug self-assigned this Aug 31, 2015
@Snugug Snugug modified the milestones: 1.1.0, 1.2.0 Aug 31, 2015
Snugug added a commit that referenced this issue Sep 5, 2015
donabrams pushed a commit to donabrams/sass-lint that referenced this issue Nov 19, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants