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

RFC – First draft of SCSS linting rules #37

Merged
merged 2 commits into from
Feb 23, 2016

Conversation

gvn
Copy link
Contributor

@gvn gvn commented Feb 11, 2016

This is my first attempt at defining our comprehensive list of rules for sass-lint.

Consider this PR a request for comments and discussion. Commenting inline on the .sass-lint.yml rules is probably easiest.

Also: Keep in mind that it's always easier to relax rules later than to add them!

@gvn gvn self-assigned this Feb 11, 2016
@gvn gvn changed the title First draft of SCSS linting rules RFC – First draft of SCSS linting rules Feb 11, 2016
@gvn
Copy link
Contributor Author

gvn commented Feb 11, 2016

CC: @simonwex @alanmoo @alicoding @mmmavis @ScottDowne @vazquez @flukeout @Pomax

Again, please @ mention anyone I may have forgotten!

@gvn
Copy link
Contributor Author

gvn commented Feb 12, 2016

Here's documentation for what all the rules mean:

https://github.com/sasstools/sass-lint/tree/develop/docs/rules

@flukeout
Copy link

@gvn is there a sample stylesheet somewhere that includes a lot of this proposed formatting? Pretty hard to comment on this stuff without seeing something more tangible.

@gvn
Copy link
Contributor Author

gvn commented Feb 12, 2016

It'd be pretty time consuming to do that. I'd encourage everyone who cares strongly to read the rules as they all contain examples.

As I mentioned, it's always easier to relax things later than add them. If any rule starts to feel overly restrictive we can always revise it or remove it entirely. 👍

@gvn gvn removed the PR needs work label Feb 12, 2016
@gvn
Copy link
Contributor Author

gvn commented Feb 12, 2016

Also, once we start using these rules I'd recommend that everyone install a plugin in their editor-of-choice that can read the RC. That way you get immediate feedback as you write your code instead of getting hit with a bunch of errors all at once.

In Atom, for instance, you can install linter and linter-sass-lint to get something like this:

screen shot 2016-02-12 at 1 57 56 pm

@gvn
Copy link
Contributor Author

gvn commented Feb 18, 2016

@flukeout We're using this set of rules in Foxlight, so if you want an idea of how it looks in practice you can check out our SCSS here:

https://github.com/mozilla/foxlight/tree/master/src/scss

@gvn
Copy link
Contributor Author

gvn commented Feb 22, 2016

Ok I did some tweaks based on @alanmoo 's feedback.

If no one else has any feedback I'd like to get this merged soon. 👍

@alanmoo
Copy link
Contributor

alanmoo commented Feb 23, 2016

🤗

gvn added a commit that referenced this pull request Feb 23, 2016
RFC – First draft of SCSS linting rules
@gvn gvn merged commit 6868e1c into MozillaFoundation:master Feb 23, 2016
@gvn gvn deleted the sasslint branch February 23, 2016 20:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants