Express style guides in code about guides HOT 7 CLOSED

I've been thinking for a while that it would make sense to have a rubocop.yml file or something similar in this repo to go along with the guides. That way, we can submit pull requests which update guides and linter config at the same time.

Then we could just copy the config changes to Hound (or eventually maybe get Hound to pull changes from this repository).

Anybody have feelings on that?

from guides.

I heartily approve of providing a well-commented rubocop.yml file.

from guides.

First off, I enjoy your tree output.

Second, I am in support of splitting out sections into subdirectories as you've suggested.

I've no strong feelings about the codified linter files, but don't think I'd want it to be a "literate config". I'd rather have it be sparse, with comment links-to-sections in the READMEs at best, and have the suggestions in prose in READMEs.

from guides.

When I say "well-commented", I mean comments like "Prefer if over unless" above the appropriate line. I think we agree on that, Caleb.

Without that context, rubocop.yml will be hard to read and hard to change if I want to copy it to a project but change one item. It's not the most intuitive of formats.

from guides.

When I say "well-commented", I mean comments like "Prefer if over unless" above the appropriate line. I think we agree on that, Caleb.

Sure, makes sense.

from guides.

@jferris Getting Hound to pull from here is an interesting idea—especially if more languages are supported. This provides a nice workflow with teams where style guides are pulled from a single location so that the same standards can be used across an organization.

I like the idea of having at least the more often used guides (Ruby, CoffeeScript, Sass, and maybe EditorConfig) accompanied by linter configs because they are more actionable than prose alone. The README component is still important as these explanations are often a great learning tool for someone new to a language but having a lint config, where applicable, is helpful.

It looks like Neat added an SCSS-Lint config last week.

from guides.

This is being discussed in Hound: houndci/hound#293

from guides.