CoffeeScript is a little language that compiles into JavaScript. Underneath that awkward Java-esque patina, JavaScript has always had a gorgeous heart. CoffeeScript is an attempt to expose the good parts of JavaScript in a simple way.

The golden rule of CoffeeScript is: "It‘s just JavaScript". The code compiles one-to-one into the equivalent JS, and there is no interpretation at runtime. You can use any existing JavaScript library seamlessly from CoffeeScript (and vice-versa). The compiled output is readable and pretty-printed, will work in every JavaScript runtime, and tends to run as fast or faster than the equivalent handwritten JavaScript.

Latest Version: 1.8.0

npm install -g coffee-script

Overview

CoffeeScript on the left, compiled JavaScript output on the right.

# Assignment:number   = 42opposite = true# Conditions:number = -42 if opposite# Functions:square = (x) -> x * x# Arrays:list = [1, 2, 3, 4, 5]# Objects:math =  root:   Math.sqrt  square: square  cube:   (x) -> x * square x# Splats:race = (winner, runners...) ->  print winner, runners# Existence:alert "I knew it!" if elvis?# Array comprehensions:cubes = (math.cube num for num in list)

var cubes, list, math, num, number, opposite, race, square,  __slice = [].slice;number = 42;opposite = true;if (opposite) {  number = -42;}square = function(x) {  return x * x;};list = [1, 2, 3, 4, 5];math = {  root: Math.sqrt,  square: square,  cube: function(x) {    return x * square(x);  }};race = function() {  var runners, winner;  winner = arguments[0], runners = 2 <= arguments.length ? __slice.call(arguments, 1) : [];  return print(winner, runners);};if (typeof elvis !== "undefined" && elvis !== null) {  alert("I knew it!");}cubes = (function() {  var _i, _len, _results;  _results = [];  for (_i = 0, _len = list.length; _i < _len; _i++) {    num = list[_i];    _results.push(math.cube(num));  }  return _results;})();

Installation

The CoffeeScript compiler is itself written in CoffeeScript, using the Jison parser generator. The command-line version of coffee is available as a Node.js utility. The core compiler however, does not depend on Node, and can be run in any JavaScript environment, or in the browser (see "Try CoffeeScript", above).

To install, first make sure you have a working copy of the latest stable version of Node.js, and npm (the Node Package Manager). You can then install CoffeeScript globally with npm:

npm install -g coffee-script

When you need CoffeeScript as a dependency, install it locally:

npm install --save coffee-script

If you‘d prefer to install the latest master version of CoffeeScript, you can clone the CoffeeScript source repository from GitHub, or download the source directly. To install the latest master CoffeeScript compiler with npm:

npm install -g jashkenas/coffeescript

Or, if you want to install to /usr/local, and don‘t want to use npm to manage it, open the coffee-script directory and run:

sudo bin/cake install

Usage

Once installed, you should have access to the coffee command, which can execute scripts, compile .coffee files into .js, and provide an interactive REPL. The coffee command takes the following options:

Expressions  Assign    Value "square"    Code "x"      Op *        Value "x"        Value "x"

Examples:

• Compile a directory tree of .coffee files in src into a parallel tree of .js files in lib:
  coffee --compile --output lib/ src/
• Watch a file for changes, and recompile it every time the file is saved:
  coffee --watch --compile experimental.coffee
