From e620434a2e1f913153a93656aab869453a536cd4 Mon Sep 17 00:00:00 2001 From: Geoffrey Booth Date: Thu, 15 Dec 2016 21:05:44 -0800 Subject: [PATCH] Docs improvements: content in Markdown, organization into subtemplates, fixed tests (#4401) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Replace tiny bitmaps with base64-encoded URIs * Optimize SVGs; replace logo PNG with SVG * Modernize favicon * Embed CSS; a bit unorthodox, but we’re a single page so there’s no point in separate .css files and their separate HTTP requests * Documentation is now markdown, converted to HTML on compilation * Render the examples when we’re rendering index.html; they compile so quickly that there’s no need to pre-render them and save the intermediate .js files * Split apart index.html into components that Cakefile assembles, so that we can add in logic to include different files for v1 versus v2 * Split building index.html and building test.html into two tasks; collapse the parts of `releaseHeader` into one compact function * Move include logic into templates * Get error messages tests to work in the browser * Update output index.html * Split body into nav and body * Watch subtemplates * Revert "Split body into nav and body" This reverts commit ec9e559ec0c3f350bd009afd437652347789b180. * Add marked * Update gitignore * Use idiomatic markdown output for code blocks (
)

* Handle ids within the template, not in the Cakefile; remove marked’s auto-generated and conflicting ids

* Move the `codeFor` function into versioned folders, so that v1 and v2 docs can have different example code blocks/editors

* Update packages, including new highlight.js which supports our newer keywords and triple backticks (docs output is unchanged)
---
 .gitignore                                    |    4 +-
 Cakefile                                      |  169 +-
 docs/v1/.gitignore                            |    1 -
 docs/v1/index.html                            | 3792 +++++------------
 docs/v1/test.html                             | 1197 ++++++
 documentation/index.html                      | 2540 +----------
 documentation/sections/books.md               |   13 +
 documentation/sections/cake.md                |   11 +
 documentation/sections/changelog.md           |  508 +++
 documentation/sections/chat.md                |    5 +
 documentation/sections/classes.md             |   20 +
 documentation/sections/comparisons.md         |    7 +
 documentation/sections/conditionals.md        |    9 +
 documentation/sections/destructuring.md       |   39 +
 documentation/sections/embedded.md            |   21 +
 documentation/sections/examples.md            |   11 +
 .../sections/existential_operator.md          |   17 +
 documentation/sections/expressions.md         |   29 +
 documentation/sections/fat_arrow.md           |   27 +
 documentation/sections/functions.md           |   13 +
 documentation/sections/heregexes.md           |    7 +
 documentation/sections/installation.md        |   27 +
 documentation/sections/introduction.md        |   11 +
 documentation/sections/language.md            |   10 +
 documentation/sections/lexical_scope.md       |   15 +
 documentation/sections/literate.md            |    7 +
 documentation/sections/loops.md               |   47 +
 documentation/sections/modules.md             |   11 +
 documentation/sections/objects_and_arrays.md  |   19 +
 documentation/sections/operators.md           |  149 +
 documentation/sections/overview.md            |    7 +
 documentation/sections/resources.md           |   23 +
 documentation/sections/screencasts.md         |    5 +
 documentation/sections/scripts.md             |    7 +
 documentation/sections/slices.md              |   15 +
 documentation/sections/source_maps.md         |    5 +
 documentation/sections/splats.md              |    7 +
 documentation/sections/strings.md             |   27 +
 documentation/sections/switch.md              |   15 +
 .../sections/tagged_template_literals.md      |    9 +
 documentation/sections/try.md                 |    7 +
 documentation/sections/usage.md               |  179 +
 documentation/test.html                       |    2 +
 documentation/v1/body.html                    |  155 +
 documentation/v1/code.coffee                  |   25 +
 documentation/v1/docs.coffee                  |   92 +
 documentation/{css => v1}/docs.css            |   21 +-
 documentation/v1/scripts.html                 |    6 +
 documentation/v1/styles.html                  |    4 +
 documentation/{css => v1}/tomorrow.css        |   10 +-
 package.json                                  |    5 +-
 51 files changed, 4058 insertions(+), 5304 deletions(-)
 delete mode 100644 docs/v1/.gitignore
 create mode 100644 documentation/sections/books.md
 create mode 100644 documentation/sections/cake.md
 create mode 100644 documentation/sections/changelog.md
 create mode 100644 documentation/sections/chat.md
 create mode 100644 documentation/sections/classes.md
 create mode 100644 documentation/sections/comparisons.md
 create mode 100644 documentation/sections/conditionals.md
 create mode 100644 documentation/sections/destructuring.md
 create mode 100644 documentation/sections/embedded.md
 create mode 100644 documentation/sections/examples.md
 create mode 100644 documentation/sections/existential_operator.md
 create mode 100644 documentation/sections/expressions.md
 create mode 100644 documentation/sections/fat_arrow.md
 create mode 100644 documentation/sections/functions.md
 create mode 100644 documentation/sections/heregexes.md
 create mode 100644 documentation/sections/installation.md
 create mode 100644 documentation/sections/introduction.md
 create mode 100644 documentation/sections/language.md
 create mode 100644 documentation/sections/lexical_scope.md
 create mode 100644 documentation/sections/literate.md
 create mode 100644 documentation/sections/loops.md
 create mode 100644 documentation/sections/modules.md
 create mode 100644 documentation/sections/objects_and_arrays.md
 create mode 100644 documentation/sections/operators.md
 create mode 100644 documentation/sections/overview.md
 create mode 100644 documentation/sections/resources.md
 create mode 100644 documentation/sections/screencasts.md
 create mode 100644 documentation/sections/scripts.md
 create mode 100644 documentation/sections/slices.md
 create mode 100644 documentation/sections/source_maps.md
 create mode 100644 documentation/sections/splats.md
 create mode 100644 documentation/sections/strings.md
 create mode 100644 documentation/sections/switch.md
 create mode 100644 documentation/sections/tagged_template_literals.md
 create mode 100644 documentation/sections/try.md
 create mode 100644 documentation/sections/usage.md
 create mode 100644 documentation/v1/body.html
 create mode 100644 documentation/v1/code.coffee
 create mode 100644 documentation/v1/docs.coffee
 rename documentation/{css => v1}/docs.css (99%)
 create mode 100644 documentation/v1/scripts.html
 create mode 100644 documentation/v1/styles.html
 rename documentation/{css => v1}/tomorrow.css (87%)

diff --git a/.gitignore b/.gitignore
index 4ed75b7f..3749e736 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,8 +3,6 @@ presentation
 test.coffee
 test.litcoffee
 parser.output
