1101253 - Automated way of checking for snippet code guideline compliance

Status: RESOLVED FIXED

(Snippets Graveyard :: General, defect)

Description

[Osmose [:osmose, :mkelly]]

There are requirements for snippet code documented at https://abouthome-snippets-service.readthedocs.org/en/latest/developing.html#snippet-requirements. There's also some style guides used across webdev that we like to subscribe to, documented at http://mozweb.readthedocs.org/en/latest/.

It's a PITA to spend time during code reviews bothering with these nits. gvn posted an interesting blog post (https://gist.github.com/gvn/7536832) essentially recommending that you automate these rules rather than making humans check them. I think this is a grand idea, and one that should be investigated!

One possible piece of this could be stylecop, potch's project to easily enforce odd rules against a CSS codebase: https://github.com/potch/stylecop

Comment 1

[Kristján Oddsson [:koddsson]]

Since you linked mozweb read the docs does this mean that we are following PEP8 in snippets?

Comment 2

[Osmose [:osmose, :mkelly]]

(In reply to Kristján Oddsson [:koddsson] from comment #1)
> Since you linked mozweb read the docs does this mean that we are following
> PEP8 in snippets?

Snippets the service, yes, with a few allowances (such as 100-character lines instead of 80 and leniency with how you prefer to format your docstrings). 

But this bug is about snippet code, as in the HTML/CSS/JavaScript in an individual snippet. We often have people external to the team making snippets, and an automated tool would help them.

Comment 3

[[github robot]]

Commit pushed to master at https://github.com/mozilla/snippets-service

https://github.com/mozilla/snippets-service/commit/8ac8ae045a39c54687243ae6d489f3ba0cf3be23
[bug 1101253] Add flake8 check to travis.

Comment 4

[Osmose [:osmose, :mkelly]]

Fixed and merged in https://github.com/mozilla/snippets-service/compare/c707e13d6c15...8b4bcb04ad73. Travis should now comment on PRs with linting status. Nice work!