Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 1.55 KB

javascript.md

File metadata and controls

33 lines (25 loc) · 1.55 KB
Raw

JavaScript coding guide

As a general rule, it is a good idea to get inspiration from the community-approved AngularJS style guide.

This starter kit architecture and base template tries to comply with most of the rules described there.

Naming convention

  • Use camelCase everywhere (properties and methods), except for:
    • Class names and constructors which should starts in uppercase.
    • Constants should be all in UPPERCASE, like var MY_CONSTANT = 0;
  • File names should always be in snake-case

Coding rules

  • Use single quotes ' for strings
  • Dependency injection order: start with the most generic (framework, external libs) to the most specific (project modules)
  • Use 1 line per dependency inject/import, to ease merges and improve readability
  • Use the _ prefix for internal variable names
  • Only expose properties / methods publicly when it's needed, do not put everything in the $scope
  • Never put anything in the global scope
  • Always use strict equality checks: === and !== instead of == or != to avoid comparison pitfalls (see JavaScipt equality table)
  • Use [] instead of Array

Enforcement

Good practices and coding rules are already enforced in this project via JSHint, JSCS. If there is a warning/error, fix it. If you think the related rule is not justified or a must-have rule is missing, submit a pull request with a justification for the change, and we will consider it :-)