-test/fixtures/underscore
 test/*.js
-examples/beautiful_code/parse.coffee
-*.gem
 /node_modules
+npm-debug.log
diff --git a/Cakefile b/Cakefile
index add7c9a7..be3f9cd3 100644
--- a/Cakefile
+++ b/Cakefile
@@ -25,7 +25,7 @@ header = """
 """
 
 # Used in folder names like docs/v1
-majorVersion = CoffeeScript.VERSION.split('.')[0]
+majorVersion = parseInt CoffeeScript.VERSION.split('.')[0], 10
 
 # Build the CoffeeScript language from source.
 build = (cb) ->
@@ -132,74 +132,96 @@ task 'build:browser', 'rebuild the merged script for inclusion in the browser',
 
 
 task 'doc:site', 'watch and continually rebuild the documentation for the website', ->
+  # Constants
+  indexFile = 'documentation/index.html'
+  versionedSourceFolder = "documentation/v#{majorVersion}"
+  sectionsSourceFolder = 'documentation/sections'
+  examplesSourceFolder = 'documentation/examples'
+  outputFolder = "docs/v#{majorVersion}"
+
   # Helpers
-  css = fs.readFileSync('./documentation/css/docs.css', 'utf-8') + '\n' +
-        fs.readFileSync('./documentation/css/tomorrow.css', 'utf-8')
+  releaseHeader = (date, version, prevVersion) ->
+    monthNames = ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December']
 
-  logo = fs.readFileSync './documentation/images/logo.svg', 'utf-8'
+    formatDate = (date) ->
+      date.replace /^(\d\d\d\d)-(\d\d)-(\d\d)$/, (match, $1, $2, $3) ->
+        "#{monthNames[$2 - 1]} #{+$3}, #{$1}"
 
-  codeFor = ->
-    counter = 0
-    hljs = require 'highlight.js'
-    hljs.configure classPrefix: ''
-    (file, executable = false, showLoad = true) ->
-      counter++
-      return unless fs.existsSync "docs/v#{majorVersion}/examples/#{file}.js"
-      cs = fs.readFileSync "documentation/examples/#{file}.coffee", 'utf-8'
-      js = fs.readFileSync "docs/v#{majorVersion}/examples/#{file}.js", 'utf-8'
-      js = js.replace /^\/\/ generated.*?\n/i, ''
+    """
+      

+      

+        #{prevVersion and "#{version}" or version}
+         — 
+      

+    """
 
-      cshtml = "
#{hljs.highlight('coffeescript', cs).value}
"
-      # Temporary fix until highlight.js adds support for newer CoffeeScript keywords
-      # Added in https://github.com/isagalaev/highlight.js/pull/1357, awaiting release
-      if file in ['generator_iteration', 'generators', 'modules']
-        cshtml = cshtml.replace /(yield|import|export|from|as|default) /g, '$1 '
-      jshtml = "
#{hljs.highlight('javascript', js).value}
"
-      append = if executable is yes then '' else "alert(#{executable});".replace /"/g, '"'
-      if executable and executable isnt yes
-        cs.replace /(\S)\s*\Z/m, "$1\n\nalert #{executable}"
-      run    = if executable is true then 'run' else "run: #{executable}"
-      name   = "example#{counter}"
-      script = ""
-      load   = if showLoad then "
load
" else ''
-      button = if executable then """
#{run}
""" else ''
-      "
#{cshtml}#{jshtml}#{script}#{load}#{button}
"
+  codeFor = require "./documentation/v#{majorVersion}/code.coffee"
 
-  monthNames = [
-    'January'
-    'February'
-    'March'
-    'April'
-    'May'
-    'June'
-    'July'
-    'August'
-    'September'
-    'October'
-    'November'
-    'December'
-  ]
+  htmlFor = ->
+    marked = require 'marked'
+    markdownRenderer = new marked.Renderer()
+    markdownRenderer.heading = (text, level) ->
+      "#{text}" # Don’t let marked add an id
+    markdownRenderer.code = (code) ->
+      if code.indexOf('codeFor(') is 0 or code.indexOf('releaseHeader(') is 0
+        "<%= #{code} %>"
+      else
+        "
#{code}
" # Default
 
-  formatDate = (date) ->
-    date.replace /^(\d\d\d\d)-(\d\d)-(\d\d)$/, (match, $1, $2, $3) ->
-      "#{monthNames[$2 - 1]} #{+$3}, #{$1}"
+    (file, bookmark) ->
+      md = fs.readFileSync "#{sectionsSourceFolder}/#{file}.md", 'utf-8'
+      md = md.replace /<%= releaseHeader %>/g, releaseHeader
+      md = md.replace /<%= majorVersion %>/g, majorVersion
+      md = md.replace /<%= fullVersion %>/g, CoffeeScript.VERSION
+      html = marked md, renderer: markdownRenderer
+      html = _.template(html)
+        codeFor: codeFor()
+        releaseHeader: releaseHeader
 
-  releaseHeader = (date, version, prevVersion) -> """
-    

-    
-      #{prevVersion and "#{version}" or version}
-       — 
-    
-  """
+  include = ->
+    (file) ->
+      file = "#{versionedSourceFolder}/#{file}" if file.indexOf('/') is -1
+      output = fs.readFileSync file, 'utf-8'
+      if /\.html$/.test(file)
+        render = _.template output
+        output = render
+          releaseHeader: releaseHeader
+          majorVersion: majorVersion
+          fullVersion: CoffeeScript.VERSION
+          htmlFor: htmlFor()
+          codeFor: codeFor()
+          include: include()
+      output
 
+  # Task
+  do renderIndex = ->
+    render = _.template fs.readFileSync(indexFile, 'utf-8')
+    output = render
+      include: include()
+    fs.writeFileSync "#{outputFolder}/index.html", output
+    log 'compiled', green, "#{indexFile} → #{outputFolder}/index.html"
+  try
+    fs.symlinkSync "v#{majorVersion}/index.html", 'docs/index.html'
+  catch exception
+
+  for target in [indexFile, versionedSourceFolder, examplesSourceFolder, sectionsSourceFolder]
+    fs.watch target, interval: 200, renderIndex
+  log 'watching...' , green
+
+
+task 'doc:test', 'watch and continually rebuild the browser-based tests', ->
+  # Constants
+  testFile = 'documentation/test.html'
+  testsSourceFolder = 'test'
+  outputFolder = "docs/v#{majorVersion}"
+
+  # Included in test.html
   testHelpers = fs.readFileSync('test/support/helpers.coffee', 'utf-8').replace /exports\./g, '@'
 
+  # Helpers
   testsInScriptBlocks = ->
     output = ''
-    excludedTestFiles = ['error_messages.coffee']
-    for filename in fs.readdirSync 'test'
-      continue if filename in excludedTestFiles
-
+    for filename in fs.readdirSync testsSourceFolder
       if filename.indexOf('.coffee') isnt -1
         type = 'coffeescript'
       else if filename.indexOf('.litcoffee') isnt -1
@@ -217,41 +239,16 @@ task 'doc:site', 'watch and continually rebuild the documentation for the websit
     output
 
   # Task
-  examplesSourceFolder = 'documentation/examples'
-  examplesOutputFolder = "docs/v#{majorVersion}/examples"
-  fs.mkdirSync examplesOutputFolder unless fs.existsSync examplesOutputFolder
-  do renderExamples = ->
-    execSync "bin/coffee -bc -o #{examplesOutputFolder} #{examplesSourceFolder}/*.coffee"
-
-  indexFile = 'documentation/index.html'
-  do renderIndex = ->
-    render = _.template fs.readFileSync(indexFile, 'utf-8')
-    output = render
-      css: css
-      logo: logo
-      codeFor: codeFor()
-      releaseHeader: releaseHeader
-      majorVersion: majorVersion
-      fullVersion: CoffeeScript.VERSION
-    fs.writeFileSync "docs/v#{majorVersion}/index.html", output
-    log 'compiled', green, "#{indexFile} → docs/v#{majorVersion}/index.html"
-
-  testFile = 'documentation/test.html'
   do renderTest = ->
     render = _.template fs.readFileSync(testFile, 'utf-8')
     output = render
       testHelpers: testHelpers
       tests: testsInScriptBlocks()
-      majorVersion: majorVersion
-    fs.writeFileSync "docs/v#{majorVersion}/test.html", output
-    log 'compiled', green, "#{testFile} → docs/v#{majorVersion}/test.html"
+    fs.writeFileSync "#{outputFolder}/test.html", output
+    log 'compiled', green, "#{testFile} → #{outputFolder}/test.html"
 
-  fs.watch examplesSourceFolder, interval: 200, ->
-    renderExamples()
-    renderIndex()
-  fs.watch indexFile, interval: 200, renderIndex
-  fs.watch testFile, interval: 200, renderTest
-  fs.watch 'test', interval: 200, renderTest
+  for target in [testFile, testsSourceFolder]
+    fs.watch target, interval: 200, renderTest
   log 'watching...' , green
 
 
diff --git a/docs/v1/.gitignore b/docs/v1/.gitignore
deleted file mode 100644
index d838da98..00000000
--- a/docs/v1/.gitignore
+++ /dev/null
@@ -1 +0,0 @@
-examples/
diff --git a/docs/v1/index.html b/docs/v1/index.html
index 644fe035..61c5e485 100644
--- a/docs/v1/index.html
+++ b/docs/v1/index.html
@@ -1,20 +1,20 @@
 
 
 
-  
-  CoffeeScript
-  
-  
+
+CoffeeScript
+
+
 
-  
-  
-  
-  
-  
-  
+
+
+
+
+
+
 
-  
+
+
 
 
 
-  

+

 
-  

-    

-    

-      

-        Table of Contents
-      

-      

-        Overview
-        Installation
-        Usage
-        Literate CoffeeScript
-        Language Reference
-        Literals: Functions, Objects and Arrays
-        Lexical Scoping and Variable Safety
-        If, Else, Unless, and Conditional Assignment
-        Splats…
-        Loops and Comprehensions
-        Array Slicing and Splicing
-        Everything is an Expression
-        Operators and Aliases
-        Existential Operator
-        Classes, Inheritance, and Super
-        Destructuring Assignment
-        Bound and Generator Functions
-        Embedded JavaScript
-        Switch and Try/Catch
-        Chained Comparisons
-        String Interpolation, Block Strings, and Block Comments
-        Tagged Template Literals
-        Block Regular Expressions
-        Modules
-        Cake, and Cakefiles
-        Source Maps
-        "text/coffeescript" Script Tags
-        Books, Screencasts, Examples and Resources
-        Change Log
-      

+  

+    

+      Table of Contents
     

-    

-      

-        Try CoffeeScript
-        

-      

-      

-        

-          

-          

-          

-          

-          

-            
-          

-          

-          
Run

-          
-          

+    

+      Overview
+      Installation
+      Usage
+      Literate CoffeeScript
+      Language Reference
+      Literals: Functions, Objects and Arrays
+      Lexical Scoping and Variable Safety
+      If, Else, Unless, and Conditional Assignment
+      Splats…
+      Loops and Comprehensions
+      Array Slicing and Splicing
+      Everything is an Expression
+      Operators and Aliases
+      Existential Operator
+      Classes, Inheritance, and Super
+      Destructuring Assignment
+      Bound and Generator Functions
+      Embedded JavaScript
+      Switch and Try/Catch
+      Chained Comparisons
+      String Interpolation, Block Strings, and Block Comments
+      Tagged Template Literals
+      Block Regular Expressions
+      Modules
+      Cake, and Cakefiles
+      Source Maps
+      "text/coffeescript" Script Tags
+      Books, Screencasts, Examples and Resources
+      Change Log
+    

+  

+  

+    

+      Try CoffeeScript
+      

+    

+    

+      

+        

+        

+        

+        

+        

+          
         

-      

-    

-    

-      

-        Annotated Source
-      

-      

-        Grammar Rules — src/grammar
-        Lexing Tokens — src/lexer
-        The Rewriter — src/rewriter
-        The Syntax Tree — src/nodes
-        Lexical Scope — src/scope
-        Helpers & Utility Functions — src/helpers
-        The CoffeeScript Module — src/coffee-script
-        Cake & Cakefiles — src/cake
-        “coffee” Command-Line Utility — src/command
-        Option Parsing — src/optparse
-        Interactive REPL — src/repl
-        Source Maps — src/sourcemap
+        

+        
Run

+        
+        

       

     

   

+  

+    

+      Annotated Source
+    

+    

+      Grammar Rules — src/grammar
+      Lexing Tokens — src/lexer
+      The Rewriter — src/rewriter
+      The Syntax Tree — src/nodes
+      Lexical Scope — src/scope
+      Helpers & Utility Functions — src/helpers
+      The CoffeeScript Module — src/coffee-script
+      Cake & Cakefiles — src/cake
+      “coffee” Command-Line Utility — src/command
+      Option Parsing — src/optparse
+      Interactive REPL — src/repl
+      Source Maps — src/sourcemap
+    

+  

+

 
-  

-    
+

+  
+    
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, pretty-printed, and tends to run as fast or faster than the equivalent handwritten JavaScript.

+
The CoffeeScript compiler goes to great lengths to generate output JavaScript that runs in every JavaScript runtime, but there are exceptions. Use generator functions, for…from, or tagged template literals only if you know that your target runtimes can support them. If you use modules, you will need to use an additional tool to resolve them.

+
Latest Version: 1.12.1

+

+
npm install -g coffee-script

 
-    

-      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, pretty-printed, and tends to run as fast or faster than the
-      equivalent handwritten JavaScript.
-    

-
-    

-      The CoffeeScript compiler goes to great lengths to generate output JavaScript
-      that runs in every JavaScript runtime, but there are exceptions. Use
-      generator functions,
-      for…from, or
-      tagged template literals only if you
-      know that your target
-      runtimes can support them. If you use modules,
-      you will need to use an additional tool to resolve
-      them.
-    

-
-    

-      Latest Version:
-      1.12.1
-    

-
-    
npm install -g coffee-script

-
-    

-      
-      Overview
-    

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

-
-    
# Assignment:
+    
Overview
CoffeeScript on the left, compiled JavaScript output on the right.

+
# Assignment:
 number   = 42
 opposite = true
 
@@ -761,179 +726,149 @@ cubes = (function() {
   return results;
 })();
 ;alert(cubes);">run: cubes


+  
+    
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. 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

 
-    

-      
-      Installation
-    

+  
+    
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:

+
 
-    

-      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. 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:
-    

+
 
-    
-c, --compileCompile a .coffee script into a .js JavaScript file of the same name.
-m, --mapGenerate source maps alongside the compiled JavaScript files. Adds sourceMappingURL directives to the JavaScript as well.
-M, --inline-map

-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-        
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-      
-      
-        
-        
-      
-      
-        
-        
-      
-    
-c, --compile
-          Compile a .coffee script into a .js JavaScript file
-          of the same name.
-        
-m, --map
-          Generate source maps alongside the compiled JavaScript files. Adds
-          sourceMappingURL directives to the JavaScript as well.
-        
-M, --inline-map
-          Just like --map, but include the source map directly in
-          the compiled JavaScript files, rather than in a separate file.
-        
-i, --interactive
-          Launch an interactive CoffeeScript session to try short snippets.
-          Identical to calling coffee with no arguments.
-        
-o, --output [DIR]
-          Write out all compiled JavaScript files into the specified directory.
-          Use in conjunction with --compile or --watch.
-        
-j, --join [FILE]
-          Before compiling, concatenate all scripts together in the order they
-          were passed, and write them into the specified file. (Deprecated.)
-        
-w, --watch
-          Watch files for changes, rerunning the specified command when any
-          file is updated.
-        
-p, --print
-          Instead of writing out the JavaScript as a file, print it
-          directly to stdout.
-        
-s, --stdio
-          Pipe in CoffeeScript to STDIN and get back JavaScript over STDOUT.
-          Good for use with processes written in other languages. An example:

-          cat src/cake.coffee | coffee -sc
-        
-l, --literate
-          Parses the code as Literate CoffeeScript. You only need to specify
-          this when passing in code directly over stdio, or using some sort
-          of extension-less file name.
-        
-e, --eval
-          Compile and print a little snippet of CoffeeScript directly from the
-          command line. For example:
coffee -e "console.log num for num in [10..1]"
-        
-r, --require [MODULE]
-          require() the given module before starting the REPL or
-          evaluating the code given with the --eval flag.
-        
-b, --bare
-          Compile the JavaScript without the
-          top-level function safety wrapper.
-        
-t, --tokens
-          Instead of parsing the CoffeeScript, just lex it, and print out the
-          token stream: [IDENTIFIER square] [= =] [PARAM_START (] ...
-        
-n, --nodes
-          Instead of compiling the CoffeeScript, just lex and parse it, and print
-          out the parse tree:
-
-Block
+
Just like --map, but include the source map directly in the compiled JavaScript files, rather than in a separate file.
-i, --interactiveLaunch an interactive CoffeeScript session to try short snippets. Identical to calling coffee with no arguments.
-o, --output [DIR]Write out all compiled JavaScript files into the specified directory. Use in conjunction with --compile or --watch.
-j, --join [FILE]Before compiling, concatenate all scripts together in the order they were passed, and write them into the specified file. (Deprecated.)
-w, --watchWatch files for changes, rerunning the specified command when any file is updated.
-p, --printInstead of writing out the JavaScript as a file, print it directly to stdout.
-s, --stdioPipe in CoffeeScript to STDIN and get back JavaScript over STDOUT. Good for use with processes written in other languages. An example:

+cat src/cake.coffee | coffee -sc
-l, --literateParses the code as Literate CoffeeScript. You only need to specify this when passing in code directly over stdio, or using some sort of extension-less file name.
-e, --evalCompile and print a little snippet of CoffeeScript directly from the command line. For example:

+coffee -e "console.log num for num in [10..1]"
-r, --require [MODULE]require() the given module before starting the REPL or evaluating the code given with the --eval flag.
-b, --bareCompile the JavaScript without the top-level function safety wrapper.
-t, --tokensInstead of parsing the CoffeeScript, just lex it, and print out the token stream:

+[IDENTIFIER square] [= =] [PARAM_START (] ...
-n, --nodesInstead of compiling the CoffeeScript, just lex and parse it, and print out the parse tree:

+
+Block
   Assign
     Value IdentifierLiteral: square
     Code
@@ -941,135 +876,62 @@ Block
       Block
         Op *
           Value IdentifierLiteral: x
-          Value IdentifierLiteral: x
-        
--nodejs
-          The node executable has some useful options you can set,
-          such as
 --debug, --debug-brk, --max-stack-size,
-          and --expose-gc. Use this flag to forward options directly to Node.js.
-          To pass multiple flags, use --nodejs multiple times.
-        
--no-header
-          Suppress the “Generated by CoffeeScript” header.
-        

+          Value IdentifierLiteral: 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
-    

+--nodejs
 
-    

-      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.
-    

+The node executable has some useful options you can set, such as

+--debug, --debug-brk, --max-stack-size, and --expose-gc. Use this flag to forward options directly to Node.js. To pass multiple flags, use --nodejs multiple times.
 
-    

-      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
-    

+--no-header
 
-    

-      
-        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.
-      
-    

+Suppress the “Generated by CoffeeScript” header.
 
-    

-      
-        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 * 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 * x
 cube   = (x) -> square(x) * x
 
var cube, square;
 
@@ -1080,7 +942,7 @@ square = function(function(x) {
   return square(x) * x;
 };
-
load
 x * x\ncube   = (x) -> square(x) * x\n"
load
run: cube(5)


-    

-      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") ->
+;alert(cube(5));">run: cube(5)

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;
 
@@ -1104,7 +962,7 @@ fill = function(return "Filling the " + container + " with " + liquid + "...";
 };
-
load
\n  \"Filling the #{container} with #{liquid}...\"\n"
load
run: fill("cup")


-
-    

-      
-      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"]
+    
+      
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"}
 
@@ -1160,7 +1011,7 @@ kids = {
     age: 9
   }
 };
-
load
load
run: song.join(" … ")


-    

-      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'
+;alert(song.join(" … "));">run: song.join(" … ")

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({
@@ -1196,12 +1041,8 @@ log object.class
 });
 
 log(object["class"]);
-
load


-    

-      CoffeeScript has a shortcut for creating objects when you want the key
-      to be set with a variable of the same name.
-    

-    
name = "Michelangelo"
+
load

CoffeeScript has a shortcut for creating objects when you want the key to be set with a variable of the same name.

+
name = "Michelangelo"
 mask = "orange"
 weapon = "nunchuks"
 turtle = {name, mask, weapon}
@@ -1221,16 +1062,10 @@ turtle = {
 };
 
 output = turtle.name + " wears an " + turtle.mask + " mask. Watch out for his " + turtle.weapon + "!";
-
load


-
-    

-      
-      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 = 1
+
load


+    
+      
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 = 1
 changeNumbers = ->
   inner = -1
   outer = 10
@@ -1246,7 +1081,7 @@ changeNumbers = function(
load
\n  inner = -1\n  outer = 10\ninner = changeNumbers()\n"
load
run: inner


-    

-      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; attach them as properties on the
-      exports object in CommonJS; or use an export
-      statement. If you’re targeting both CommonJS and the browser, the
-      existential operator (covered below), gives you a
-      reliable way to figure out where to add them: exports ? this
-    

+;alert(inner);">run: inner

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; attach them as properties on the exports object in CommonJS; or use an export statement. If you’re targeting both CommonJS and the browser, the existential operator (covered below), gives you a reliable way to figure out where to add them: 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 singing
+    
+      
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 singing
 
 if happy and knowsIt
   clapsHands()
@@ -1326,17 +1123,10 @@ date = if friday then
 }
 
 date = friday ? sue : jill;
-
load


-
-    

-      
-      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"
+
load


+    
+      
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
@@ -1383,7 +1173,7 @@ alert("Gold: " + gold);
 alert("Silver: " + silver);
 
 alert("The Field: " + rest);
-
load
\n  gold   = first\n  silver = second\n  rest   = others\n\ncontenders = [\n  \"Michael Phelps\"\n  \"Liu Xiang\"\n  \"Yao Ming\"\n  \"Allyson Felix\"\n  \"Shawn Johnson\"\n  \"Roman Sebrle\"\n  \"Guo Jingjing\"\n  \"Tyson Gay\"\n  \"Asafa Powell\"\n  \"Usain Bolt\"\n]\n\nawardMedals contenders...\n\nalert \"Gold: \" + gold\nalert \"Silver: \" + silver\nalert \"The Field: \" + rest\n"
load
run


-
-    

-      
-      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.
+    
+      
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.
@@ -1449,16 +1231,10 @@ foods = ['broccoli', 'spinach'<
     eat(food);
   }
 }
-
load


-    

-      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])
+
load

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() {
@@ -1469,7 +1245,7 @@ countdown = (function(return results;
 })();
-
load
load
run: countdown


-    

-      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)
-    

-    

-      If you don’t need the current iteration value you may omit it:

-      browser.closeCurrentTab() for [0...count]
-    

-    

-      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: 11
+;alert(countdown);">run: countdown

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)

+
If you don’t need the current iteration value you may omit it:
+browser.closeCurrentTab() for [0...count]

+
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: 11
 
 ages = for child, age of yearsOld
   "#{child} is #{age}"
@@ -1524,7 +1282,7 @@ ages = (function(return results;
 })();
-
load
load
run: ages.join(", ")


-    

-      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
-    

-    

-      To iterate a generator function, use from.
-      See Generator Functions.
-    

-      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 101
+;alert(ages.join(", "));">run: ages.join(", ")

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.

+
To iterate a generator function, use from. See Generator Functions.

+
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 101
 if this.studyingEconomics
   buy()  while supply > demand
   sell() until supply > demand
@@ -1588,7 +1333,7 @@ lyrics = (function(return results;
 })();
-
load
 demand\n  sell() until supply > demand\n\n# Nursery Rhyme\nnum = 6\nlyrics = while num -= 1\n  \"#{num} little monkeys, jumping on the bed.\n    One fell out and bumped his head.\"\n"
load
run: lyrics.join("\n")


-    

-      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
+;alert(lyrics.join("\n"));">run: lyrics.join("\n")

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()
@@ -1636,18 +1371,10 @@ fn = function(\n    fs.readFile filename, (err, contents) ->\n      compile filename, contents.toString()\n"
load


-
-    

-      
-      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]
+
load


+    
+      
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]
 
@@ -1667,7 +1394,7 @@ middle = numbers.slice(3, -2-2);
 
 copy = numbers.slice(0);
-
load
load
run: middle


-    

-      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]
+;alert(middle);">run: middle

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;
@@ -1691,26 +1414,16 @@ numbers[3..6] = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9];
 
 [].splice.apply(numbers, [3, 4].concat(ref = [-3, -4, -5, -6])), ref;
-
load
load
run: numbers


-    

-      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) ->
+;alert(numbers);">run: numbers

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
@@ -1736,7 +1449,7 @@ grade = function(24 > 21 ? "Liz" : "Ike";
-
load
\n  if student.excellentWork\n    \"A+\"\n  else if student.okayStuff\n    if student.triedHard then \"B\" else \"B-\"\n  else\n    \"C\"\n\neldest = if 24 > 21 then \"Liz\" else \"Ike\"\n"
load
run: eldest


-    

-      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)
+;alert(eldest);">run: eldest

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);
-
load
load
run: six


-    

-      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.
+;alert(six);">run: six

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;
@@ -1790,7 +1489,7 @@ globals = ((function(return results;
 })()).slice(0, 10);
-
load
load
run: globals


-    

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

-    
alert(
+;alert(globals);">run: globals

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

+
alert(
   try
     nonexistent / undefined
   catch error
@@ -1821,7 +1516,7 @@ alert((function(return "And the error is ... " + error;
   }
 })());
-
load
load
run


-    

-      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.
-    

+;">run

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
-      and // performs integer division. % works just like in
-      JavaScript, while %% provides
-      “dividend dependent modulo”:
-    

-    
-7 % 5 == -2 # The remainder of 7 / 5
+    
+      
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 and // performs integer division. % works just like in JavaScript, while %% provides “dividend dependent modulo”:

+
-7 % 5 == -2 # The remainder of 7 / 5
 -7 %% 5 == 3 # n %% 5 is always between 0 and 4
 
 tabs.selectTabAtIndex((tabs.currentIndex - count) %% tabs.length)
@@ -1892,29 +1549,128 @@ tabs.selectTabAtIndex((tabs.currentIndex - count) %% tabs.length)
 modulo(-7, 5) === 3;
 
 tabs.selectTabAtIndex(modulo(tabs.currentIndex - count, tabs.length));
-
load


-    

-      All together now:
-    

+
load

All together now:

+
 
-    

-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-      
-    
CoffeeScriptJavaScript
is===
isnt!==
not!
and&&
or||
true, yes, ontrue
false, no, offfalse
@, thisthis
ofin
inno JS equivalent
a ** bMath.pow(a, b)
a // bMath.floor(a / b)
a %% b(a % b + b) % b

+
 
-    
launch() if ignition is on
+
+
+CoffeeScript
+
+JavaScript
+
+
+
+
+
+is
+
+===
+
+
+
+
+
+isnt
+
+!==
+
+
+
+
+
+not
+
+!
+
+
+
+
+
+and
+
+&&
+
+
+
+
+
+or
+
+||
+
+
+
+
+
+true, yes, on
+
+true
+
+
+
+
+
+false, no, off
+
+false
+
+
+
+
+
+@, this
+
+this
+
+
+
+
+
+of
+
+in
+
+
+
+
+
+in
+
+no JS equivalent
+
+
+
+
+
+a ** b
+
+Math.pow(a, b)
+
+
+
+
+
+a // b
+
+Math.floor(a / b)
+
+
+
+
+
+a %% b
+
+(a % b + b) % b
+
+
+
+
+
+
+
+
launch() if ignition is on
 
 volume = 10 if band isnt SpinalTap
 
@@ -1948,22 +1704,11 @@ winner = yes if pick <
 }
 
 print(inspect("My name is " + this.name));
-
load


-
-    

-      
-      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?
+
load


+    
+      
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 = 0
 speed ?= 15
@@ -1982,7 +1727,7 @@ speed = 0;
 }
 
 footprints = typeof yeti !== "undefined" && yeti !== null ? yeti : "bear";
-
load
load
run: footprints


-    

-      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
+;alert(footprints);">run: footprints

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 ref, zip;
 
 zip = typeof lottery.drawWinner === "function" ? (ref = lottery.drawWinner().address) != null ? ref.zipcode : void 0 : void 0;
-
load


-    

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

+
load

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
+    
+      
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) ->
@@ -2118,7 +1828,7 @@ tom = new Horse("Tommy the Pal
 sam.move();
 
 tom.move();
-
load
\n\n  move: (meters) ->\n    alert @name + \" moved #{meters}m.\"\n\nclass Snake extends Animal\n  move: ->\n    alert \"Slithering...\"\n    super 5\n\nclass Horse extends Animal\n  move: ->\n    alert \"Galloping...\"\n    super 45\n\nsam = new Snake \"Sammy the Python\"\ntom = new Horse \"Tommy the Palomino\"\n\nsam.move()\ntom.move()\n"
load
run


-    

-      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 = ->
+;">run

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, "-");
 };
-
load
\n  this.replace /_/g, \"-\"\n"
load
run: "one_two".dasherize()


-    

-      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'
-    

+;alert("one_two".dasherize());">run: "one_two".dasherize()

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
-      Just like JavaScript (since ES2015), CoffeeScript has 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   = 1000
+    
+      
Destructuring Assignment
Just like JavaScript (since ES2015), CoffeeScript has 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   = 1000
 theSwitch = 0
 
 [theBait, theSwitch] = [theSwitch, theBait]
@@ -2220,19 +1909,15 @@ theBait = 1000;
 theSwitch = 0;
 
 ref = [theSwitch, theBait], theBait = ref[0], theSwitch = ref[1];
-
load
load
run: theBait


-    

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

-    
weatherReport = (location) ->
+;alert(theBait);">run: theBait

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"]
 
@@ -2244,19 +1929,15 @@ weatherReport = function("Berkeley, CA"), city = ref[0], temp = ref[1], forecast = ref[2];
-
load
\n  # Make an Ajax request to fetch the weather...\n  [location, 72, \"Mostly Sunny\"]\n\n[city, temp, forecast] = weatherReport \"Berkeley, CA\"\n"
load
run: forecast


-    

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

-    
futurists =
+;alert(forecast);">run: forecast

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:
@@ -2279,7 +1960,7 @@ futurists = {
 };
 
 ref = futurists.poet, name = ref.name, (ref1 = ref.address, street = ref1[0], city = ref1[1]);
-
load
load
run: name + "-" + street


-    

-      Destructuring assignment can even be combined with splats.
-    

-    
tag = "<impossible>"
+;alert(name + "-" + street);">run: name + "-" + street

Destructuring assignment can even be combined with splats.

+
tag = "<impossible>"
 
 [open, contents..., close] = tag.split("")
 
var close, contents, i, open, ref, tag,
@@ -2304,17 +1982,14 @@ ref = futurists.poet, name = ref.name, (ref1 = ref.address, street = ref1[0], ci
 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++];
-
load
\"\n\n[open, contents..., close] = tag.split(\"\")\n"
load
run: contents.join("")


-    

-      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
+;alert(contents.join(""));">run: contents.join("")

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 " "
@@ -2323,17 +1998,13 @@ ref = tag.split(""), open = ref[0], contents = 3 <= ref.length ? slice
 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];
-
load
load
run: first + " " + last


-    

-      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
+;alert(first + " " + last);">run: first + " " + last

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 = 'average'} = options
 
@@ -2354,7 +2025,7 @@ tim = new Person({
   name: 'Tim',
   age: 4
 });
-
load
\n    {@name, @age, @height = 'average'} = options\n\ntim = new Person name: 'Tim', age: 4\n"
load
run: tim.age + " " + tim.height


-    

-      The above example also demonstrates that if properties are missing in the
-      destructured object or array, you can, just like in JavaScript, provide
-      defaults. The difference with JavaScript is that CoffeeScript, as always,
-      treats both null and undefined the same.
-    

+;alert(tim.age + " " + tim.height);">run: tim.age + " " + tim.height

The above example also demonstrates that if properties are missing in the destructured object or array, you can, just like in JavaScript, provide defaults. The difference with JavaScript is that CoffeeScript, as always, treats both null and undefined the same.

 
-    

-      
-      Bound Functions, Generator Functions
-      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 on. Functions created with the fat arrow are able to access
-      properties of the this where they’re defined.
-    

-    
Account = (customer, cart) ->
+    
+      
Bound Functions, Generator Functions
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 on. 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
 
@@ -2413,25 +2063,10 @@ Account = function(this));
 };
-
load


-    

-      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.
-    

-    

-      
-      CoffeeScript functions also support
-      ES2015 generator functions
-      through the yield keyword. There’s no function*(){}
-      nonsense — a generator in CoffeeScript is simply a function that yields.
-    

-    
perfectSquares = ->
+
load

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.

+
CoffeeScript functions also support ES2015 generator functions through the yield keyword. There’s no function*(){} nonsense — a generator in CoffeeScript is simply a function that yields.

+
perfectSquares = ->
   num = 0
   loop
     num += 1
@@ -2451,7 +2086,7 @@ perfectSquares = function*(<
 };
 
 window.ps || (window.ps = perfectSquares());
-
load
\n  num = 0\n  loop\n    num += 1\n    yield num * num\n  return\n\nwindow.ps or= perfectSquares()\n"
load
run: ps.next().value


-    

-      yield* is called yield from, and yield return
-      may be used if you need to force a generator that doesn’t yield.
-    

-    

-      
-      You can iterate over a generator function using for…from.
-    

-    
fibonacci = ->
+;alert(ps.next().value);">run: ps.next().value

yield* is called yield from, and yield return may be used if you need to force a generator that doesn’t yield.

+
You can iterate over a generator function using for…from.

+
fibonacci = ->
   [previous, current] = [1, 1]
   loop
     [previous, current] = [current, previous + current]
@@ -2508,7 +2136,7 @@ getFibonacciNumbers = functionreturn results;
 };
-
load
\n  [previous, current] = [1, 1]\n  loop\n    [previous, current] = [current, previous + current]\n    yield current\n  return\n\ngetFibonacciNumbers = (length) ->\n  results = [1]\n  for n from fibonacci()\n    results.push n\n    break if results.length is length\n  results\n"
load
run: getFibonacciNumbers(10)


-
-    

-      
-      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() {
+    
+      
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;
@@ -2548,20 +2170,14 @@ getFibonacciNumbers = function(length) {
 hi = function() {
   return [document.title, "Hello JavaScript"].join(": ");
 };
-
load
load
run: hi()


-    

-      Escape backticks with backslashes: \` becomes `.
-    

-    

-      Escape backslashes before backticks with more backslashes: \\\`
-      becomes \`.
-    

-    
markdown = `function () {
+;alert(hi());">run: hi()

Escape backticks with backslashes: \`​ becomes `​.

+
Escape backslashes before backticks with more backslashes: \\\`​ becomes \`​.

+
markdown = `function () {
   return \`In Markdown, write code like \\\`this\\\`\`;
 }`
 
var markdown;
@@ -2569,17 +2185,13 @@ hi = function() {
 markdown = function () {
   return `In Markdown, write code like \`this\``;
 };
-
load
load
run: markdown()


-    

-      You can also embed blocks of JavaScript using triple backticks. That’s easier
-      than escaping backticks, if you need them inside your JavaScript block.
-    

-    
```
+;alert(markdown());">run: markdown()

You can also embed blocks of JavaScript using triple backticks. That’s easier than escaping backticks, if you need them inside your JavaScript block.

+
```
 function time() {
   return `The time is ${new Date().toLocaleTimeString()}`;
 }
@@ -2590,30 +2202,17 @@ markdown = function () {
 }
 ;
 
-
load
load
run: time()


-
-    

-      
-      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
+    
+      
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
@@ -2646,12 +2245,8 @@ function time() {
   default:
     go(work);
 }
-
load


-
-    

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

-    
score = 76
+
load

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

+
score = 76
 grade = switch
   when score < 60 then 'F'
   when score < 70 then 'D'
@@ -2677,16 +2272,10 @@ grade = (function(return 'A';
   }
 })();
-
load


-
-    

-      
-      Try/Catch/Finally
-      Try-expressions have the same semantics as try-statements in JavaScript,
-      though in CoffeeScript, you may omit both the catch and finally
-      parts. The catch part may also omit the error parameter if it is not needed.
-    

-    
try
+
load


+    
+      
Try/Catch/Finally
Try-expressions have the same semantics as try-statements in JavaScript, though in CoffeeScript, you may omit both the catch and finally parts. The catch part may also omit the error parameter if it is not needed.

+
try
   allHellBreaksLoose()
   catsAndDogsLivingTogether()
 catch error
@@ -2704,17 +2293,10 @@ grade = (function(finally {
   cleanUp();
 }
-
load


-
-    

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

-    
cholesterol = 127
+
load


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

+
cholesterol = 127
 
 healthy = 200 > cholesterol > 60
 
var cholesterol, healthy;
@@ -2722,22 +2304,15 @@ healthy = 200 > cholesterol > 127;
 
 healthy = (200 > cholesterol && cholesterol > 60);
-
load
 cholesterol > 60\n"
load
run: healthy


-
-    

-      
-      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. You may even use interpolation in
-      object keys.
-    

-    
author = "Wittgenstein"
+    
+      
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. You may even use interpolation in object keys.

+
author = "Wittgenstein"
 quote  = "A picture is a fact. -- #{ author }"
 
 sentence = "#{ 22 / 7 } is a decent approximation of π"
@@ -2748,18 +2323,15 @@ author = "Wittgenstein";
 quote = "A picture is a fact. -- " + author;
 
 sentence = (22 / 7) + " is a decent approximation of π";
-
load
load
run: sentence


-    

-      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 --
+;alert(sentence);">run: sentence

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
@@ -2768,17 +2340,11 @@ sentence = (22 / 7) + " is a decent approximation of π";
 
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...";
-
load
load
run: mobyDick


-    

-      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 = """
+;alert(mobyDick);">run: mobyDick

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>
@@ -2786,20 +2352,12 @@ mobyDick = "Call me Ishmael. Some years ago -- never mind how long precisel
 
var html;
 
 html = "<strong>\n  cup of coffeescript\n</strong>";
-
load
\n         cup of coffeescript\n       \n       \"\"\"\n"
load
run: html


-    

-      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.
-    

-    
###
+;alert(html);">run: html

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.0
 Released under the MIT License
 ###
@@ -2809,29 +2367,11 @@ SkinnyMochaHalfCaffScript Compiler v1.0
 Released under the MIT License
  */
 
