Code Style and Cleanup

[BrainBacon]

I propose we keep the codebase clean by enhancing integration with the following tools:

• JSHint
• JSCS
• conventional changelog
• Editor Config

JSHint

Right now jshint and conventional changelog are integrated with the project, but we have not been enforcing compliance with them.

Before you commit any JavaScript changes use the gulp jshint task, or while running the development server keep an eye out for any warnings produced by JSHint.

JSCS

JSCS will help us keep a consistent code style throughout all our JavaScript files. This will have to be integrated into this project and possibly gulp-begin.

A good place to get some boilerplate rules would be Bower

Additional resources for JSCS:

• http://jscs.info/rules
• https://yannick.cr/posts/enforcing-coding-rules-in-your-team-with-jscs/post

Conventional Changelog

gulp-begin comes with Conventional Changelog, and we should start following Angular Conventional Commit Format

Editor Config

We should produce a .editorconfig file that will help our editors automatically conform to some of our code style preferences. See the Editor Config homepage.

Additional Comments

I propose the following guidelines

• 4 spaces for indentation
• Single quotes for strings within JavaScript files
• 'use strict'; as the first line in all JavaScript files

You can use Google's JavaScript Style Guide for help with general JavaScript design choices.

TODO

• Documentation for a Contributing section with code style guidelines. Perhaps a CONTRIBUTING.md file.
• Addition of a JSCS task and config file
• Addition of a .editorconfig file

[BrainBacon]

JSCS is to be implemented in Beg-in/gulp-begin#2 and Fritz will use the implementation from gulp-begin.