Skip to content

CSS style guide

Connor Shea requested to merge (removed):css-style-guide into master

Working towards what was discussed in #13552 (closed), this adds the SCSS Linter gem for style guide conformity in CI.

TODO:

  • Agree on and write SCSS Style Guide Documentation.
  • Document the scss-lint config file.
  • Figure out how best to run this in CI, right now it's taking longer than I would think it should.
  • Use CSSComb for auto-correction (Maybe just include a CSSComb config file and have developers run the node package manually if they're interested in using it?).

My logic for not using CSSComb in the first place is that, AFAIK, we don't currently require Node/NPM, even in the dev environment. Maybe I'm wrong about that? scss-lint is a Ruby implementation of a similar concept, but it doesn't include autocorrect.

Is there a way we can run get GitLab CI to run scss-lint without having to put together the full GitLab application? Seeing as it's just static analysis, it seems like a waste of time/resources.

/cc @jschatz1 @rspeicher

Merge request reports