-
load


-
-    

-      
-      Tagged Template Literals
-      CoffeeScript supports
-      ES2015 tagged template literals,
-      which enable customized string interpolation. If you immediately prefix a string
-      with a function name (no space between the two), CoffeeScript will output this
-      “function plus string” combination as an ES2015 tagged template literal, which will
-      behave accordingly:
-      the function is called, with the parameters being the input text and expression parts
-      that make up the interpolated string. The function can then assemble these parts
-      into an output string, providing custom string interpolation.
-    

-    

-      Be aware that the CoffeeScript compiler is outputting ES2015 syntax for this feature,
-      so your target JavaScript runtime(s) must support this syntax for your code to work;
-      or you could use tools like Babel or
-      Traceur Compiler to convert
-      this ES2015 syntax into compatible JavaScript.
-    

-    
upperCaseExpr = (textParts, expressions...) ->
+
load


+    
+      
Tagged Template Literals
CoffeeScript supports ES2015 tagged template literals, which enable customized string interpolation. If you immediately prefix a string with a function name (no space between the two), CoffeeScript will output this “function plus string” combination as an ES2015 tagged template literal, which will behave accordingly: the function is called, with the parameters being the input text and expression parts that make up the interpolated string. The function can then assemble these parts into an output string, providing custom string interpolation.