• Concatenate a list of files into a single script:
  coffee --join project.js --compile src/*.coffee
• Print out the compiled JS from a one-liner:
  coffee -bpe "alert i for i in [0..10]"
• All together now, watch and recompile an entire project as you work on it:
  coffee -o lib/ -cw src/
• Start the CoffeeScript REPL (Ctrl-D to exit, Ctrl-Vfor multi-line):
  coffee

Literate CoffeeScript

Besides being used as an ordinary programming language, CoffeeScript may also be written in "literate" mode. If you name your file with a .litcoffee extension, you can write it as a Markdown document — a document that also happens to be executable CoffeeScript code. The compiler will treat any indented blocks (Markdown‘s way of indicating source code) as code, and ignore the rest as comments.

Just for kicks, a little bit of the compiler is currently implemented in this fashion: See it as a document, raw, and properly highlighted in a text editor.

I‘m fairly excited about this direction for the language, and am looking forward to writing (and more importantly, reading) more programs in this style. More information about Literate CoffeeScript, including an example program, are available in this blog post.

Language Reference

This reference is structured so that it can be read from top to bottom, if you like. Later sections use ideas and syntax previously introduced. Familiarity with JavaScript is assumed. In all of the following examples, the source CoffeeScript is provided on the left, and the direct compilation into JavaScript is on the right.

Many of the examples can be run (where it makes sense) by pressing the run button on the right, and can be loaded into the "Try CoffeeScript" console by pressing the load button on the left.

First, the basics: CoffeeScript uses significant whitespace to delimit blocks of code. You don‘t need to use semicolons ; to terminate expressions, ending the line will do just as well (although semicolons can still be used to fit multiple expressions onto a single line). Instead of using curly braces { } to surround blocks of code in functions, if-statements, switch, and try/catch, use indentation.

You don‘t need to use parentheses to invoke a function if you‘re passing arguments. The implicit call wraps forward to the end of the line or block expression.
console.log sys.inspect object → console.log(sys.inspect(object));

Functions Functions are defined by an optional list of parameters in parentheses, an arrow, and the function body. The empty function looks like this: ->

square = (x) -> x * xcube   = (x) -> square(x) * x

var cube, square;square = function(x) {  return x * x;};cube = function(x) {  return square(x) * x;};

Functions may also have default values for arguments, which will be used if the incoming argument is missing (null or undefined).

fill = (container, liquid = "coffee") ->  "Filling the #{container} with #{liquid}..."

var fill;fill = function(container, liquid) {  if (liquid == null) {    liquid = "coffee";  }  return "Filling the " + container + " with " + liquid + "...";};

Objects and Arrays The CoffeeScript literals for objects and arrays look very similar to their JavaScript cousins. When each property is listed on its own line, the commas are optional. Objects may be created using indentation instead of explicit braces, similar to YAML.

song = ["do", "re", "mi", "fa", "so"]singers = {Jagger: "Rock", Elvis: "Roll"}bitlist = [  1, 0, 1  0, 0, 1  1, 1, 0]kids =  brother:    name: "Max"    age:  11  sister:    name: "Ida"    age:  9

var bitlist, kids, singers, song;song = ["do", "re", "mi", "fa", "so"];singers = {  Jagger: "Rock",  Elvis: "Roll"};bitlist = [1, 0, 1, 0, 0, 1, 1, 1, 0];kids = {  brother: {    name: "Max",    age: 11  },  sister: {    name: "Ida",    age: 9  }};

In JavaScript, you can‘t use reserved words, like class, as properties of an object, without quoting them as strings. CoffeeScript notices reserved words used as keys in objects and quotes them for you, so you don‘t have to worry about it (say, when using jQuery).

$(‘.account‘).attr class: ‘active‘log object.class

$(‘.account‘).attr({  "class": ‘active‘});log(object["class"]);

Lexical Scoping and Variable Safety The CoffeeScript compiler takes care to make sure that all of your variables are properly declared within lexical scope — you never need to write var yourself.

outer = 1changeNumbers = ->  inner = -1  outer = 10inner = changeNumbers()

var changeNumbers, inner, outer;outer = 1;changeNumbers = function() {  var inner;  inner = -1;  return outer = 10;};inner = changeNumbers();

Notice how all of the variable declarations have been pushed up to the top of the closest scope, the first time they appear. outer is not redeclared within the inner function, because it‘s already in scope; inner within the function, on the other hand, should not be able to change the value of the external variable of the same name, and therefore has a declaration of its own.

This behavior is effectively identical to Ruby‘s scope for local variables. Because you don‘t have direct access to the var keyword, it‘s impossible to shadow an outer variable on purpose, you may only refer to it. So be careful that you‘re not reusing the name of an external variable accidentally, if you‘re writing a deeply nested function.

Although suppressed within this documentation for clarity, all CoffeeScript output is wrapped in an anonymous function: (function(){ ... })(); This safety wrapper, combined with the automatic generation of the var keyword, make it exceedingly difficult to pollute the global namespace by accident.

If you‘d like to create top-level variables for other scripts to use, attach them as properties on window, or on the exports object in CommonJS. The existential operator (covered below), gives you a reliable way to figure out where to add them; if you‘re targeting both CommonJS and the browser: exports ? this

If, Else, Unless, and Conditional Assignment If/else statements can be written without the use of parentheses and curly brackets. As with functions and other block expressions, multi-line conditionals are delimited by indentation. There‘s also a handy postfix form, with the if or unless at the end.

CoffeeScript can compile if statements into JavaScript expressions, using the ternary operator when possible, and closure wrapping otherwise. There is no explicit ternary statement in CoffeeScript — you simply use a regular if statement on a single line.

mood = greatlyImproved if singingif happy and knowsIt  clapsHands()  chaChaCha()else  showIt()date = if friday then sue else jill

var date, mood;if (singing) {  mood = greatlyImproved;}if (happy && knowsIt) {  clapsHands();  chaChaCha();} else {  showIt();}date = friday ? sue : jill;

Splats... The JavaScript arguments object is a useful way to work with functions that accept variable numbers of arguments. CoffeeScript provides splats ..., both for function definition as well as invocation, making variable numbers of arguments a little bit more palatable.

gold = silver = rest = "unknown"awardMedals = (first, second, others...) ->  gold   = first  silver = second  rest   = otherscontenders = [  "Michael Phelps"  "Liu Xiang"  "Yao Ming"  "Allyson Felix"  "Shawn Johnson"  "Roman Sebrle"  "Guo Jingjing"  "Tyson Gay"  "Asafa Powell"  "Usain Bolt"]awardMedals contenders...alert "Gold: " + goldalert "Silver: " + silveralert "The Field: " + rest

var awardMedals, contenders, gold, rest, silver,  __slice = [].slice;gold = silver = rest = "unknown";awardMedals = function() {  var first, others, second;  first = arguments[0], second = arguments[1], others = 3 <= arguments.length ? __slice.call(arguments, 2) : [];  gold = first;  silver = second;  return rest = others;};contenders = ["Michael Phelps", "Liu Xiang", "Yao Ming", "Allyson Felix", "Shawn Johnson", "Roman Sebrle", "Guo Jingjing", "Tyson Gay", "Asafa Powell", "Usain Bolt"];awardMedals.apply(null, contenders);alert("Gold: " + gold);alert("Silver: " + silver);alert("The Field: " + rest);

Loops and Comprehensions Most of the loops you‘ll write in CoffeeScript will be comprehensions over arrays, objects, and ranges. Comprehensions replace (and compile into) for loops, with optional guard clauses and the value of the current array index. Unlike for loops, array comprehensions are expressions, and can be returned and assigned.

# Eat lunch.eat food for food in [‘toast‘, ‘cheese‘, ‘wine‘]# Fine five course dining.courses = [‘greens‘, ‘caviar‘, ‘truffles‘, ‘roast‘, ‘cake‘]menu i + 1, dish for dish, i in courses# Health conscious meal.foods = [‘broccoli‘, ‘spinach‘, ‘chocolate‘]eat food for food in foods when food isnt ‘chocolate‘

var courses, dish, food, foods, i, _i, _j, _k, _len, _len1, _len2, _ref;_ref = [‘toast‘, ‘cheese‘, ‘wine‘];for (_i = 0, _len = _ref.length; _i < _len; _i++) {  food = _ref[_i];  eat(food);}courses = [‘greens‘, ‘caviar‘, ‘truffles‘, ‘roast‘, ‘cake‘];for (i = _j = 0, _len1 = courses.length; _j < _len1; i = ++_j) {  dish = courses[i];  menu(i + 1, dish);}foods = [‘broccoli‘, ‘spinach‘, ‘chocolate‘];for (_k = 0, _len2 = foods.length; _k < _len2; _k++) {  food = foods[_k];  if (food !== ‘chocolate‘) {    eat(food);  }}

Comprehensions should be able to handle most places where you otherwise would use a loop, each/forEach, map, or select/filter, for example: shortNames = (name for name in list when name.length < 5)
If you know the start and end of your loop, or would like to step through in fixed-size increments, you can use a range to specify the start and end of your comprehension.

countdown = (num for num in [10..1])

var countdown, num;countdown = (function() {  var _i, _results;  _results = [];  for (num = _i = 10; _i >= 1; num = --_i) {    _results.push(num);  }  return _results;})();

Note how because we are assigning the value of the comprehensions to a variable in the example above, CoffeeScript is collecting the result of each iteration into an array. Sometimes functions end with loops that are intended to run only for their side-effects. Be careful that you‘re not accidentally returning the results of the comprehension in these cases, by adding a meaningful return value — like true — or null, to the bottom of your function.

To step through a range comprehension in fixed-size chunks, use by, for example:
evens = (x for x in [0..10] by 2)

Comprehensions can also be used to iterate over the keys and values in an object. Use of to signal comprehension over the properties of an object instead of the values in an array.

yearsOld = max: 10, ida: 9, tim: 11ages = for child, age of yearsOld  "#{child} is #{age}"

var age, ages, child, yearsOld;yearsOld = {  max: 10,  ida: 9,  tim: 11};ages = (function() {  var _results;  _results = [];  for (child in yearsOld) {    age = yearsOld[child];    _results.push("" + child + " is " + age);  }  return _results;})();

If you would like to iterate over just the keys that are defined on the object itself, by adding a hasOwnProperty check to avoid properties that may be inherited from the prototype, use
for own key, value of object

The only low-level loop that CoffeeScript provides is the while loop. The main difference from JavaScript is that the while loop can be used as an expression, returning an array containing the result of each iteration through the loop.

# Econ 101if this.studyingEconomics  buy()  while supply > demand  sell() until supply > demand# Nursery Rhymenum = 6lyrics = while num -= 1  "#{num} little monkeys, jumping on the bed.    One fell out and bumped his head."

var lyrics, num;if (this.studyingEconomics) {  while (supply > demand) {    buy();  }  while (!(supply > demand)) {    sell();  }}num = 6;lyrics = (function() {  var _results;  _results = [];  while (num -= 1) {    _results.push("" + num + " little monkeys, jumping on the bed. One fell out and bumped his head.");  }  return _results;})();

For readability, the until keyword is equivalent to while not, and the loop keyword is equivalent to while true.

When using a JavaScript loop to generate functions, it‘s common to insert a closure wrapper in order to ensure that loop variables are closed over, and all the generated functions don‘t just share the final values. CoffeeScript provides the do keyword, which immediately invokes a passed function, forwarding any arguments.

for filename in list  do (filename) ->    fs.readFile filename, (err, contents) ->      compile filename, contents.toString()

var filename, _fn, _i, _len;_fn = function(filename) {  return fs.readFile(filename, function(err, contents) {    return compile(filename, contents.toString());  });};for (_i = 0, _len = list.length; _i < _len; _i++) {  filename = list[_i];  _fn(filename);}

Array Slicing and Splicing with Ranges Ranges can also be used to extract slices of arrays. With two dots (3..6), the range is inclusive (3, 4, 5, 6); with three dots (3...6), the range excludes the end (3, 4, 5). Slices indices have useful defaults. An omitted first index defaults to zero and an omitted second index defaults to the size of the array.

numbers = [1, 2, 3, 4, 5, 6, 7, 8, 9]start   = numbers[0..2]middle  = numbers[3...-2]end     = numbers[-2..]copy    = numbers[..]

var copy, end, middle, numbers, start;numbers = [1, 2, 3, 4, 5, 6, 7, 8, 9];start = numbers.slice(0, 3);middle = numbers.slice(3, -2);end = numbers.slice(-2);copy = numbers.slice(0);

The same syntax can be used with assignment to replace a segment of an array with new values, splicing it.

numbers = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]numbers[3..6] = [-3, -4, -5, -6] 

var numbers, _ref;numbers = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9];[].splice.apply(numbers, [3, 4].concat(_ref = [-3, -4, -5, -6])), _ref;

Note that JavaScript strings are immutable, and can‘t be spliced.

Everything is an Expression (at least, as much as possible) You might have noticed how even though we don‘t add return statements to CoffeeScript functions, they nonetheless return their final value. The CoffeeScript compiler tries to make sure that all statements in the language can be used as expressions. Watch how the return gets pushed down into each possible branch of execution in the function below.

grade = (student) ->  if student.excellentWork    "A+"  else if student.okayStuff    if student.triedHard then "B" else "B-"  else    "C"eldest = if 24 > 21 then "Liz" else "Ike"

var eldest, grade;grade = function(student) {  if (student.excellentWork) {    return "A+";  } else if (student.okayStuff) {    if (student.triedHard) {      return "B";    } else {      return "B-";    }  } else {    return "C";  }};eldest = 24 > 21 ? "Liz" : "Ike";

Even though functions will always return their final value, it‘s both possible and encouraged to return early from a function body writing out the explicit return (return value), when you know that you‘re done.

Because variable declarations occur at the top of scope, assignment can be used within expressions, even for variables that haven‘t been seen before:

six = (one = 1) + (two = 2) + (three = 3)

var one, six, three, two;six = (one = 1) + (two = 2) + (three = 3);

Things that would otherwise be statements in JavaScript, when used as part of an expression in CoffeeScript, are converted into expressions by wrapping them in a closure. This lets you do useful things, like assign the result of a comprehension to a variable:

# The first ten global properties.globals = (name for name of window)[0...10]

var globals, name;globals = ((function() {  var _results;  _results = [];  for (name in window) {    _results.push(name);  }  return _results;})()).slice(0, 10);

As well as silly things, like passing a try/catch statement directly into a function call:

alert(  try    nonexistent / undefined  catch error    "And the error is ... #{error}")

var error;alert((function() {  try {    return nonexistent / void 0;  } catch (_error) {    error = _error;    return "And the error is ... " + error;  }})());

There are a handful of statements in JavaScript that can‘t be meaningfully converted into expressions, namely break, continue, and return. If you make use of them within a block of code, CoffeeScript won‘t try to perform the conversion.

Operators and Aliases Because the == operator frequently causes undesirable coercion, is intransitive, and has a different meaning than in other languages, CoffeeScript compiles == into ===, and != into !==. In addition, is compiles into ===, and isnt into !==.

You can use not as an alias for !.

For logic, and compiles to &&, and or into ||.

Instead of a newline or semicolon, then can be used to separate conditions from expressions, in while, if/else, and switch/when statements.

As in YAML, on and yes are the same as boolean true, while off and no are boolean false.

unless can be used as the inverse of if.

As a shortcut for this.property, you can use @property.

You can use in to test for array presence, and of to test for JavaScript object-key presence.

To simplify math expressions, ** can be used for exponentiation, // performs integer division and %% provides true mathematical modulo.

All together now:

launch() if ignition is onvolume = 10 if band isnt SpinalTapletTheWildRumpusBegin() unless answer is noif car.speed < limit then accelerate()winner = yes if pick in [47, 92, 13]print inspect "My name is #{@name}"

var volume, winner;if (ignition === true) {  launch();}if (band !== SpinalTap) {  volume = 10;}if (answer !== false) {  letTheWildRumpusBegin();}if (car.speed < limit) {  accelerate();}if (pick === 47 || pick === 92 || pick === 13) {  winner = true;}print(inspect("My name is " + this.name));

The Existential Operator It‘s a little difficult to check for the existence of a variable in JavaScript. if (variable) ... comes close, but fails for zero, the empty string, and false. CoffeeScript‘s existential operator ? returns true unless a variable is null or undefined, which makes it analogous to Ruby‘s nil?

It can also be used for safer conditional assignment than ||= provides, for cases where you may be handling numbers or strings.

solipsism = true if mind? and not world?speed = 0speed ?= 15footprints = yeti ? "bear" 

var footprints, solipsism, speed;if ((typeof mind !== "undefined" && mind !== null) && (typeof world === "undefined" || world === null)) {  solipsism = true;}speed = 0;if (speed == null) {  speed = 15;}footprints = typeof yeti !== "undefined" && yeti !== null ? yeti : "bear";

The accessor variant of the existential operator ?. can be used to soak up null references in a chain of properties. Use it instead of the dot accessor . in cases where the base value may be null or undefined. If all of the properties exist then you‘ll get the expected result, if the chain is broken, undefined is returned instead of the TypeError that would be raised otherwise.

zip = lottery.drawWinner?().address?.zipcode

var zip, _ref;zip = typeof lottery.drawWinner === "function" ? (_ref = lottery.drawWinner().address) != null ? _ref.zipcode : void 0 : void 0;

Soaking up nulls is similar to Ruby‘s andand gem, and to the safe navigation operator in Groovy.

Classes, Inheritance, and Super JavaScript‘s prototypal inheritance has always been a bit of a brain-bender, with a whole family tree of libraries that provide a cleaner syntax for classical inheritance on top of JavaScript‘s prototypes: Base2, Prototype.js, JS.Class, etc. The libraries provide syntactic sugar, but the built-in inheritance would be completely usable if it weren‘t for a couple of small exceptions: it‘s awkward to call super (the prototype object‘s implementation of the current function), and it‘s awkward to correctly set the prototype chain.

Instead of repetitively attaching functions to a prototype, CoffeeScript provides a basic class structure that allows you to name your class, set the superclass, assign prototypal properties, and define the constructor, in a single assignable expression.

Constructor functions are named, to better support helpful stack traces. In the first class in the example below, this.constructor.name is "Animal".

class Animal  constructor: (@name) ->  move: (meters) ->    alert @name + " moved #{meters}m."class Snake extends Animal  move: ->    alert "Slithering..."    super 5class Horse extends Animal  move: ->    alert "Galloping..."    super 45sam = new Snake "Sammy the Python"tom = new Horse "Tommy the Palomino"sam.move()tom.move()

var Animal, Horse, Snake, sam, tom,  __hasProp = {}.hasOwnProperty,  __extends = function(child, parent) { for (var key in parent) { if (__hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; };Animal = (function() {  function Animal(name) {    this.name = name;  }  Animal.prototype.move = function(meters) {    return alert(this.name + (" moved " + meters + "m."));  };  return Animal;})();Snake = (function(_super) {  __extends(Snake, _super);  function Snake() {    return Snake.__super__.constructor.apply(this, arguments);  }  Snake.prototype.move = function() {    alert("Slithering...");    return Snake.__super__.move.call(this, 5);  };  return Snake;})(Animal);Horse = (function(_super) {  __extends(Horse, _super);  function Horse() {    return Horse.__super__.constructor.apply(this, arguments);  }  Horse.prototype.move = function() {    alert("Galloping...");    return Horse.__super__.move.call(this, 45);  };  return Horse;})(Animal);sam = new Snake("Sammy the Python");tom = new Horse("Tommy the Palomino");sam.move();tom.move();

If structuring your prototypes classically isn‘t your cup of tea, CoffeeScript provides a couple of lower-level conveniences. The extends operator helps with proper prototype setup, and can be used to create an inheritance chain between any pair of constructor functions; :: gives you quick access to an object‘s prototype; and super() is converted into a call against the immediate ancestor‘s method of the same name.

String::dasherize = ->  this.replace /_/g, "-"

String.prototype.dasherize = function() {  return this.replace(/_/g, "-");};

Finally, class definitions are blocks of executable code, which make for interesting metaprogramming possibilities. Because in the context of a class definition, this is the class object itself (the constructor function), you can assign static properties by using
@property: value, and call functions defined in parent classes: @attr ‘title‘, type: ‘text‘

Destructuring Assignment To make extracting values from complex arrays and objects more convenient, CoffeeScript implements ECMAScript Harmony‘s proposed destructuring assignment syntax. When you assign an array or object literal to a value, CoffeeScript breaks up and matches both sides against each other, assigning the values on the right to the variables on the left. In the simplest case, it can be used for parallel assignment:

theBait   = 1000theSwitch = 0[theBait, theSwitch] = [theSwitch, theBait] 

var theBait, theSwitch, _ref;theBait = 1000;theSwitch = 0;_ref = [theSwitch, theBait], theBait = _ref[0], theSwitch = _ref[1];

But it‘s also helpful for dealing with functions that return multiple values.

weatherReport = (location) ->  # Make an Ajax request to fetch the weather...  [location, 72, "Mostly Sunny"][city, temp, forecast] = weatherReport "Berkeley, CA"

var city, forecast, temp, weatherReport, _ref;weatherReport = function(location) {  return [location, 72, "Mostly Sunny"];};_ref = weatherReport("Berkeley, CA"), city = _ref[0], temp = _ref[1], forecast = _ref[2];

Destructuring assignment can be used with any depth of array and object nesting, to help pull out deeply nested properties.

futurists =  sculptor: "Umberto Boccioni"  painter:  "Vladimir Burliuk"  poet:    name:   "F.T. Marinetti"    address: [      "Via Roma 42R"      "Bellagio, Italy 22021"    ]{poet: {name, address: [street, city]}} = futurists

var city, futurists, name, street, _ref, _ref1;futurists = {  sculptor: "Umberto Boccioni",  painter: "Vladimir Burliuk",  poet: {    name: "F.T. Marinetti",    address: ["Via Roma 42R", "Bellagio, Italy 22021"]  }};_ref = futurists.poet, name = _ref.name, (_ref1 = _ref.address, street = _ref1[0], city = _ref1[1]);

Destructuring assignment can even be combined with splats.

tag = "<impossible>"[open, contents..., close] = tag.split("")

var close, contents, open, tag, _i, _ref,  __slice = [].slice;tag = "<impossible>";_ref = tag.split(""), open = _ref[0], contents = 3 <= _ref.length ? __slice.call(_ref, 1, _i = _ref.length - 1) : (_i = 1, []), close = _ref[_i++];

Expansion can be used to retrieve elements from the end of an array without having to assign the rest of its values. It works in function parameter lists as well.

text = "Every literary critic believes he will        outwit history and have the last word"[first, ..., last] = text.split " "

var first, last, text, _ref;text = "Every literary critic believes he will outwit history and have the last word";_ref = text.split(" "), first = _ref[0], last = _ref[_ref.length - 1];

Destructuring assignment is also useful when combined with class constructors to assign properties to your instance from an options object passed to the constructor.

class Person  constructor: (options) ->     {@name, @age, @height} = optionstim = new Person age: 4

var Person, tim;Person = (function() {  function Person(options) {    this.name = options.name, this.age = options.age, this.height = options.height;  }  return Person;})();tim = new Person({  age: 4});

Function binding In JavaScript, the this keyword is dynamically scoped to mean the object that the current function is attached to. If you pass a function as a callback or attach it to a different object, the original value of this will be lost. If you‘re not familiar with this behavior, this Digital Web article gives a good overview of the quirks.

The fat arrow => can be used to both define a function, and to bind it to the current value of this, right on the spot. This is helpful when using callback-based libraries like Prototype or jQuery, for creating iterator functions to pass to each, or event-handler functions to use with bind. Functions created with the fat arrow are able to access properties of the this where they‘re defined.

Account = (customer, cart) ->  @customer = customer  @cart = cart  $(‘.shopping_cart‘).bind ‘click‘, (event) =>    @customer.purchase @cart

var Account;Account = function(customer, cart) {  this.customer = customer;  this.cart = cart;  return $(‘.shopping_cart‘).bind(‘click‘, (function(_this) {    return function(event) {      return _this.customer.purchase(_this.cart);    };  })(this));};

If we had used -> in the callback above, @customer would have referred to the undefined "customer" property of the DOM element, and trying to call purchase() on it would have raised an exception.

When used in a class definition, methods declared with the fat arrow will be automatically bound to each instance of the class when the instance is constructed.

Embedded JavaScript Hopefully, you‘ll never need to use it, but if you ever need to intersperse snippets of JavaScript within your CoffeeScript, you can use backticks to pass it straight through.

hi = `function() {  return [document.title, "Hello JavaScript"].join(": ");}`

var hi;hi = function() {  return [document.title, "Hello JavaScript"].join(": ");};

Switch/When/Else Switch statements in JavaScript are a bit awkward. You need to remember to break at the end of every case statement to avoid accidentally falling through to the default case. CoffeeScript prevents accidental fall-through, and can convert the switch into a returnable, assignable expression. The format is: switch condition, when clauses, else the default case.

As in Ruby, switch statements in CoffeeScript can take multiple values for each when clause. If any of the values match, the clause runs.

switch day  when "Mon" then go work  when "Tue" then go relax  when "Thu" then go iceFishing  when "Fri", "Sat"    if day is bingoDay      go bingo      go dancing  when "Sun" then go church  else go work

switch (day) {  case "Mon":    go(work);    break;  case "Tue":    go(relax);    break;  case "Thu":    go(iceFishing);    break;  case "Fri":  case "Sat":    if (day === bingoDay) {      go(bingo);      go(dancing);    }    break;  case "Sun":    go(church);    break;  default:    go(work);}

Switch statements can also be used without a control expression, turning them in to a cleaner alternative to if/else chains.

score = 76grade = switch  when score < 60 then ‘F‘  when score < 70 then ‘D‘  when score < 80 then ‘C‘  when score < 90 then ‘B‘  else ‘A‘# grade == ‘C‘

var grade, score;score = 76;grade = (function() {  switch (false) {    case !(score < 60):      return ‘F‘;    case !(score < 70):      return ‘D‘;    case !(score < 80):      return ‘C‘;    case !(score < 90):      return ‘B‘;    default:      return ‘A‘;  }})();

Try/Catch/Finally Try/catch statements are just about the same as JavaScript (although they work as expressions).

try  allHellBreaksLoose()  catsAndDogsLivingTogether()catch error  print errorfinally  cleanUp()

var error;try {  allHellBreaksLoose();  catsAndDogsLivingTogether();} catch (_error) {  error = _error;  print(error);} finally {  cleanUp();}

Chained Comparisons CoffeeScript borrows chained comparisons from Python — making it easy to test if a value falls within a certain range.

cholesterol = 127healthy = 200 > cholesterol > 60

var cholesterol, healthy;cholesterol = 127;healthy = (200 > cholesterol && cholesterol > 60);

String Interpolation, Block Strings, and Block Comments Ruby-style string interpolation is included in CoffeeScript. Double-quoted strings allow for interpolated values, using #{ ... }, and single-quoted strings are literal.

author = "Wittgenstein"quote  = "A picture is a fact. -- #{ author }"sentence = "#{ 22 / 7 } is a decent approximation of π"

var author, quote, sentence;author = "Wittgenstein";quote = "A picture is a fact. -- " + author;sentence = "" + (22 / 7) + " is a decent approximation of π";

Multiline strings are allowed in CoffeeScript. Lines are joined by a single space unless they end with a backslash. Indentation is ignored.

mobyDick = "Call me Ishmael. Some years ago --  never mind how long precisely -- having little  or no money in my purse, and nothing particular  to interest me on shore, I thought I would sail  about a little and see the watery part of the  world..."

var mobyDick;mobyDick = "Call me Ishmael. Some years ago -- never mind how long precisely -- having little or no money in my purse, and nothing particular to interest me on shore, I thought I would sail about a little and see the watery part of the world...";

Block strings can be used to hold formatted or indentation-sensitive text (or, if you just don‘t feel like escaping quotes and apostrophes). The indentation level that begins the block is maintained throughout, so you can keep it all aligned with the body of your code.

html = """       <strong>         cup of coffeescript       </strong>       """       

var html;html = "<strong>\n  cup of coffeescript\n</strong>";

Double-quoted block strings, like other double-quoted strings, allow interpolation.

Sometimes you‘d like to pass a block comment through to the generated JavaScript. For example, when you need to embed a licensing header at the top of a file. Block comments, which mirror the syntax for block strings, are preserved in the generated code.

###SkinnyMochaHalfCaffScript Compiler v1.0Released under the MIT License###

/*SkinnyMochaHalfCaffScript Compiler v1.0Released under the MIT License */

Block Regular Expressions Similar to block strings and comments, CoffeeScript supports block regexes — extended regular expressions that ignore internal whitespace and can contain comments and interpolation. Modeled after Perl‘s /x modifier, CoffeeScript‘s block regexes are delimited by /// and go a long way towards making complex regular expressions readable. To quote from the CoffeeScript source:

OPERATOR = /// ^ (  ?: [-=]>             # function   | [-+*/%<>&|^!?=]=  # compound assign / compare   | >>>=?             # zero-fill right shift   | ([-+:])\1         # doubles   | ([&|<>])\2=?      # logic / shift   | \?\.              # soak access   | \.{2,3}           # range or splat) ///

var OPERATOR;OPERATOR = /^(?:[-=]>|[-+*\/%<>&|^!?=]=|>>>=?|([-+:])\1|([&|<>])\2=?|\?\.|\.{2,3})/;

Cake, and Cakefiles

CoffeeScript includes a (very) simple build system similar to Make and Rake. Naturally, it‘s called Cake, and is used for the tasks that build and test the CoffeeScript language itself. Tasks are defined in a file named Cakefile, and can be invoked by running cake [task] from within the directory. To print a list of all the tasks and options, just type cake.

Task definitions are written in CoffeeScript, so you can put arbitrary code in your Cakefile. Define a task with a name, a long description, and the function to invoke when the task is run. If your task takes a command-line option, you can define the option with short and long flags, and it will be made available in the options object. Here‘s a task that uses the Node.js API to rebuild CoffeeScript‘s parser:

fs = require ‘fs‘option ‘-o‘, ‘--output [DIR]‘, ‘directory for compiled code‘task ‘build:parser‘, ‘rebuild the Jison parser‘, (options) ->  require ‘jison‘  code = require(‘./lib/grammar‘).parser.generate()  dir  = options.output or ‘lib‘  fs.writeFile "#{dir}/parser.js", code

var fs;fs = require(‘fs‘);option(‘-o‘, ‘--output [DIR]‘, ‘directory for compiled code‘);task(‘build:parser‘, ‘rebuild the Jison parser‘, function(options) {  var code, dir;  require(‘jison‘);  code = require(‘./lib/grammar‘).parser.generate();  dir = options.output || ‘lib‘;  return fs.writeFile("" + dir + "/parser.js", code);});

If you need to invoke one task before another — for example, running build before test, you can use the invoke function: invoke ‘build‘. Cake tasks are a minimal way to expose your CoffeeScript functions to the command line, so don‘t expect any fanciness built-in. If you need dependencies, or async callbacks, it‘s best to put them in your code itself — not the cake task.

Source Maps

CoffeeScript 1.6.1 and above include support for generating source maps, a way to tell your JavaScript engine what part of your CoffeeScript program matches up with the code being evaluated. Browsers that support it can automatically use source maps to show your original source code in the debugger. To generate source maps alongside your JavaScript files, pass the --map or -m flag to the compiler.

