Tim Schaub tschaub

AngularJS Whitespace Guide

The purpose of this style guide is to suggest formatting conventions for AngularJS modules that result in readible, maintainable, and lint free code (see the linter configurations for JSHint and gjslint.py.

All-in-one example

Typically, an AngularJS application would be structured with many modules in separate files. The example below shows a monolithic module to illustrate the formatting conventions for various module methods.

angular.module('module.name', [

	/**
	* Layer with a style that provides symbolizers for
	* the "selected" render intent defined elsewhere.
	*/

	function highlight(feature) {
	feature.setRenderIntent('selected');
	}

	var path = require('path');
	var url = require('url');

	var log = require('npmlog');
	var closure = require('closure-util');

	log.info('serve', 'Parsing dependencies ...');

	var root = '.'; // assumes you're running this from ol3 repo

	CWD=`pwd`

	SELF=$0

	cd `dirname $SELF`
	SELF=`basename $SELF`

	# Iterate down a (possible) chain of symlinks
	while [ -L "$SELF" ]
	do

	goog.require('ol.Feature');
	goog.require('ol.Map');
	goog.require('ol.RendererHint');
	goog.require('ol.View2D');
	goog.require('ol.geom.Point');
	goog.require('ol.layer.TileLayer');
	goog.require('ol.layer.Vector');
	goog.require('ol.parser.GeoJSON');
	goog.require('ol.projection');
	goog.require('ol.source.MapQuestOpenAerial');

	function mapFunc() {
	var i, ii, key, doc, service;
	for (i = 0, ii = this.resources.length; i < ii; ++i) {
	key = this.resources[i];
	doc = {
	services: {}
	};
	service = this.service \|\| '';
	doc.services[service] = 1;
	emit(key, doc);

	/**
	Time series generator. This generates a series of times (as seconds since
	the epoch) between any two start and end time values (also seconds since
	the epoch). The $1 value can be 'second', 'minute', 'hour', 'day', 'week', or
	'month'. The $2 and $3 values are start and end time respectively (in seconds
	since the epoch.
	*/
	select date_part('epoch', date_trunc($1, to_timestamp($2)) + concat(tmp.index, $1)::interval) as time from generate_series(
	0,
	case

	var layer = new ol.layer.TileLayer({
	source: new ol.source.MapQuestOpenAerial()
	});

	var map = new ol.Map({
	center: new ol.Coordinate(0, 0),
	layers: new ol.Collection([layer]),
	renderer: ol.RendererHint.DOM,
	target: 'map',
	zoom: 2