+
Be aware that the CoffeeScript compiler is outputting ES2015 syntax for this feature, so your target JavaScript runtime(s) must support this syntax for your code to work; or you could use tools like Babel or Traceur Compiler to convert this ES2015 syntax into compatible JavaScript.

+
upperCaseExpr = (textParts, expressions...) ->
   textParts.reduce (text, textPart, i) ->
     text + expressions[i - 1].toUpperCase() + textPart
 
@@ -2853,7 +2393,7 @@ upperCaseExpr = function(function(name, adjective) {
   return upperCaseExpr`Hi ${name}. You look ${adjective}!`;
 };
-
load
\n  textParts.reduce (text, textPart, i) ->\n    text + expressions[i - 1].toUpperCase() + textPart\n\ngreet = (name, adjective) ->\n  upperCaseExpr\"\"\"\n               Hi #{name}. You look #{adjective}!\n               \"\"\"\n"
load
run: greet("greg", "awesome")


-
-    

-      
-      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 = /// ^ (
+    
+      
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
@@ -2890,15 +2422,10 @@ greet = function(name, adjective) {
 
var OPERATOR;
 
 OPERATOR = /^(?:[-=]>|[-+*\/%<>&|^!?=]=|>>>=?|([-+:])\1|([&|<>])\2=?|\?\.|\.{2,3})/;
-
load


-
-    

-      
-      Modules
-      ES2015 modules are supported in CoffeeScript, with very similar import
-      and export syntax:
-    

-    
import 'local-file.coffee'
+
load


+    
+      
Modules
ES2015 modules are supported in CoffeeScript, with very similar import and export syntax:

+
import 'local-file.coffee'
 import 'coffee-script'
 
 import _ from 'underscore'
@@ -2985,49 +2512,13 @@ OPERATOR = /^(?:[-=]>|[-+*\/%<>&|^!?=]=|>&g
   max,
   min
 } from 'underscore';
-
load


-    

-      
-      Note that the CoffeeScript compiler does not resolve modules; writing an
-      import or export statement in CoffeeScript will produce an
-      import or export statement in the resulting output.
-      It is your responsibility attach another transpiler, such as
-      Traceur Compiler,
-      Babel or
-      Rollup, to convert this ES2015 syntax into
-      code that will work in your target runtimes.
-    

-    

-      Also note that any file with an import or export statement will
-      be output without a top-level function safety wrapper;
-      in other words, importing or exporting modules will automatically trigger
-      bare mode for that file. This is because per the ES2015 spec,
-      import or export statements must occur at the topmost scope.
+
load

Note that the CoffeeScript compiler does not resolve modules; writing an import or export statement in CoffeeScript will produce an import or export statement in the resulting output. It is your responsibility attach another transpiler, such as Traceur Compiler, Babel or Rollup, to convert this ES2015 syntax into code that will work in your target runtimes.

+
Also note that any file with an import or export statement will be output without a top-level function safety wrapper; in other words, importing or exporting modules will automatically trigger bare mode for that file. This is because per the ES2015 spec, import or export statements must occur at the topmost scope.

 
-    

-      
-      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'
+  
+    
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'
 
@@ -3049,705 +2540,243 @@ task('build:parser', 'rebuild t
   dir = options.output || 'lib';
   return fs.writeFile(dir + "/parser.js", code);
 });
-
load


-    

-      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.
-    

+
load

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
-    

+  
+    
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.

 
-    

-      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.
-    

+  
+    
"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, 51k when gzipped) as v1/browser-compiler/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.

 
-    

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

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

+
 
-    

-      
-      "text/coffeescript" Script Tags
-    

+  
+    
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.
    • 
+

 
-    

-      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, 51k when gzipped)
-      as v1/browser-compiler/coffee-script.js. Include this file on a page with
-      inline CoffeeScript tags, and it will compile and evaluate them in order.
-    

+  
+    
Examples
The best list of open-source CoffeeScript examples can be found on GitHub. But just to throw out a 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.
    • 
+
  • stephank’s Orona, a remake of the Bolo tank game for modern browsers.
    • 
+
  • GitHub’s Atom, a hackable text editor built on web technologies.
    • 
+
  • Basecamp’s Trix, a rich text editor for web apps.
    • 
+

 
-    

-      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.
-    

+  
+    
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.
    
+
    • 
+
  • Browser Tests
    
+Run CoffeeScript’s test suite in your current browser.
    • 
+
  • 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 SVG for use in presentations.
    • 
+

 
-    

-      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.
-    

+  
+    
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.

+
 
-    

-      
-      Books
-    

-
-    

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

-
-    
-
-    

-      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 a 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.
-      
    • 
-      
  • 
-        stephank’s Orona, a remake of
-        the Bolo tank game for modern browsers.
-      
    • 
-      
  • 
-        GitHub’s Atom,
-        a hackable text editor built on web technologies.
-      
    • 
-      
  • 
-        Basecamp’s Trix, a rich text editor for web apps.
-      
    • 
-    

-
-    

-      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.
-      
    • 
-      
  • 
-        Browser Tests
    
-        Run CoffeeScript’s test suite in your current browser.
-      
    • 
-      
  • 
-        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 SVG 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.
-    

-
-    

-      
-    

-
-    

-      
-      Change Log
-    

-
-    

-      

-
+  
+    
Change Log

+

   1.12.1
-   — 
-
-      
    
-        
  • 
-          You can now import a module member named default, e.g.
-          import { default } from 'lib'. Though like in ES2015,
-          you cannot import an entire module and name it default
-          (so import default from 'lib' is not allowed).
-        
    • 
-        
  • 
-          Fix regression where from as a variable name was
-          breaking for loop declarations. For the record,
-          from is not a reserved word in CoffeeScript; you may
-          use it for variable names. from behaves like a keyword
-          within the context of import and export
-          statements, and in the declaration of a for loop; though
-          you should also be able to use variables named from in
-          those contexts, and the compiler should be able to tell the
-          difference.
-      

-    

-
-    

-      

-
+   — 
+
    
+
  • You can now import a module member named default, e.g. import { default } from 'lib'. Though like in ES2015, you cannot import an entire module and name it default (so import default from 'lib' is not allowed).
    • 
+
  • Fix regression where from as a variable name was breaking for loop declarations. For the record, from is not a reserved word in CoffeeScript; you may use it for variable names. from behaves like a keyword within the context of import and export statements, and in the declaration of a for loop; though you should also be able to use variables named from in those contexts, and the compiler should be able to tell the difference.
    • 
+

+

+

   1.12.0
    — 
-
-      
    
-        
  • 
-          CoffeeScript now supports ES2015
-          tagged template literals.
-          Note that using tagged template literals in your code
-          makes you responsible for ensuring that either your runtime supports
-          tagged template literals or that you transpile the output JavaScript
-          further to a version your target runtime(s) support.
-        
    • 
-        
  • 
-          CoffeeScript now provides a
-          for…from
-          syntax for outputting ES2015
-          
-          for…of. (Sorry they couldn’t match,
-          but we came up with for…of first for something
-          else.) This allows iterating over generators or any other iterable
-          object. Note that using for…from in your code
-          makes you responsible for ensuring that either your runtime supports
-          for…of or that you transpile the output
-          JavaScript further to a version your target runtime(s) support.
-        
    • 
-        
  • 
-          Triple backticks (```) allow the creation of embedded
-          JavaScript blocks where escaping single backticks is not required,
-          which should improve interoperability with ES2015 template literals
-          and with Markdown.
-        
    • 
-        
  • 
-          Within single-backtick embedded JavaScript, backticks can now be
-          escaped via \`.
-        
    • 
-        
  • 
-          The browser tests now run in the browser again, and are accessible
-          here if you would like
-          to test your browser.
-        
    • 
-        
  • 
-          CoffeeScript-only keywords in ES2015 imports and
-          exports are now ignored.
-        
    • 
-        
  • 
-          The compiler now throws an error on trying to export an anonymous class.
-        
    • 
-        
  • 
-          Bugfixes related to tokens and location data, for better source maps
-          and improved compatibility with downstream tools.
-        
    • 
-      

-    

-
-    

-      

-
+
    
+
  • CoffeeScript now supports ES2015 tagged template literals. Note that using tagged template literals in your code makes you responsible for ensuring that either your runtime supports tagged template literals or that you transpile the output JavaScript further to a version your target runtime(s) support.
    • 
+
  • CoffeeScript now provides a for…from syntax for outputting ES2015 for…of. (Sorry they couldn’t match, but we came up with for…of first for something else.) This allows iterating over generators or any other iterable object. Note that using for…from in your code makes you responsible for ensuring that either your runtime supports for…of or that you transpile the output JavaScript further to a version your target runtime(s) support.
    • 
+
  • Triple backticks (```​) allow the creation of embedded JavaScript blocks where escaping single backticks is not required, which should improve interoperability with ES2015 template literals and with Markdown.
    • 