For a full introduction to source maps, how they work, and how to hook them up in your browser, read the HTML5 Tutorial.

"text/coffeescript" Script Tags

While it‘s not recommended for serious use, CoffeeScripts may be included directly within the browser using <script type="text/coffeescript"> tags. The source includes a compressed and minified version of the compiler (Download current version here, 39k when gzipped) as extras/coffee-script.js. Include this file on a page with inline CoffeeScript tags, and it will compile and evaluate them in order.

In fact, the little bit of glue script that runs "Try CoffeeScript" above, as well as the jQuery for the menu, is implemented in just this way. View source and look at the bottom of the page to see the example. Including the script also gives you access to CoffeeScript.compile() so you can pop open Firebug and try compiling some strings.

The usual caveats about CoffeeScript apply — your inline scripts will run within a closure wrapper, so if you want to expose global variables or functions, attach them to the window object.

Books

There are a number of excellent resources to help you get started with CoffeeScript, some of which are freely available online.

• The Little Book on CoffeeScript is a brief 5-chapter introduction to CoffeeScript, written with great clarity and precision by Alex MacCaw.
• Smooth CoffeeScript is a reimagination of the excellent book Eloquent JavaScript, as if it had been written in CoffeeScript instead. Covers language features as well as the functional and object oriented programming styles. By E. Hoigaard.
• CoffeeScript: Accelerated JavaScript Development is Trevor Burnham‘s thorough introduction to the language. By the end of the book, you‘ll have built a fast-paced multiplayer word game, writing both the client-side and Node.js portions in CoffeeScript.
• CoffeeScript Programming with jQuery, Rails, and Node.js is a new book by Michael Erasmus that covers CoffeeScript with an eye towards real-world usage both in the browser (jQuery) and on the server size (Rails, Node).
• CoffeeScript Ristretto is a deep dive into CoffeeScript‘s semantics from simple functions up through closures, higher-order functions, objects, classes, combinators, and decorators. By Reg Braithwaite.
• Testing with CoffeeScript is a succinct and freely downloadable guide to building testable applications with CoffeeScript and Jasmine.
• CoffeeScript Application Development is a new book from Packt Publishing that introduces CoffeeScript while walking through the process of building a demonstration web application.
• CoffeeScript in Action is a new book from Manning Publications that covers CoffeeScript syntax, composition techniques and application development.

