README.md

JavaScript Style Guide

This is the home of the Spil Games JavaScript Style Guide, and related content.

Table of Contents

• Style Guide
• Tools

Goals

The goals of this repository:

• Clear overview of rules
  • Commonly-agreed upon standards
  • Living document
• Introduce & document tools, such as:
  • Style checker
    • Verify if code adheres to style guide
    • Runs via command line + integrated in build process
    • Runs in editor (SublimeText, etc.)
  • Provide .editorconfig (see editorconfig.org)
  • Style fixer: Automatically fix code (e.g., via CodePainter)

Sources

A lot of content in this repository originated from the following sources:

• "Maintainable JavaScript" - Nicolas C. Zakas
• https://github.com/airbnb/javascript/
• https://github.com/rwaldron/idiomatic.js/
• http://addyosmani.com/blog/javascript-style-guides-and-beautifiers/