Style Guide

We ask that developers respect the following guidelines when contributing pull requests to Enyo.


The Enyo source code uses leading tabs for indentation of code.


Curly braces should always be used.

    // bad
    if (x) foo(); 

    // good
    if (x) {

Place the opening curly brace at the end of its line and the closing curly brace on a line by itself.

    for (var i=0; i<100; i++) { // opening curly brace at end of line
    } // closing curly brace on a line by itself

In "else" clauses, place the keyword else (or else if) between the braces.

    if (x) {
    } else if (y) {
    } else {


Variables should be declared at the top of functions and should be declared in a single block (as opposed to multiple var statements.

    var myVar, myVar2, ...,


We use a like-English rule whenever possible. For example, there should be no spaces on the inside of associations, and one space after a colon:

    var x = (x + 7) * 3;
    var y = {neft: 'zap'};
    var z = [1, 2, 3, (4 + 5)];

Use a single space after any keyword, including function:

    for (var i=0; i<100; i++) {

    while (x = 3) {

    x = function () {


We use single quotes instead of double quotes for quoting strings:

    var myString = 'Hello!';

Line Length

Lines should not exceed 100 characters. Try to split long statements logically so that it is easy for others to figure out the intent of the statement. If a comment would make a line too long, consider placing the comment before the statement it documents rather than to the right.


For code commenting guidelines, see Documenting Code for the API Reference.


In general, a module should only export a single kind.