Screencasts

• A Sip of CoffeeScript is a Code School Course which combines 6 screencasts with in-browser coding to make learning fun. The first level is free to try out.
• Meet CoffeeScript is a 75-minute long screencast by PeepCode. Highly memorable for its animations which demonstrate transforming CoffeeScript into the equivalent JS.
• If you‘re looking for less of a time commitment, RailsCasts‘ CoffeeScript Basics should have you covered, hitting all of the important notes about CoffeeScript in 11 minutes.

Examples

The best list of open-source CoffeeScript examples can be found on GitHub. But just to throw out few more:

• github‘s Hubot, a friendly IRC robot that can perform any number of useful and useless tasks.
• sstephenson‘s Pow, a zero-configuration Rack server, with comprehensive annotated source.
• technoweenie‘s Coffee-Resque, a port of Resque for Node.js.
• assaf‘s Zombie.js, a headless, full-stack, faux-browser testing library for Node.js.
• jashkenas‘ Underscore.coffee, a port of the Underscore.js library of helper functions.
• stephank‘s Orona, a remake of the Bolo tank game for modern browsers.
• josh‘s nack, a Node.js-powered Rack server.

Resources

• Source Code
  Use bin/coffee to test your changes,
  bin/cake test to run the test suite,
  bin/cake build to rebuild the CoffeeScript compiler, and
  bin/cake build:parser to regenerate the Jison parser if you‘re working on the grammar.
  
  git checkout lib && bin/cake build:full is a good command to run when you‘re working on the core language. It‘ll refresh the lib directory (in case you broke something), build your altered compiler, use that to rebuild itself (a good sanity test) and then run all of the tests. If they pass, there‘s a good chance you‘ve made a successful change.
