winnie1312 / style-guide

The Codeworks coding style guide

Codeworks coding style guide

This is a reference to the style conventions that we use at Codeworks.

General

Set up your code editor to:

• Indent with 2 spaces.
• Use only spaces for indentation (no tabs).
• Use Unix line endings.
• Avoid trailing whitespace.

Then make sure to respect correct indentation.

HTML

• Write classes and ids in lowercase, separating words with dashes.

<div class="my-class" id="my-id"></div>

JavaScript

• Put semicolons at the end of your statements.

// Bad
var letter = 'a'

// Good
var letter = 'a';

• Assign each variable on a separate line.

// Bad
var letter = 'a', number = 1;

var letter = 'a',
    number = 1;

// Good
var letter = 'a';
var number = 1;

• Use "camel case" for variable naming (if it's for a class the first letter is uppercase).

// Bad
var myboolean = true;

// Good
var myBoolean = true;

function MyClass (name) {
  this.name = name;
}

• Be descriptive with your variable names.

// Bad
var nos = 100;

// Good
var numberOfStudents = 100;

• Use function declarations, not expressions.

// Bad
var hello = function () {
  console.log('hello');
};

// Good
function hello () {
  console.log('hello');
}

• Put a space between a function name and its arguments when you declare it (not when you call it).

// Bad
function log(str) {
  console.log(str);
}

// Good
function log (str) {
  console.log(str);
}

• Put a space before blocks, and around keywords.

// Bad
if (a){
  b();
}

if (foo) {
    //...
}else {
    //...
}

// Good
if (a) {
  b();
}

if (foo) {
    //...
} else {
    //...
}

• Use single quotes for strings.

// Bad
var myString = "Hello world";

// Good
var myString = 'Hello world';