+
  • Within single-backtick embedded JavaScript, backticks can now be escaped via \`​.
    • 
+
  • The browser tests now run in the browser again, and are accessible here if you would like to test your browser.
    • 
+
  • CoffeeScript-only keywords in ES2015 imports and exports are now ignored.
    • 
+
  • The compiler now throws an error on trying to export an anonymous class.
    • 
+
  • Bugfixes related to tokens and location data, for better source maps and improved compatibility with downstream tools.
    • 
+

+

+

   1.11.1
    — 
-
-      
    
-        
  • 
-          Bugfix for shorthand object syntax after interpolated keys.
-        
    • 
-        
  • 
-          Bugfix for indentation-stripping in """ strings.
-        
    • 
-        
  • 
-          Bugfix for not being able to use the name “arguments” for a prototype
-          property of class.
-        
    • 
-        
  • 
-          Correctly compile large hexadecimal numbers literals to
-          2e308 (just like all other large number literals do).
-        
    • 
-      

-    

-
-    

-      

-
+
    
+
  • Bugfix for shorthand object syntax after interpolated keys.
    • 
+
  • Bugfix for indentation-stripping in """ strings.
    • 
+
  • Bugfix for not being able to use the name “arguments” for a prototype property of class.
    • 
+
  • Correctly compile large hexadecimal numbers literals to 2e308 (just like all other large number literals do).
    • 
+

+

+

   1.11.0
    — 
-
-      
    
-        
  • 
-          CoffeeScript now supports ES2015
-          import and export syntax.
-        
    • 
-        
  • 
-          Added the -M, --inline-map flag to the compiler, allowing
-          you embed the source map directly into the output JavaScript, rather
-          than as a separate file.
-        
    • 
-        
  • 
-          
    A bunch of fixes for yield:
    
-          
      
-            
    • 
-              yield return can no longer mistakenly be used as an expression.
-            
      • 
-            
    • 
-              
      
-                yield now mirrors return in that it
-                can be used stand-alone as well as with expressions. Where you
-                previously wrote yield undefined, you may now write
-                simply yield. However, this means also inheriting
-                the same syntax limitations that return has, so
-                these examples no longer compile:
-              
      
-              
      doubles = ->
+
    
+
  • CoffeeScript now supports ES2015 import and export syntax.
    • 
+
  • Added the -M, --inline-map flag to the compiler, allowing you embed the source map directly into the output JavaScript, rather than as a separate file.
    • 
+
  • A bunch of fixes for yield:
    
+
      
+
    • yield return can no longer mistakenly be used as an expression.
      • 
+
    • yield now mirrors return in that it can be used stand-alone as well as with expressions. Where you previously wrote yield undefined, you may now write simply yield. However, this means also inheriting the same syntax limitations that return has, so these examples no longer compile:
      
+
      doubles = ->
   yield for i in [1..3]
     i * 2
-
-six = ->
+six = ->
   yield
-    2 * 3
      
-            
      • 
-            
    • 
-              The JavaScript output is a bit nicer, with unnecessary parentheses
-              and spaces, double indentation and double semicolons around
-              yield no longer present.
-            
      • 
-          
    
-        
    • 
-        
  • 
-          &&=, ||=, and= and
-          or= no longer accidentally allow a space before the
-          equals sign.
-        
    • 
-        
  • 
-          Improved several error messages.
-        
    • 
-        
  • 
-          Just like undefined compiles to void 0,
-          NaN now compiles into 0/0 and
-          Infinity into 2e308.
-        
    • 
-        
  • 
-          Bugfix for renamed destructured parameters with defaults.
-          ({a: b = 1}) -> no longer crashes the compiler.
-        
    • 
-        
  • 
-          Improved the internal representation of a CoffeeScript program. This
-          is only noticeable to tools that use CoffeeScript.tokens
-          or CoffeeScript.nodes. Such tools need to update to take
-          account for changed or added tokens and nodes.
-        
    • 
-        
  • 
-          
    Several minor bug fixes, including:
    
-          
      
-            
    • 
-              The caught error in catch blocks is no longer
-              declared unnecessarily, and no longer mistakenly named
-              undefined for catch-less
-              try blocks.
-            
      • 
-            
    • 
-              Unassignable parameter destructuring no longer crashes the compiler.
-            
      • 
-            
    • 
-              Source maps are now used correctly for errors thrown from .coffee.md files.
-            
      • 
-            
    • 
-              coffee -e 'throw null' no longer crashes.
-            
      • 
-            
    • 
-              The REPL no longer crashes when using .exit to exit it.
-            
      • 
-            
    • 
-              Invalid JavaScript is no longer output when lots of
-              for loops are used in the same scope.
-            
      • 
-            
    • 
-              A unicode issue when using stdin with the CLI.
-            
      • 
-          
    
-      

-    

-
-    

-      

-
+    2 * 3

+
  • The JavaScript output is a bit nicer, with unnecessary parentheses and spaces, double indentation and double semicolons around yield no longer present.
    
+
    • 
+
+
+
  • &&=, ||=, and= and or= no longer accidentally allow a space before the equals sign.
    • 
+
  • Improved several error messages.
    • 
+
  • Just like undefined compiles to void 0, NaN now compiles into 0/0 and Infinity into 2e308.
    • 
+
  • Bugfix for renamed destructured parameters with defaults. ({a: b = 1}) -> no longer crashes the compiler.
    • 
+
  • Improved the internal representation of a CoffeeScript program. This is only noticeable to tools that use CoffeeScript.tokens or CoffeeScript.nodes. Such tools need to update to take account for changed or added tokens and nodes.
    • 
+
  • Several minor bug fixes, including:
    
+
      
+
    • The caught error in catch blocks is no longer declared unnecessarily, and no longer mistakenly named undefined for catch-less try blocks.
      • 
+
    • Unassignable parameter destructuring no longer crashes the compiler.
      • 
+
    • Source maps are now used correctly for errors thrown from .coffee.md files.
      • 
+
    • coffee -e 'throw null' no longer crashes.
      • 
+
    • The REPL no longer crashes when using .exit to exit it.
      • 
+
    • Invalid JavaScript is no longer output when lots of for loops are used in the same scope.
      • 
+
    • A unicode issue when using stdin with the CLI.
      • 
+
    
+
    • 
+
+
    
+
    
   1.10.0
    — 
-
-      
      
-        
    • 
-          CoffeeScript now supports ES2015-style destructuring defaults.
-        
      • 
-        
    • 
-          (offsetHeight: height) -> no longer compiles. That
-          syntax was accidental and partly broken. Use ({offsetHeight: height}) ->
-          instead. Object destructuring always requires braces.
-        
      • 
-        
    • 
-          
      Several minor bug fixes, including:
      
-          
        
-            
      • 
-              A bug where the REPL would sometimes report valid code as invalid,
-              based on what you had typed earlier.
-            
        • 
-            
      • 
-              A problem with multiple JS contexts in the jest test framework.
-            
        • 
-            
      • 
-              An error in io.js where strict mode is set on internal modules.
-            
        • 
-            
      • 
-              A variable name clash for the caught error in catch
-              blocks.
-            
        • 
-          
      
-        
      • 
-      
    
-    
    
-
-    
    
-      
    
-
+
      
+
    • CoffeeScript now supports ES2015-style destructuring defaults.
      • 
+
    • (offsetHeight: height) -> no longer compiles. That syntax was accidental and partly broken. Use ({offsetHeight: height}) -> instead. Object destructuring always requires braces.
      • 
+
    • Several minor bug fixes, including:
      
+
        
+
      • A bug where the REPL would sometimes report valid code as invalid, based on what you had typed earlier.
        • 
+
      • A problem with multiple JS contexts in the jest test framework.
        • 
+
      • An error in io.js where strict mode is set on internal modules.
        • 
+
      • A variable name clash for the caught error in catch blocks.
        • 
+
      
+
      • 
+
    
+
    
+
    
   1.9.3
    — 
-
-      
      
-        
    • 
-          Bugfix for interpolation in the first key of an object literal in an
-          implicit call.
-        
      • 
-        
    • 
-          Fixed broken error messages in the REPL, as well as a few minor bugs
-          with the REPL.
-        
      • 
-        
    • 
-          Fixed source mappings for tokens at the beginning of lines when
-          compiling with the --bare option. This has the nice side
-          effect of generating smaller source maps.
-        
      • 
-        
    • 
-          Slight formatting improvement of compiled block comments.
-        
      • 
-        
    • 
-          Better error messages for on, off, yes and
-          no.
-        
      • 
-      
    
-    
    
-
-    
    
-      
    
-
+
      
+
    • Bugfix for interpolation in the first key of an object literal in an implicit call.
      • 
+
    • Fixed broken error messages in the REPL, as well as a few minor bugs with the REPL.
      • 
+
    • Fixed source mappings for tokens at the beginning of lines when compiling with the --bare option. This has the nice side effect of generating smaller source maps.
      • 
+
    • Slight formatting improvement of compiled block comments.
      • 
+
    • Better error messages for on, off, yes and no.
      • 
+
    
+
    
+
    
   1.9.2
    — 
-
-      
      
-        
    • 
-          Fixed a watch mode error introduced in 1.9.1 when compiling
-          multiple files with the same filename.
-        
      • 
-        
    • 
-          Bugfix for yield around expressions containing
-          this.
-        
      • 
-        
    • 
-          Added a Ruby-style -r option to the REPL, which allows
-          requiring a module before execution with --eval or
-          --interactive.
-        
      • 
-        
    • 
-          In <script type="text/coffeescript"> tags, to avoid
-          possible duplicate browser requests for .coffee files,
-          you can now use the data-src attribute instead of src.
-        
      • 
-        
    • 
-          Minor bug fixes for IE8, strict ES5 regular expressions and Browserify.
-        
      • 
-      
    
-    
    
-
-    
    
-      
    
-
+
      
+
    • Fixed a watch mode error introduced in 1.9.1 when compiling multiple files with the same filename.
      • 
+
    • Bugfix for yield around expressions containing this.
      • 
+
    • Added a Ruby-style -r option to the REPL, which allows requiring a module before execution with --eval or --interactive.
      • 
+
    • In <script type="text/coffeescript"> tags, to avoid possible duplicate browser requests for .coffee files, you can now use the data-src attribute instead of src.
      • 
+
    • Minor bug fixes for IE8, strict ES5 regular expressions and Browserify.
      • 
+
    
+
    
+
    
   1.9.1
    — 
-
-      
      
-        
    • 
-          Interpolation now works in object literal keys (again). You can use this to
-          dynamically name properties.
-        
      • 
-        
    • 
-          Internal compiler variable names no longer start with underscores. This makes
-          the generated JavaScript a bit prettier, and also fixes an issue with
-          the completely broken and ungodly way that AngularJS “parses” function
-          arguments.
-        
      • 
-        
    • 
-          Fixed a few yield-related edge cases with yield return
-          and yield throw.
-        
      • 
-        
    • 
-          Minor bug fixes and various improvements to compiler error messages.
-        
      • 
-      
    
-    
    
-
-    
    
-      
    
-
+
      
+
    • Interpolation now works in object literal keys (again). You can use this to dynamically name properties.
      • 
+
    • Internal compiler variable names no longer start with underscores. This makes the generated JavaScript a bit prettier, and also fixes an issue with the completely broken and ungodly way that AngularJS “parses” function arguments.
      • 
+
    • Fixed a few yield-related edge cases with yield return and yield throw.
      • 
+
    • Minor bug fixes and various improvements to compiler error messages.
      • 
+
    
+
    
+
    
   1.9.0
    — 
-
-      
      
-        
    • 
-          CoffeeScript now supports ES2015 generators. A generator is simply a function
-          that yields.
-        
      • 
-        
    • 
-          More robust parsing and improved error messages for strings and regexes —
-          especially with respect to interpolation.
-        
      • 
-        
    • 
-          Changed strategy for the generation of internal compiler variable names.
-          Note that this means that @example function parameters are no longer
-          available as naked example variables within the function body.
-        
      • 
-        
    • 
-          Fixed REPL compatibility with latest versions of Node and Io.js.
-        
      • 
-        
    • 
-          Various minor bug fixes.
-        
      • 
-      
    
-    
    
-
-    
    
-      
    
-
+
      
+
    • CoffeeScript now supports ES2015 generators. A generator is simply a function that yields.
      • 
+
    • More robust parsing and improved error messages for strings and regexes — especially with respect to interpolation.
      • 
+
    • Changed strategy for the generation of internal compiler variable names. Note that this means that @example function parameters are no longer available as naked example variables within the function body.
      • 
+
    • Fixed REPL compatibility with latest versions of Node and Io.js.
      • 
+
    • Various minor bug fixes.
      • 
+
    
+
    
+
    
   1.8.0
    — 
-
-      
      
-        
    • 
-          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.
-        
      • 
-      
    
-    
    
-
-    
    
-      
    
-
+
      
+
    • 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.
      • 
+
    
+
    
+
    
   1.7.1
    — 
-
-      
      
-        
    • 
-          Fixed a typo that broke node module lookup when running a script directly with the coffee binary.
-        
      • 
-      
    
-    
    
-    
    
-      
    
-
+
      
+
    • Fixed a typo that broke node module lookup when running a script directly with the coffee binary.
      • 
+
    
+
    
+
    
   1.7.0
    — 
-
-      
      
-        
    • 
-          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'
+
      
+
    • 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'
@@ -3756,1009 +2785,434 @@ six = ->
 
    $('body').click(function(e) {
   return $('.box').fadeIn('fast').addClass('.active');
 }).css('background', 'white');
-
    load

    
-      
      
-        
    • 
-          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.
-        
      • 
-      
    
-    
    
-    
    
-      
    
-
+
    load

      
+
    • 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.
      • 
+
    
+
    
+
    
   1.6.3
    — 
-
-      
      
-        
    • 
-          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.
-        
      • 
-      
    
-    
    
-
-    
    
-      
    
-
+
      
+
    • 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.
      • 
+
    
+
    
+
    
   1.6.2
    — 
-
-      
      
-        
    • 
-          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+)
-        
      • 
-      
    
-    
    
-
-    
    
-      
    
-
+
      
+
    • 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+)
      • 
+
    
+
    
+
    
   1.6.1
    — 
-
-      
      
-        
    • 
-          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 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.
      • 
+
    
+
    
+
    
   1.5.0
    — 
-
-      
      
-        
    • 
-          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.
-        
      • 
-      
    
-    
    
-
-    
    
-      
    
-
+
      
+
    • 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.
      • 
+
    
+
    
+
    
   1.4.0
    — 
-
-      
      
-        
    • 
-          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.
-        
      • 
-      
    
-    
    
-
-    
    
-      
    
-
+
      
+
    • 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.
      • 
+
    
+
    
+
    
   1.3.3
    — 
-
-      
      
-        
    • 
-          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.
-        
      • 
-      
    
-    
    
-
-    
    
-      
    
-
+
      
+
    • 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.
      • 
+
    
+
    
+
    
   1.3.1
    — 
-
-      
      
-        
    • 
-          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.
-        
      • 
-      
    
-    
    
-
-    
    
-      
    
-
+
      
+
    • 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.
      • 
+
    
+
    
+
    
   1.2.0
    — 
-
-      
      
-        
    • 
-          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.
-        
      • 
-      
    
-    
    
-
-    
    
-      
    
-
+
      
+
    • 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.
      • 
+
    
+
    
+
    
   1.1.3
    — 
-
-      
      
-        
    • 
-          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.
-        
      • 
-      
    
-    
    
-
-    
    
-      
    
-
+
      
+
    • 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.
      • 
+
    
+
    
+
    
   1.1.2
    — 
-
-      Fixes for block comment formatting, ?= compilation, implicit calls
-      against control structures, implicit invocation of a try/catch block,
-      variadic arguments leaking from local scope, line numbers in syntax errors
-      following heregexes, property access on parenthesized number literals,
-      bound class methods and super with reserved names, a REPL overhaul,
-      consecutive compiled semicolons, block comments in implicitly called objects,
-      and a Chrome bug.
-    
    
-
-    
    
-      
    
-
+
    Fixes for block comment formatting, ?= compilation, implicit calls against control structures, implicit invocation of a try/catch block, variadic arguments leaking from local scope, line numbers in syntax errors following heregexes, property access on parenthesized number literals, bound class methods and super with reserved names, a REPL overhaul, consecutive compiled semicolons, block comments in implicitly called objects, and a Chrome bug.
    
+
    
+
    
   1.1.1
    — 
-
-      Bugfix release for classes with external constructor functions, see
-      issue #1182.
-    
    
-
-    
    
-      
    
-
+
    Bugfix release for classes with external constructor functions, see issue #1182.
    
+
    
+
    
   1.1.0
    — 
-
-      When running via the coffee executable, process.argv and
-      friends now report coffee instead of node.
-      Better compatibility with Node.js 0.4.x module lookup changes.
-      The output in the REPL is now colorized, like Node’s is.
-      Giving your concatenated CoffeeScripts a name when using --join is now mandatory.
-      Fix for lexing compound division /= as a regex accidentally.
-      All text/coffeescript tags should now execute in the order they’re included.
-      Fixed an issue with extended subclasses using external constructor functions.
-      Fixed an edge-case infinite loop in addImplicitParentheses.
-      Fixed exponential slowdown with long chains of function calls.
-      Globals no longer leak into the CoffeeScript REPL.
-      Splatted parameters are declared local to the function.
-    
    
-
-    
    
-      
    
-
+
    When running via the coffee executable, process.argv and friends now report coffee instead of node. Better compatibility with Node.js 0.4.x module lookup changes. The output in the REPL is now colorized, like Node’s is. Giving your concatenated CoffeeScripts a name when using --join is now mandatory. Fix for lexing compound division /= as a regex accidentally. All text/coffeescript tags should now execute in the order they’re included. Fixed an issue with extended subclasses using external constructor functions. Fixed an edge-case infinite loop in addImplicitParentheses. Fixed exponential slowdown with long chains of function calls. Globals no longer leak into the CoffeeScript REPL. Splatted parameters are declared local to the function.
    
+
    
+
    
   1.0.1
    — 
-
-      Fixed a lexer bug with Unicode identifiers. Updated REPL for compatibility
-      with Node.js 0.3.7. Fixed requiring relative paths in the REPL. Trailing
-      return and return undefined are now optimized away.
-      Stopped requiring the core Node.js util module for
-      back-compatibility with Node.js 0.2.5. Fixed a case where a
-      conditional return would cause fallthrough in a switch
-      statement. Optimized empty objects in destructuring assignment.
-    
    
-
-    
    
-      
    
-
+
    Fixed a lexer bug with Unicode identifiers. Updated REPL for compatibility with Node.js 0.3.7. Fixed requiring relative paths in the REPL. Trailing return and return undefined are now optimized away. Stopped requiring the core Node.js util module for back-compatibility with Node.js 0.2.5. Fixed a case where a conditional return would cause fallthrough in a switch statement. Optimized empty objects in destructuring assignment.
    
+
    
+
    
   1.0.0
    — 
-
-      CoffeeScript loops no longer try to preserve block scope when functions
-      are being generated within the loop body. Instead, you can use the
-      do keyword to create a convenient closure wrapper.
-      Added a --nodejs flag for passing through options directly
-      to the node executable.
-      Better behavior around the use of pure statements within expressions.
-      Fixed inclusive slicing through -1, for all browsers, and splicing
-      with arbitrary expressions as endpoints.
-    
    
-
-    
    
-      
    
-
+
    CoffeeScript loops no longer try to preserve block scope when functions are being generated within the loop body. Instead, you can use the do keyword to create a convenient closure wrapper. Added a --nodejs flag for passing through options directly to the node executable. Better behavior around the use of pure statements within expressions. Fixed inclusive slicing through -1, for all browsers, and splicing with arbitrary expressions as endpoints.
    
+
    
+
    
   0.9.6
    — 
-
-      The REPL now properly formats stacktraces, and stays alive through
-      asynchronous exceptions. Using --watch now prints timestamps as
-      files are compiled. Fixed some accidentally-leaking variables within
-      plucked closure-loops. Constructors now maintain their declaration
-      location within a class body. Dynamic object keys were removed.
-      Nested classes are now supported. Fixes execution context for naked
-      splatted functions. Bugfix for inversion of chained comparisons.
-      Chained class instantiation now works properly with splats.
-    
    
-
-    
    
-      
    
-
+
    The REPL now properly formats stacktraces, and stays alive through asynchronous exceptions. Using --watch now prints timestamps as files are compiled. Fixed some accidentally-leaking variables within plucked closure-loops. Constructors now maintain their declaration location within a class body. Dynamic object keys were removed. Nested classes are now supported. Fixes execution context for naked splatted functions. Bugfix for inversion of chained comparisons. Chained class instantiation now works properly with splats.
    
+
    
+
    
   0.9.5
    — 
-
-      0.9.5 should be considered the first release candidate for CoffeeScript 1.0.
-      There have been a large number of internal changes since the previous release,
-      many contributed from satyr’s Coco
-      dialect of CoffeeScript. Heregexes (extended regexes) were added. Functions
-      can now have default arguments. Class bodies are now executable code.
-      Improved syntax errors for invalid CoffeeScript. undefined now
-      works like null, and cannot be assigned a new value.
-      There was a precedence change with respect to single-line comprehensions:
-      result = i for i in list
     used to parse as result = (i for i in list)
-      by default … it now parses as 
    (result = i) for i in list.
-    
    
-
-    
    
-      
    
-
+
    0.9.5 should be considered the first release candidate for CoffeeScript 1.0. There have been a large number of internal changes since the previous release, many contributed from satyr’s Coco dialect of CoffeeScript. Heregexes (extended regexes) were added. Functions can now have default arguments. Class bodies are now executable code. Improved syntax errors for invalid CoffeeScript. undefined now works like null, and cannot be assigned a new value. There was a precedence change with respect to single-line comprehensions: result = i for i in list
+used to parse as result = (i for i in list) by default … it now parses as
+(result = i) for i in list.
    
+
    
+
    
   0.9.4
    — 
-
-      CoffeeScript now uses appropriately-named temporary variables, and recycles
-      their references after use. Added require.extensions support for
-      Node.js 0.3. Loading CoffeeScript in the browser now adds just a
-      single CoffeeScript object to global scope.
-      Fixes for implicit object and block comment edge cases.
-    
    
-
-    
    
-      
    
-
+
    CoffeeScript now uses appropriately-named temporary variables, and recycles their references after use. Added require.extensions support for Node.js 0.3. Loading CoffeeScript in the browser now adds just a single CoffeeScript object to global scope. Fixes for implicit object and block comment edge cases.
    
+
    
+
    
   0.9.3
    — 
-
-      CoffeeScript switch statements now compile into JS switch
-      statements — they previously compiled into if/else chains
-      for JavaScript 1.3 compatibility.
-      Soaking a function invocation is now supported. Users of the RubyMine
-      editor should now be able to use --watch mode.
-    
    
-
-    
    
-      
    
-
+
    CoffeeScript switch statements now compile into JS switch statements — they previously compiled into if/else chains for JavaScript 1.3 compatibility. Soaking a function invocation is now supported. Users of the RubyMine editor should now be able to use --watch mode.
    
+
    
+
    
   0.9.2
    — 
-
-      Specifying the start and end of a range literal is now optional, eg. array[3..].
-      You can now say a not instanceof b.
-      Fixed important bugs with nested significant and non-significant indentation (Issue #637).
-      Added a --require flag that allows you to hook into the coffee command.
-      Added a custom jsl.conf file for our preferred JavaScriptLint setup.
-      Sped up Jison grammar compilation time by flattening rules for operations.
-      Block comments can now be used with JavaScript-minifier-friendly syntax.
-      Added JavaScript’s compound assignment bitwise operators. Bugfixes to
-      implicit object literals with leading number and string keys, as the subject
-      of implicit calls, and as part of compound assignment.
-    
    
-
-    
    
-      
    
-
+
    Specifying the start and end of a range literal is now optional, eg. array[3..]. You can now say a not instanceof b. Fixed important bugs with nested significant and non-significant indentation (Issue #637). Added a --require flag that allows you to hook into the coffee command. Added a custom jsl.conf file for our preferred JavaScriptLint setup. Sped up Jison grammar compilation time by flattening rules for operations. Block comments can now be used with JavaScript-minifier-friendly syntax. Added JavaScript’s compound assignment bitwise operators. Bugfixes to implicit object literals with leading number and string keys, as the subject of implicit calls, and as part of compound assignment.
    
+
    
+
    
   0.9.1
    — 
-
-      Bugfix release for 0.9.1. Greatly improves the handling of mixed
-      implicit objects, implicit function calls, and implicit indentation.
-      String and regex interpolation is now strictly #{ … } (Ruby style).
-      The compiler now takes a --require flag, which specifies scripts
-      to run before compilation.
-    
    
-
-    
    
-      
    
-
+
    Bugfix release for 0.9.1. Greatly improves the handling of mixed implicit objects, implicit function calls, and implicit indentation. String and regex interpolation is now strictly #{ … } (Ruby style). The compiler now takes a --require flag, which specifies scripts to run before compilation.
    
+
    
+
    
   0.9.0
    — 
-
-      The CoffeeScript 0.9 series is considered to be a release candidate
-      for 1.0; let’s give her a shakedown cruise. 0.9.0 introduces a massive
-      backwards-incompatible change: Assignment now uses =, and object
-      literals use :, as in JavaScript. This allows us to have implicit
-      object literals, and YAML-style object definitions. Half assignments are
-      removed, in favor of +=, or=, and friends.
-      Interpolation now uses a hash mark # instead of the dollar sign
-      $ — because dollar signs may be part of a valid JS identifier.
-      Downwards range comprehensions are now safe again, and are optimized to
-      straight for loops when created with integer endpoints.
-      A fast, unguarded form of object comprehension was added:
-      for all key, value of object. Mentioning the super keyword
-      with no arguments now forwards all arguments passed to the function,
-      as in Ruby. If you extend class B from parent class A, if
-      A has an extended method defined, it will be called, passing in B —
-      this enables static inheritance, among other things. Cleaner output for
-      functions bound with the fat arrow. @variables can now be used
-      in parameter lists, with the parameter being automatically set as a property
-      on the object — useful in constructors and setter functions.
-      Constructor functions can now take splats.
-    
    
-
-    
    
-      
    
-
+
    The CoffeeScript 0.9 series is considered to be a release candidate for 1.0; let’s give her a shakedown cruise. 0.9.0 introduces a massive backwards-incompatible change: Assignment now uses =, and object literals use :, as in JavaScript. This allows us to have implicit object literals, and YAML-style object definitions. Half assignments are removed, in favor of +=, or=, and friends. Interpolation now uses a hash mark # instead of the dollar sign $ — because dollar signs may be part of a valid JS identifier. Downwards range comprehensions are now safe again, and are optimized to straight for loops when created with integer endpoints. A fast, unguarded form of object comprehension was added: for all key, value of object. Mentioning the super keyword with no arguments now forwards all arguments passed to the function, as in Ruby. If you extend class B from parent class A, if A has an extended method defined, it will be called, passing in B — this enables static inheritance, among other things. Cleaner output for functions bound with the fat arrow. @variables can now be used in parameter lists, with the parameter being automatically set as a property on the object — useful in constructors and setter functions. Constructor functions can now take splats.
    
+
    
+
    
   0.7.2
    — 
-
-      Quick bugfix (right after 0.7.1) for a problem that prevented coffee
-      command-line options from being parsed in some circumstances.
-    
    
-
-    
    
-      
    
-
+
    Quick bugfix (right after 0.7.1) for a problem that prevented coffee command-line options from being parsed in some circumstances.
    
+
    
+
    
   0.7.1
    — 
-
-      Block-style comments are now passed through and printed as JavaScript block
-      comments – making them useful for licenses and copyright headers. Better
-      support for running coffee scripts standalone via hashbangs.
-      Improved syntax errors for tokens that are not in the grammar.
-    
    
-
-    
    
-      
    
-
+
    Block-style comments are now passed through and printed as JavaScript block comments – making them useful for licenses and copyright headers. Better support for running coffee scripts standalone via hashbangs. Improved syntax errors for tokens that are not in the grammar.
    
+
    
+
    
   0.7.0
    — 
-
-      Official CoffeeScript variable style is now camelCase, as in JavaScript.
-      Reserved words are now allowed as object keys, and will be quoted for you.
-      Range comprehensions now generate cleaner code, but you have to specify by -1
-      if you’d like to iterate downward. Reporting of syntax errors is greatly
-      improved from the previous release. Running coffee with no arguments
-      now launches the REPL, with Readline support. The <- bind operator
-      has been removed from CoffeeScript. The loop keyword was added,
-      which is equivalent to a while true loop. Comprehensions that contain
-      closures will now close over their variables, like the semantics of a forEach.
-      You can now use bound function in class definitions (bound to the instance).
-      For consistency, a in b is now an array presence check, and a of b
-      is an object-key check. Comments are no longer passed through to the generated
-      JavaScript.
-    
    
-
-    
    
-      
    
-
+
    Official CoffeeScript variable style is now camelCase, as in JavaScript. Reserved words are now allowed as object keys, and will be quoted for you. Range comprehensions now generate cleaner code, but you have to specify by -1 if you’d like to iterate downward. Reporting of syntax errors is greatly improved from the previous release. Running coffee with no arguments now launches the REPL, with Readline support. The <- bind operator has been removed from CoffeeScript. The loop keyword was added, which is equivalent to a while true loop. Comprehensions that contain closures will now close over their variables, like the semantics of a forEach. You can now use bound function in class definitions (bound to the instance). For consistency, a in b is now an array presence check, and a of b is an object-key check. Comments are no longer passed through to the generated JavaScript.
    
+
    
+
    
   0.6.2
    — 
-
-      The coffee command will now preserve directory structure when
-      compiling a directory full of scripts. Fixed two omissions that were preventing
-      the CoffeeScript compiler from running live within Internet Explorer.
-      There’s now a syntax for block comments, similar in spirit to CoffeeScript’s heredocs.
-      ECMA Harmony DRY-style pattern matching is now supported, where the name
-      of the property is the same as the name of the value: {name, length}: func.
-      Pattern matching is now allowed within comprehension variables. unless
-      is now allowed in block form. until loops were added, as the inverse
-      of while loops. switch statements are now allowed without
-      switch object clauses. Compatible
-      with Node.js v0.1.95.
-    
    
-
-    
    
-      
    
-
+
    The coffee command will now preserve directory structure when compiling a directory full of scripts. Fixed two omissions that were preventing the CoffeeScript compiler from running live within Internet Explorer. There’s now a syntax for block comments, similar in spirit to CoffeeScript’s heredocs. ECMA Harmony DRY-style pattern matching is now supported, where the name of the property is the same as the name of the value: {name, length}: func. Pattern matching is now allowed within comprehension variables. unless is now allowed in block form. until loops were added, as the inverse of while loops. switch statements are now allowed without switch object clauses. Compatible with Node.js v0.1.95.
    
+
    
+
    
   0.6.1
    — 
-
-      Upgraded CoffeeScript for compatibility with the new Node.js v0.1.90
-      series.
-    
    
-
-    
    
-      
    
-
+
    Upgraded CoffeeScript for compatibility with the new Node.js v0.1.90 series.
    
+
    
+
    
   0.6.0
    — 
-
-      Trailing commas are now allowed, a-la Python. Static
-      properties may be assigned directly within class definitions,
-      using @property notation.
-    
    
-
-    
    
-      
    
-
+
    Trailing commas are now allowed, a-la Python. Static properties may be assigned directly within class definitions, using @property notation.
    
+
    
+
    
   0.5.6
    — 
-
-      Interpolation can now be used within regular expressions and heredocs, as well as
-      strings. Added the <- bind operator.
-      Allowing assignment to half-expressions instead of special ||=-style
-      operators. The arguments object is no longer automatically converted into
-      an array. After requiring coffee-script, Node.js can now directly
-      load .coffee files, thanks to registerExtension. Multiple
-      splats can now be used in function calls, arrays, and pattern matching.
-    
    
-
-    
    
-      
    
-
+
    Interpolation can now be used within regular expressions and heredocs, as well as strings. Added the <- bind operator. Allowing assignment to half-expressions instead of special ||=-style operators. The arguments object is no longer automatically converted into an array. After requiring coffee-script, Node.js can now directly load .coffee files, thanks to registerExtension. Multiple splats can now be used in function calls, arrays, and pattern matching.
    
+
    
+
    
   0.5.5
    — 
-
-      String interpolation, contributed by
-      Stan Angeloff.
-      Since --run has been the default since 0.5.3, updating
-      --stdio and --eval to run by default, pass --compile
-      as well if you’d like to print the result.
-    
    
-
-    
    
-      
    
-
+
    String interpolation, contributed by Stan Angeloff. Since --run has been the default since 0.5.3, updating --stdio and --eval to run by default, pass --compile as well if you’d like to print the result.
    
+
    
+
    
   0.5.4
    — 
-
-      Bugfix that corrects the Node.js global constants __filename and
-      __dirname. Tweaks for more flexible parsing of nested function
-      literals and improperly-indented comments. Updates for the latest Node.js API.
-    
    
-
-    
    
-      
    
-
+
    Bugfix that corrects the Node.js global constants __filename and __dirname. Tweaks for more flexible parsing of nested function literals and improperly-indented comments. Updates for the latest Node.js API.
    
+
    
+
    
   0.5.3
    — 
-
-      CoffeeScript now has a syntax for defining classes. Many of the core
-      components (Nodes, Lexer, Rewriter, Scope, Optparse) are using them.
-      Cakefiles can use optparse.coffee to define options for tasks.
-      --run is now the default flag for the coffee command,
-      use --compile to save JavaScripts. Bugfix for an ambiguity between
-      RegExp literals and chained divisions.
-    
    
-
-    
    
-      
    
-
+
    CoffeeScript now has a syntax for defining classes. Many of the core components (Nodes, Lexer, Rewriter, Scope, Optparse) are using them. Cakefiles can use optparse.coffee to define options for tasks. --run is now the default flag for the coffee command, use --compile to save JavaScripts. Bugfix for an ambiguity between RegExp literals and chained divisions.
    
+
    
+
    
   0.5.2
    — 
-
-      Added a compressed version of the compiler for inclusion in web pages as
-      
    v1/browser-compiler/coffee-script.js. It’ll automatically run any script tags
-      with type text/coffeescript for you. Added a --stdio option
-      to the coffee command, for piped-in compiles.
-    
    
-
-
-    
    
-      
    
-
+
    Added a compressed version of the compiler for inclusion in web pages as
+v1/browser-compiler/coffee-script.js. It’ll automatically run any script tags with type text/coffeescript for you. Added a --stdio option to the coffee command, for piped-in compiles.
    
+
    
+
    
   0.5.1
    — 
-
-      Improvements to null soaking with the existential operator, including
-      soaks on indexed properties. Added conditions to while loops,
-      so you can use them as filters with when, in the same manner as
-      comprehensions.
-    
    
-
-    
    
-      
    
-
+
    Improvements to null soaking with the existential operator, including soaks on indexed properties. Added conditions to while loops, so you can use them as filters with when, in the same manner as comprehensions.
    
+
    
+
    
   0.5.0
    — 
-
-      CoffeeScript 0.5.0 is a major release, While there are no language changes,
-      the Ruby compiler has been removed in favor of a self-hosting
-      compiler written in pure CoffeeScript.
-    
    
-
-    
    
-      
    
-
+
    CoffeeScript 0.5.0 is a major release, While there are no language changes, the Ruby compiler has been removed in favor of a self-hosting compiler written in pure CoffeeScript.
    
+
    
+
    
   0.3.2
    — 
-
-      @property is now a shorthand for this.property.
    
-      Switched the default JavaScript engine from Narwhal to Node.js. Pass
-      the --narwhal flag if you’d like to continue using it.
-    
    
-
-    
    
-      
    
-
+
    @property is now a shorthand for this.property.
+Switched the default JavaScript engine from Narwhal to Node.js. Pass the --narwhal flag if you’d like to continue using it.
    
+
    
+
    
   0.3.0
    — 
-
-      CoffeeScript 0.3 includes major syntax changes:
-      
    
-      The function symbol was changed to
-      ->, and the bound function symbol is now =>.
-      
    
-      Parameter lists in function definitions must now be wrapped in parentheses.
-      
    
-      Added property soaking, with the ?. operator.
-      
    
-      Made parentheses optional, when invoking functions with arguments.
-      
    
-      Removed the obsolete block literal syntax.
-    
    
-
-    
    
-      
    
-
+
    CoffeeScript 0.3 includes major syntax changes:
+The function symbol was changed to ->, and the bound function symbol is now =>.
+Parameter lists in function definitions must now be wrapped in parentheses.
+Added property soaking, with the ?. operator.
+Made parentheses optional, when invoking functions with arguments.
+Removed the obsolete block literal syntax.
    
+
    
+
    
   0.2.6
    — 
-
-      Added Python-style chained comparisons, the conditional existence
-      operator ?=, and some examples from Beautiful Code.
-      Bugfixes relating to statement-to-expression conversion, arguments-to-array
-      conversion, and the TextMate syntax highlighter.
-    
    
-
-    
    
-      
    
-
+
    Added Python-style chained comparisons, the conditional existence operator ?=, and some examples from Beautiful Code. Bugfixes relating to statement-to-expression conversion, arguments-to-array conversion, and the TextMate syntax highlighter.
    
+
    
+
    
   0.2.5
    — 
-
-      The conditions in switch statements can now take multiple values at once —
-      If any of them are true, the case will run. Added the long arrow ==>,
-      which defines and immediately binds a function to this. While loops can
-      now be used as expressions, in the same way that comprehensions can. Splats
-      can be used within pattern matches to soak up the rest of an array.
-    
    
-
-    
    
-      
    
-
+
    The conditions in switch statements can now take multiple values at once — If any of them are true, the case will run. Added the long arrow ==>, which defines and immediately binds a function to this. While loops can now be used as expressions, in the same way that comprehensions can. Splats can be used within pattern matches to soak up the rest of an array.
    
+
    
+
    
   0.2.4
    — 
-
-      Added ECMAScript Harmony style destructuring assignment, for dealing with
-      extracting values from nested arrays and objects. Added indentation-sensitive
-      heredocs for nicely formatted strings or chunks of code.
-    
    
-
-    
    
-      
    
-
+
    Added ECMAScript Harmony style destructuring assignment, for dealing with extracting values from nested arrays and objects. Added indentation-sensitive heredocs for nicely formatted strings or chunks of code.
    
+
    
+
    
   0.2.3
    — 
-
-      Axed the unsatisfactory ino keyword, replacing it with of for
-      object comprehensions. They now look like: for prop, value of object.
-    
    
-
-    
    
-      
    
-
+
    Axed the unsatisfactory ino keyword, replacing it with of for object comprehensions. They now look like: for prop, value of object.
    
+
    
+
    
   0.2.2
    — 
-
-      When performing a comprehension over an object, use ino, instead
-      of in, which helps us generate smaller, more efficient code at
-      compile time.
-      
    
-      Added :: as a shorthand for saying .prototype.
-      
    
-      The “splat” symbol has been changed from a prefix asterisk *, to
-      a postfix ellipsis ...
-      
    
-      Added JavaScript’s in operator,
-      empty return statements, and empty while loops.
-      
    
-      Constructor functions that start with capital letters now include a
-      safety check to make sure that the new instance of the object is returned.
-      
    
-      The extends keyword now functions identically to goog.inherits
-      in Google’s Closure Library.
-    
    
-
-    
    
-      
    
-
+
    When performing a comprehension over an object, use ino, instead of in, which helps us generate smaller, more efficient code at compile time.
+Added :: as a shorthand for saying .prototype.
+The “splat” symbol has been changed from a prefix asterisk *, to a postfix ellipsis ...
+Added JavaScript’s in operator, empty return statements, and empty while loops.
+Constructor functions that start with capital letters now include a safety check to make sure that the new instance of the object is returned.
+The extends keyword now functions identically to goog.inherits in Google’s Closure Library.
    
+
    
+
    
   0.2.1
    — 
-
-      Arguments objects are now converted into real arrays when referenced.
-    
    
-
-    
    
-      
    
-
+
    Arguments objects are now converted into real arrays when referenced.
    
+
    
+
    
   0.2.0
    — 
-
-      Major release. Significant whitespace. Better statement-to-expression
-      conversion. Splats. Splice literals. Object comprehensions. Blocks.
-      The existential operator. Many thanks to all the folks who posted issues,
-      with special thanks to
-      Liam O’Connor-Davis for whitespace
-      and expression help.
-    
    
-
-    
    
-      
    
-
+
    Major release. Significant whitespace. Better statement-to-expression conversion. Splats. Splice literals. Object comprehensions. Blocks. The existential operator. Many thanks to all the folks who posted issues, with special thanks to Liam O’Connor-Davis for whitespace and expression help.
    
+
    
+
    
   0.1.6
    — 
-
-      Bugfix for running coffee --interactive and --run
-      from outside of the CoffeeScript directory. Bugfix for nested
-      function/if-statements.
-    
    
-
-    
    
-      
    
-
+
    Bugfix for running coffee --interactive and --run from outside of the CoffeeScript directory. Bugfix for nested function/if-statements.
    
+
    
+
    
   0.1.5
    — 
-
-      Array slice literals and array comprehensions can now both take Ruby-style
-      ranges to specify the start and end. JavaScript variable declaration is
-      now pushed up to the top of the scope, making all assignment statements into
-      expressions. You can use \ to escape newlines.
-      The coffee-script command is now called coffee.
-    
    
-
-    
    
-      
    
-
+
    Array slice literals and array comprehensions can now both take Ruby-style ranges to specify the start and end. JavaScript variable declaration is now pushed up to the top of the scope, making all assignment statements into expressions. You can use \ to escape newlines. The coffee-script command is now called coffee.
    
+
    
+
    
   0.1.4
    — 
-
-      The official CoffeeScript extension is now .coffee instead of
-      .cs, which properly belongs to
-      C#.
-      Due to popular demand, you can now also use = to assign. Unlike
-      JavaScript, = can also be used within object literals, interchangeably
-      with :. Made a grammatical fix for chained function calls
-      like func(1)(2)(3)(4). Inheritance and super no longer use
-      __proto__, so they should be IE-compatible now.
-    
    
-
-    
    
-      
    
-
+
    The official CoffeeScript extension is now .coffee instead of .cs, which properly belongs to C#). Due to popular demand, you can now also use = to assign. Unlike JavaScript, = can also be used within object literals, interchangeably with :. Made a grammatical fix for chained function calls like func(1)(2)(3)(4). Inheritance and super no longer use __proto__, so they should be IE-compatible now.
    
+
    
+
    
   0.1.3
    — 
-
-      The coffee command now includes --interactive,
-      which launches an interactive CoffeeScript session, and --run,
-      which directly compiles and executes a script. Both options depend on a
-      working installation of Narwhal.
-      The aint keyword has been replaced by isnt, which goes
-      together a little smoother with is.
-      Quoted strings are now allowed as identifiers within object literals: eg.
-      {"5+5": 10}.
-      All assignment operators now use a colon: +:, -:,
-      *:, etc.
-    
    
-
-    
    
-      
    
-
+
    The coffee command now includes --interactive, which launches an interactive CoffeeScript session, and --run, which directly compiles and executes a script. Both options depend on a working installation of Narwhal. The aint keyword has been replaced by isnt, which goes together a little smoother with is. Quoted strings are now allowed as identifiers within object literals: eg. {"5+5": 10}. All assignment operators now use a colon: +:, -:, *:, etc.
    
+
    
+
    
   0.1.2
    — 
-
-      Fixed a bug with calling super() through more than one level of
-      inheritance, with the re-addition of the extends keyword.
-      Added experimental Narwhal
-      support (as a Tusk package), contributed by
-      Tom Robinson, including
-      bin/cs as a CoffeeScript REPL and interpreter.
-      New --no-wrap option to suppress the safety function
-      wrapper.
-    
    
-
-    
    
-      
    
-
+
    Fixed a bug with calling super() through more than one level of inheritance, with the re-addition of the extends keyword. Added experimental Narwhal support (as a Tusk package), contributed by Tom Robinson, including bin/cs as a CoffeeScript REPL and interpreter. New --no-wrap option to suppress the safety function wrapper.
    
+
    
+
    
   0.1.1
    — 
-
-      Added instanceof and typeof as operators.
-    
    
-
-    
    
-      
    
-
+
    Added instanceof and typeof as operators.
    
+
    
+
    
   0.1.0
    — 
-
-      Initial CoffeeScript release.
-    
    
+
    Initial CoffeeScript release.
    
 
-  
    
+
    
 
-  
+compileSource()
 
-  
-  
+
+
+
+
 
 
 
diff --git a/docs/v1/test.html b/docs/v1/test.html
index 2a332e8e..daf436a1 100644
--- a/docs/v1/test.html
+++ b/docs/v1/test.html
@@ -102,6 +102,8 @@ arrayEgal = (a, b) ->
     if err
       if typeof err is 'function' and e instanceof err # Handle comparing exceptions
         ok yes
+      else if e.toString().indexOf('[stdin]') is 0 # Handle comparing error messages
+        ok err e
       else
         eq e, err
     else
@@ -3410,6 +3412,1201 @@ test "#4267: lots of for-loops in the same scope", ->
   """
   ok CoffeeScript.eval(code)
 
+
+
 
-
-  
-  
+<%= include('body.html') %>
 
+<%= include('scripts.html') %>
 
 
diff --git a/documentation/sections/books.md b/documentation/sections/books.md
new file mode 100644
index 00000000..22abdb9d
--- /dev/null
+++ b/documentation/sections/books.md
@@ -0,0 +1,13 @@
+## 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](http://arcturo.github.com/library/coffeescript/) is a brief 5-chapter introduction to CoffeeScript, written with great clarity and precision by [Alex MacCaw](http://alexmaccaw.co.uk/).
+*   [Smooth CoffeeScript](http://autotelicum.github.com/Smooth-CoffeeScript/) is a reimagination of the excellent book [Eloquent JavaScript](http://eloquentjavascript.net/), 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](https://github.com/autotelicum).
+*   [CoffeeScript: Accelerated JavaScript Development](http://pragprog.com/book/tbcoffee/coffeescript) is [Trevor Burnham](http://trevorburnham.com/)’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](http://www.packtpub.com/coffeescript-programming-with-jquery-rails-nodejs/book) 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-side (Rails, Node).
+*   [CoffeeScript Ristretto](https://leanpub.com/coffeescript-ristretto/read) 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](http://braythwayt.com/).
+*   [Testing with CoffeeScript](https://efendibooks.com/minibooks/testing-with-coffeescript) is a succinct and freely downloadable guide to building testable applications with CoffeeScript and Jasmine.
+*   [CoffeeScript Application Development](http://www.packtpub.com/coffeescript-application-development/book) from Packt, introduces CoffeeScript while walking through the process of building a demonstration web application. A [CoffeeScript Application Development Coookbook](https://www.packtpub.com/web-development/coffeescript-application-development-cookbook) with over 90 “recipes” is also available.
+*   [CoffeeScript in Action](http://www.manning.com/lee/) from Manning Publications, covers CoffeeScript syntax, composition techniques and application development.
+*   [CoffeeScript: Die Alternative zu JavaScript](http://www.dpunkt.de/buecher/4021/coffeescript.html) from dpunkt.verlag, is the first CoffeeScript book in Deutsch.
diff --git a/documentation/sections/cake.md b/documentation/sections/cake.md
new file mode 100644
index 00000000..0af075f4
--- /dev/null
+++ b/documentation/sections/cake.md
@@ -0,0 +1,11 @@
+## Cake, and Cakefiles
+
+CoffeeScript includes a (very) simple build system similar to [Make](http://www.gnu.org/software/make/) and [Rake](http://rake.rubyforge.org/). 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:
+
+```
+codeFor('cake_tasks')
+```
+
+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](v<%= majorVersion %>/annotated-source/cake.html). If you need dependencies, or async callbacks, it’s best to put them in your code itself — not the cake task.
diff --git a/documentation/sections/changelog.md b/documentation/sections/changelog.md
new file mode 100644
index 00000000..dcdf648a
--- /dev/null
+++ b/documentation/sections/changelog.md
@@ -0,0 +1,508 @@
+## Change Log
+
+```
+releaseHeader('2016-12-07', '1.12.1', '1.12.0')
+```
+
+*   You can now import a module member named `default`, e.g. `import { default } from 'lib'`. Though like in ES2015, you cannot import an entire module and name it `default` (so `import default from 'lib'` is not allowed).
+*   Fix regression where `from` as a variable name was breaking `for` loop declarations. For the record, `from` is not a reserved word in CoffeeScript; you may use it for variable names. `from` behaves like a keyword within the context of `import` and `export` statements, and in the declaration of a `for` loop; though you should also be able to use variables named `from` in those contexts, and the compiler should be able to tell the difference.
+
+```
+releaseHeader('2016-12-04', '1.12.0', '1.11.1')
+```
+
+*   CoffeeScript now supports ES2015 [tagged template literals](#tagged-template-literals). Note that using tagged template literals in your code makes you responsible for ensuring that either your runtime supports tagged template literals or that you transpile the output JavaScript further to a version your target runtime(s) support.
+*   CoffeeScript now provides a [`for…from`](#generator-iteration) syntax for outputting ES2015 [`for…of`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for...of). (Sorry they couldn’t match, but we came up with `for…of` first for something else.) This allows iterating over generators or any other iterable object. Note that using `for…from` in your code makes you responsible for ensuring that either your runtime supports `for…of` or that you transpile the output JavaScript further to a version your target runtime(s) support.
+*   Triple backticks (`` ```​``) allow the creation of embedded JavaScript blocks where escaping single backticks is not required, which should improve interoperability with ES2015 template literals and with Markdown.
+*   Within single-backtick embedded JavaScript, backticks can now be escaped via `` \`​``.
+*   The browser tests now run in the browser again, and are accessible [here](v<%= majorVersion %>/test.html) if you would like to test your browser.
+*   CoffeeScript-only keywords in ES2015 `import`s and `export`s are now ignored.
+*   The compiler now throws an error on trying to export an anonymous class.
+*   Bugfixes related to tokens and location data, for better source maps and improved compatibility with downstream tools.
+
+```
+releaseHeader('2016-10-02', '1.11.1', '1.11.0')
+```
+
+*   Bugfix for shorthand object syntax after interpolated keys.
+*   Bugfix for indentation-stripping in `"""` strings.
+*   Bugfix for not being able to use the name “arguments” for a prototype property of class.
+*   Correctly compile large hexadecimal numbers literals to `2e308` (just like all other large number literals do).
+
+```
+releaseHeader('2016-09-24', '1.11.0', '1.10.0')
+```
+
+*   CoffeeScript now supports ES2015 [`import` and `export` syntax](#modules).
+*   Added the `-M, --inline-map` flag to the compiler, allowing you embed the source map directly into the output JavaScript, rather than as a separate file.
+*   A bunch of fixes for `yield`:
+
+    *   `yield return` can no longer mistakenly be used as an expression.
+    *   `yield` now mirrors `return` in that it can be used stand-alone as well as with expressions. Where you previously wrote `yield undefined`, you may now write simply `yield`. However, this means also inheriting the same syntax limitations that `return` has, so these examples no longer compile:
+        ```
+        doubles = ->
+          yield for i in [1..3]
+            i * 2
+        six = ->
+          yield
+            2 * 3
+        ```
+
+    *   The JavaScript output is a bit nicer, with unnecessary parentheses and spaces, double indentation and double semicolons around `yield` no longer present.
+*   `&&=`, `||=`, `and=` and `or=` no longer accidentally allow a space before the equals sign.
+*   Improved several error messages.
+*   Just like `undefined` compiles to `void 0`, `NaN` now compiles into `0/0` and `Infinity` into `2e308`.
+*   Bugfix for renamed destructured parameters with defaults. `({a: b = 1}) ->` no longer crashes the compiler.
+*   Improved the internal representation of a CoffeeScript program. This is only noticeable to tools that use `CoffeeScript.tokens` or `CoffeeScript.nodes`. Such tools need to update to take account for changed or added tokens and nodes.
+*   Several minor bug fixes, including:
+
+    *   The caught error in `catch` blocks is no longer declared unnecessarily, and no longer mistakenly named `undefined` for `catch`-less `try` blocks.
+    *   Unassignable parameter destructuring no longer crashes the compiler.
+    *   Source maps are now used correctly for errors thrown from .coffee.md files.
+    *   `coffee -e 'throw null'` no longer crashes.
+    *   The REPL no longer crashes when using `.exit` to exit it.
+    *   Invalid JavaScript is no longer output when lots of `for` loops are used in the same scope.
+    *   A unicode issue when using stdin with the CLI.
+
+```
+releaseHeader('2015-09-03', '1.10.0', '1.9.3')
+```
+
+*   CoffeeScript now supports ES2015-style destructuring defaults.
+*   `(offsetHeight: height) ->` no longer compiles. That syntax was accidental and partly broken. Use `({offsetHeight: height}) ->` instead. Object destructuring always requires braces.
+*   Several minor bug fixes, including:
+
+    *   A bug where the REPL would sometimes report valid code as invalid, based on what you had typed earlier.
+    *   A problem with multiple JS contexts in the jest test framework.
+    *   An error in io.js where strict mode is set on internal modules.
+    *   A variable name clash for the caught error in `catch` blocks.
+
+```
+releaseHeader('2015-05-27', '1.9.3', '1.9.2')
+```
+
+*   Bugfix for interpolation in the first key of an object literal in an implicit call.
+*   Fixed broken error messages in the REPL, as well as a few minor bugs with the REPL.
+*   Fixed source mappings for tokens at the beginning of lines when compiling with the `--bare` option. This has the nice side effect of generating smaller source maps.
+*   Slight formatting improvement of compiled block comments.
+*   Better error messages for `on`, `off`, `yes` and `no`.
+
+```
+releaseHeader('2015-04-15', '1.9.2', '1.9.1')
+```
+
+*   Fixed a **watch** mode error introduced in 1.9.1 when compiling multiple files with the same filename.
+*   Bugfix for `yield` around expressions containing `this`.
+*   Added a Ruby-style `-r` option to the REPL, which allows requiring a module before execution with `--eval` or `--interactive`.
+*   In `"
+    load   = if showLoad then "
    load
    " else ''
+    button = if executable then """
    #{run}
    """ else ''
+    "
    #{cshtml}#{jshtml}#{script}#{load}#{button}
    "
diff --git a/documentation/v1/docs.coffee b/documentation/v1/docs.coffee
new file mode 100644
index 00000000..104b8e94
--- /dev/null
+++ b/documentation/v1/docs.coffee
@@ -0,0 +1,92 @@
+sourceFragment = "try:"
+
+# Set up the compilation function, to run when you stop typing.
+compileSource = ->
+  source = $('#repl_source').val()
+  results = $('#repl_results')
+  window.compiledJS = ''
+  try
+    window.compiledJS = CoffeeScript.compile source, bare: on
+    el = results[0]
+    if el.innerText
+      el.innerText = window.compiledJS
+    else
+      results.text(window.compiledJS)
+    results.removeClass 'error'
+    $('.minibutton.run').removeClass 'error'
+  catch {location, message}
+    if location?
+      message = "Error on line #{location.first_line + 1}: #{message}"
+    results.text(message).addClass 'error'
+    $('.minibutton.run').addClass 'error'
+
+  # Update permalink
+  $('#repl_permalink').attr 'href', "##{sourceFragment}#{encodeURIComponent source}"
+
+# Listen for keypresses and recompile.
+$('#repl_source').keyup -> compileSource()
+
+# Use tab key to insert tabs
+$('#repl_source').keydown (e) ->
+  if e.keyCode is 9
+    e.preventDefault()
+    textbox = e.target
+    # Insert tab character at caret or in selection
+    textbox.value = textbox.value[0...textbox.selectionStart] + "\t" + textbox.value[textbox.selectionEnd...]
+    # Put caret in correct position
+    textbox.selectionEnd = ++textbox.selectionStart
+
+# Eval the compiled js.
+evalJS = ->
+  try
+    eval window.compiledJS
+  catch error then alert error
+
+# Load the console with a string of CoffeeScript.
+window.loadConsole = (coffee) ->
+  $('#repl_source').val coffee
+  compileSource()
+  $('.navigation.try').addClass('active')
+  false
+
+# Helper to hide the menus.
+closeMenus = ->
+  $('.navigation.active').removeClass 'active'
+
+$('.minibutton.run').click -> evalJS()
+
+# Bind navigation buttons to open the menus.
+$('.navigation').click (e) ->
+  return if e.target.tagName.toLowerCase() is 'a'
+  return false if $(e.target).closest('.repl_wrapper').length
+  if $(this).hasClass('active')
+    closeMenus()
+  else
+    closeMenus()
+    $(this).addClass 'active'
+  false
+
+# Dismiss console if Escape pressed or click falls outside console
+# Trigger Run button on Ctrl-Enter
+$(document.body)
+  .keydown (e) ->
+    closeMenus() if e.which == 27
+    evalJS() if e.which == 13 and (e.metaKey or e.ctrlKey) and $('.minibutton.run:visible').length
+  .click (e) ->
+    return false if $(e.target).hasClass('minibutton')
+    closeMenus()
+
+$('#open_webchat').click ->
+  $(this).replaceWith $('')
+
+$("#repl_permalink").click (e) ->
+    window.location = $(this).attr("href")
+    false
+
+# If source code is included in location.hash, display it.
+hash = decodeURIComponent location.hash.replace(/^#/, '')
+if hash.indexOf(sourceFragment) == 0
+    src = hash.substr sourceFragment.length
+    loadConsole src
+
+compileSource()
diff --git a/documentation/css/docs.css b/documentation/v1/docs.css
similarity index 99%
rename from documentation/css/docs.css
rename to documentation/v1/docs.css
index 733988e6..9384983e 100644
--- a/documentation/css/docs.css
+++ b/documentation/v1/docs.css
@@ -18,12 +18,17 @@ a {
   color: #191933;
 }
 h1, h2, h3, h4, h5, h6, b.header {
-  font-size: 18px;
   color: #000;
   margin-top: 40px;
   margin-bottom: 15px;
   text-shadow: #fff 0 1px 1px;
 }
+h2 {
+  font-size: 18px;
+}
+h3 {
+  font-size: 14px;
+}
 br.clear {
   height: 0;
   clear: both;
@@ -57,7 +62,11 @@ table.definitions {
     text-align: center;
     padding: 5px 20px;
   }
-code, pre, textarea {
+blockquote {
+  margin-left: 0;
+  margin-right: 0;
+}
+code, pre, pre > code, textarea {
   font-family: Monaco, Consolas, "Lucida Console", monospace;
   font-size: 12px;
   line-height: 18px;
@@ -71,16 +80,12 @@ code, pre, textarea {
     border: 1px solid #dedede;
     padding: 0px 0.2em;
   }
-  pre {
+  blockquote > pre {
+    margin: 0;
     border-left: 5px solid rgba(0,0,0,0.2);
     padding: 3px 0 3px 12px;
     font-size: 12px;
   }
-    pre.no_bar {
-      border-left: 0;
-      margin-left: 0;
-      padding-left: 0;
-    }
 .timestamp {
   font-size: 11px;
   font-weight: normal;
diff --git a/documentation/v1/scripts.html b/documentation/v1/scripts.html
new file mode 100644
index 00000000..3793aa8a
--- /dev/null
+++ b/documentation/v1/scripts.html
@@ -0,0 +1,6 @@
+
+
+
+
diff --git a/documentation/v1/styles.html b/documentation/v1/styles.html
new file mode 100644
index 00000000..1221b91b
--- /dev/null
+++ b/documentation/v1/styles.html
@@ -0,0 +1,4 @@
+
diff --git a/documentation/css/tomorrow.css b/documentation/v1/tomorrow.css
similarity index 87%
rename from documentation/css/tomorrow.css
rename to documentation/v1/tomorrow.css
index 243efbb5..e0048cd6 100644
--- a/documentation/css/tomorrow.css
+++ b/documentation/v1/tomorrow.css
@@ -1,6 +1,6 @@
+/* Highlight.js syntax highlighting */
 /* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
-/* Original code:; http://softwaremaniacs.org/media/soft/highlight/styles/tomorrow.css */
-/* But forked for CoffeeScript */
+/* Forked from http://softwaremaniacs.org/media/soft/highlight/styles/tomorrow.css */
 .tomorrow-comment, pre .comment, pre .title {
   color: #8e908c;
 }
@@ -49,12 +49,6 @@ pre .class .title {
   color: #21439C;
 }
 
-pre code {
-  display: block;
-  background: white;
-  color: #000000;
-}
-
 pre .coffeescript .javascript,
 pre .javascript .xml,
 pre .tex .formula,
diff --git a/package.json b/package.json
index bf5ab1b1..5b16fdf1 100644
--- a/package.json
+++ b/package.json
@@ -40,9 +40,10 @@
   },
   "devDependencies": {
     "docco": "~0.7.0",
-    "google-closure-compiler-js": "^20161024.0.0",
-    "highlight.js": "~9.8.0",
+    "google-closure-compiler-js": "^20161201.0.0",
+    "highlight.js": "~9.9.0",
     "jison": ">=0.4.17",
+    "marked": "^0.3.6",
     "underscore": "~1.8.3"
   }
 }