• CoffeeScript Issues
  Bug reports, feature proposals, and ideas for changes to the language belong here.
• CoffeeScript Google Group
  If you‘d like to ask a question, the mailing list is a good place to get help.
• The CoffeeScript Wiki
  If you‘ve ever learned a neat CoffeeScript tip or trick, or ran into a gotcha — share it on the wiki. The wiki also serves as a directory of handy text editor extensions, web framework plugins, and general CoffeeScript build tools.
• The FAQ
  Perhaps your CoffeeScript-related question has been asked before. Check the FAQ first.
• JS2Coffee
  Is a very well done reverse JavaScript-to-CoffeeScript compiler. It‘s not going to be perfect (infer what your JavaScript classes are, when you need bound functions, and so on...) — but it‘s a great starting point for converting simple scripts.
• High-Rez Logo
  The CoffeeScript logo is available in Illustrator, EPS and PSD formats, for use in presentations.

Web Chat (IRC)

Quick help and advice can usually be found in the CoffeeScript IRC room. Join #coffeescript on irc.freenode.net, or click the button below to open a webchat session on this page.

click to open #coffeescript

Change Log

• The --join option of the CLI is now deprecated.
• Source maps now use .js.map as file extension, instead of just .map.
• The CLI now exits with the exit code 1 when it fails to write a file to disk.
• The compiler no longer crashes on unterminated, single-quoted strings.
• Fixed location data for string interpolations, which made source maps out of sync.
• The error marker in error messages is now correctly positioned if the code is indented with tabs.
• Fixed a slight formatting error in CoffeeScript’s source map-patched stack traces.
• The %% operator now coerces its right operand only once.
• It is now possible to require CoffeeScript files from Cakefiles without having to register the compiler first.
• The CoffeeScript REPL is now exported and can be required using require ‘coffee-script/repl‘.
• Fixes for the REPL in Node 0.11.

• Fixed a typo that broke node module lookup when running a script directly with the coffee binary.

• When requiring CoffeeScript files in Node you must now explicitly register the compiler. This can be done with require ‘coffee-script/register‘ or CoffeeScript.register(). Also for configuration such as Mocha‘s, use coffee-script/register.
• Improved error messages, source maps and stack traces. Source maps now use the updated //# syntax.
• Leading . now closes all open calls, allowing for simpler chaining syntax.

$ ‘body‘.click (e) ->  $ ‘.box‘  .fadeIn ‘fast‘  .addClass ‘.active‘.css ‘background‘, ‘white‘

$(‘body‘).click(function(e) {  return $(‘.box‘).fadeIn(‘fast‘).addClass(‘.active‘);}).css(‘background‘, ‘white‘);

