Javascript Code Style

Introduction

The purpose of this style guide is to provide guidance on building Javascript applications by showing the conventions used at ILMG, to help us and other development teams working on our projects.

We currently use Angular 1.x for our Javascript framework of choice and the ES5 standard.

Guides

We use the well respected guide from John Papa as the first point of reference, which has been endorsed by the Angular Core Team.

Please see here :

• Full Angular 1.x Style Guide
• Angular API Reference

Code References

Please see the following points as a good start when developing applications with Angular :

• Single Responsibility
• Immediately Invoked Function Expression (IIFE)
• Modules
• Controllers (controllerAs with vm)
• Services - (We favour the use of '.services' over '.factory')
• Data Services
• Resolving Promises
• Directives

Syntax :

• JSCS
• JSCS (Docs & Options)
• JS Hint
• JS Hint (Docs & Options)

Documentation :

• jsDoc

Testing

We use Karma and Protractor with Jasmine for our testing processes.

• Testing Guide
• Jasmine
• Protractor
• Karma

Task Automation

We currently use Gulp for running our automated tasks.

Learn more about gulp and patterns for task automation here

Other

Here are some other useful links :

• ES5
• Angular 1.x
• Keeping a forked project in sync