• Added **, // and %% operators and ... expansion in parameter lists and destructuring expressions.
• Multiline strings are now joined by a single space and ignore all indentation. A backslash at the end of a line can denote the amount of whitespace between lines, in both strings and heredocs. Backslashes correctly escape whitespace in block regexes.
• Closing brackets can now be indented and therefore no longer cause unexpected error.
• Several breaking compilation fixes. Non-callable literals (strings, numbers etc.) don‘t compile in a call now and multiple postfix conditionals compile properly. Postfix conditionals and loops always bind object literals. Conditional assignment compiles properly in subexpressions. super is disallowed outside of methods and works correctly inside for loops.
• Formatting of compiled block comments has been improved.
• No more -p folders on Windows.
• The options object passed to CoffeeScript is no longer mutated.

• The CoffeeScript REPL now remembers your history between sessions. Just like a proper REPL should.
• You can now use require in Node to load .coffee.md Literate CoffeeScript files. In the browser, text/literate-coffeescript script tags.
• The old coffee --lint command has been removed. It was useful while originally working on the compiler, but has been surpassed by JSHint. You may now use -l to pass literate files in over stdio.
• Bugfixes for Windows path separators, catch without naming the error, and executable-class-bodies-with- prototypal-property-attachment.

• Source maps have been used to provide automatic line-mapping when running CoffeeScript directly via the coffee command, and for automatic line-mapping when running CoffeeScript directly in the browser. Also, to provide better error messages for semantic errors thrown by the compiler — with colors, even.
• Improved support for mixed literate/vanilla-style CoffeeScript projects, and generating source maps for both at the same time.
• Fixes for 1.6.x regressions with overriding inherited bound functions, and for Windows file path management.
• The coffee command can now correctly fork() both .coffee and .js files. (Requires Node.js 0.9+)

• First release of source maps. Pass the --map flag to the compiler, and off you go. Direct all your thanks over to Jason Walton.
• Fixed a 1.5.0 regression with multiple implicit calls against an indented implicit object. Combinations of implicit function calls and implicit objects should generally be parsed better now — but it still isn‘t good style to nest them too heavily.
• .coffee.md is now also supported as a Literate CoffeeScript file extension, for existing tooling. .litcoffee remains the canonical one.
• Several minor fixes surrounding member properties, bound methods and super in class declarations.

• First release of Literate CoffeeScript.
• The CoffeeScript REPL is now based on the Node.js REPL, and should work better and more familiarly.
• Returning explicit values from constructors is now forbidden. If you want to return an arbitrary value, use a function, not a constructor.
• You can now loop over an array backwards, without having to manually deal with the indexes: for item in list by -1
• Source locations are now preserved in the CoffeeScript AST, although source maps are not yet being emitted.

• The CoffeeScript compiler now strips Microsoft‘s UTF-8 BOM if it exists, allowing you to compile BOM-borked source files.
• Fix Node/compiler deprecation warnings by removing registerExtension, and moving from path.exists to fs.exists.
• Small tweaks to splat compilation, backticks, slicing, and the error for duplicate keys in object literals.

• Due to the new semantics of JavaScript‘s strict mode, CoffeeScript no longer guarantees that constructor functions have names in all runtimes. See #2052 for discussion.
• Inside of a nested function inside of an instance method, it‘s now possible to call super more reliably (walks recursively up).
• Named loop variables no longer have different scoping heuristics than other local variables. (Reverts #643)
• Fix for splats nested within the LHS of destructuring assignment.
• Corrections to our compile time strict mode forbidding of octal literals.

• CoffeeScript now enforces all of JavaScript‘s Strict Mode early syntax errors at compile time. This includes old-style octal literals, duplicate property names in object literals, duplicate parameters in a function definition, deleting naked variables, setting the value of eval or arguments, and more. See a full discussion at #1547.
• The REPL now has a handy new multi-line mode for entering large blocks of code. It‘s useful when copy-and-pasting examples into the REPL. Enter multi-line mode with Ctrl-V. You may also now pipe input directly into the REPL.
• CoffeeScript now prints a Generated by CoffeeScript VERSION header at the top of each compiled file.
• Conditional assignment of previously undefined variables a or= b is now considered a syntax error.
• A tweak to the semantics of do, which can now be used to more easily simulate a namespace: do (x = 1, y = 2) -> ...
• Loop indices are now mutable within a loop iteration, and immutable between them.
• Both endpoints of a slice are now allowed to be omitted for consistency, effectively creating a shallow copy of the list.
• Additional tweaks and improvements to coffee --watch under Node‘s "new" file watching API. Watch will now beep by default if you introduce a syntax error into a watched script. We also now ignore hidden directories by default when watching recursively.

• Multiple improvements to coffee --watch and --join. You may now use both together, as well as add and remove files and directories within a --watch‘d folder.
• The throw statement can now be used as part of an expression.
• Block comments at the top of the file will now appear outside of the safety closure wrapper.
• Fixed a number of minor 1.1.3 regressions having to do with trailing operators and unfinished lines, and a more major 1.1.3 regression that caused bound functions within bound class functions to have the incorrect this.

• Ahh, whitespace. CoffeeScript‘s compiled JS now tries to space things out and keep it readable, as you can see in the examples on this page.
• You can now call super in class level methods in class bodies, and bound class methods now preserve their correct context.
• JavaScript has always supported octal numbers 010 is 8, and hexadecimal numbers 0xf is 15, but CoffeeScript now also supports binary numbers: 0b10 is 2.
• The CoffeeScript module has been nested under a subdirectory to make it easier to require individual components separately, without having to use npm. For example, after adding the CoffeeScript folder to your path: require(‘coffee-script/lexer‘)
• There‘s a new "link" feature in Try CoffeeScript on this webpage. Use it to get a shareable permalink for your example script.
• The coffee --watch feature now only works on Node.js 0.6.0 and higher, but now also works properly on Windows.
• Lots of small bug fixes from @michaelficarra, @geraldalewis, @satyr, and @trevorburnham.