2009-12-21 11:41:45 -05:00
|
|
|
<%
|
|
|
|
|
require 'uv'
|
2010-12-12 21:41:04 -05:00
|
|
|
require 'json'
|
|
|
|
|
@counter = 0
|
2009-12-21 11:41:45 -05:00
|
|
|
def code_for(file, executable=false)
|
2010-12-12 21:41:04 -05:00
|
|
|
@counter += 1
|
2009-12-23 19:42:18 -05:00
|
|
|
return '' unless File.exists?("documentation/js/#{file}.js")
|
2009-12-25 17:18:05 -05:00
|
|
|
cs = File.read("documentation/coffee/#{file}.coffee")
|
2010-07-29 00:51:35 -04:00
|
|
|
js = File.read("documentation/js/#{file}.js")
|
2009-12-21 11:41:45 -05:00
|
|
|
cshtml = Uv.parse(cs, 'xhtml', 'coffeescript', false, 'idle', false)
|
|
|
|
|
jshtml = Uv.parse(js, 'xhtml', 'javascript', false, 'idle', false)
|
|
|
|
|
append = executable == true ? '' : "alert(#{executable});"
|
|
|
|
|
run = executable == true ? 'run' : "run: #{executable}"
|
2010-12-12 21:41:04 -05:00
|
|
|
name = "example#{@counter}"
|
|
|
|
|
script = "<script>window.#{name} = #{cs.to_json}</script>"
|
|
|
|
|
import = "<div class='minibutton load' onclick='javascript: loadConsole(#{name});'>Load</div>"
|
|
|
|
|
button = executable ? "<div class='minibutton ok' onclick='javascript: #{js};#{append}'>#{run}</div>" : ''
|
|
|
|
|
"<div class='code'>#{cshtml}#{jshtml}#{script}#{import}#{button}<br class='clear' /></div>"
|
2009-12-21 11:41:45 -05:00
|
|
|
end
|
|
|
|
|
%>
|
|
|
|
|
|
|
|
|
|
|
2009-12-19 22:55:58 -05:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
|
2009-12-23 20:24:55 -05:00
|
|
|
<title>CoffeeScript</title>
|
2009-12-21 11:41:45 -05:00
|
|
|
<link rel="stylesheet" type="text/css" href="documentation/css/docs.css" />
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="documentation/css/idle.css" />
|
2010-02-27 02:21:26 -05:00
|
|
|
<link rel="shortcut icon" href="documentation/images/favicon.ico" />
|
2009-12-19 22:55:58 -05:00
|
|
|
</head>
|
2010-12-12 21:41:04 -05:00
|
|
|
<body>
|
2010-02-21 16:36:34 -05:00
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<div id="fadeout"></div>
|
|
|
|
|
|
|
|
|
|
<div id="flybar">
|
2010-02-21 16:13:09 -05:00
|
|
|
<a id="logo" href="#top"> </a>
|
2010-03-08 06:34:07 -05:00
|
|
|
<div class="navigation toc">
|
2010-02-21 14:30:21 -05:00
|
|
|
<div class="button">
|
|
|
|
|
Table of Contents
|
|
|
|
|
</div>
|
2010-12-12 21:41:04 -05:00
|
|
|
<div class="contents menu">
|
2010-11-21 19:53:31 -05:00
|
|
|
<a href="#overview">Overview</a>
|
2010-02-21 14:30:21 -05:00
|
|
|
<a href="#installation">Installation and Usage</a>
|
2010-02-21 16:13:09 -05:00
|
|
|
<a href="#language">Language Reference</a>
|
2010-02-21 14:30:21 -05:00
|
|
|
<a href="#whitespace">Significant Whitespace</a>
|
|
|
|
|
<a href="#functions">Functions and Invocation</a>
|
|
|
|
|
<a href="#objects_and_arrays">Objects and Arrays</a>
|
|
|
|
|
<a href="#lexical_scope">Lexical Scoping and Variable Safety</a>
|
2010-07-16 22:44:07 -04:00
|
|
|
<a href="#conditionals">If, Else, Unless, and Conditional Assignment</a>
|
2010-02-21 14:30:21 -05:00
|
|
|
<a href="#aliases">Aliases</a>
|
|
|
|
|
<a href="#splats">Splats...</a>
|
2010-06-28 01:00:53 -04:00
|
|
|
<a href="#while">While, Until, and Loop</a>
|
2010-02-21 14:30:21 -05:00
|
|
|
<a href="#comprehensions">Comprehensions (Arrays, Objects, and Ranges)</a>
|
2010-12-04 12:52:51 -05:00
|
|
|
<a href="#slices">Array Slicing and Splicing</a>
|
2010-02-21 14:30:21 -05:00
|
|
|
<a href="#expressions">Everything is an Expression</a>
|
|
|
|
|
<a href="#existence">The Existential Operator</a>
|
2010-02-27 20:12:47 -05:00
|
|
|
<a href="#classes">Classes, Inheritance, and Super</a>
|
2010-02-21 14:30:21 -05:00
|
|
|
<a href="#pattern_matching">Pattern Matching</a>
|
|
|
|
|
<a href="#fat_arrow">Function Binding</a>
|
|
|
|
|
<a href="#embedded">Embedded JavaScript</a>
|
2010-09-16 00:32:57 -04:00
|
|
|
<a href="#switch">The Switch Statement</a>
|
2010-02-21 14:30:21 -05:00
|
|
|
<a href="#try">Try/Catch/Finally</a>
|
|
|
|
|
<a href="#comparisons">Chained Comparisons</a>
|
2010-11-21 21:12:59 -05:00
|
|
|
<a href="#strings">String Interpolation, Heredocs, and Block Comments</a>
|
|
|
|
|
<a href="#regexes">Extended Regular Expressions</a>
|
2010-02-21 18:37:52 -05:00
|
|
|
<a href="#cake">Cake, and Cakefiles</a>
|
2010-02-25 00:26:59 -05:00
|
|
|
<a href="#scripts">"text/coffeescript" Script Tags</a>
|
2010-11-21 19:53:31 -05:00
|
|
|
<a href="#examples">Examples</a>
|
2010-02-21 14:30:21 -05:00
|
|
|
<a href="#resources">Resources</a>
|
2010-04-10 13:42:39 -04:00
|
|
|
<a href="#webchat">Web Chat (IRC)</a>
|
2010-02-21 14:30:21 -05:00
|
|
|
<a href="#change_log">Change Log</a>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2010-02-21 16:13:09 -05:00
|
|
|
<div class="navigation try">
|
|
|
|
|
<div class="button">
|
|
|
|
|
Try CoffeeScript
|
|
|
|
|
</div>
|
|
|
|
|
<div class="contents repl_wrapper">
|
2010-12-12 21:41:04 -05:00
|
|
|
<div class="repl_bridge"></div>
|
2010-02-21 16:13:09 -05:00
|
|
|
<div class="code">
|
2010-12-12 21:41:04 -05:00
|
|
|
<div class="screenshadow tl"></div>
|
|
|
|
|
<div class="screenshadow tr"></div>
|
|
|
|
|
<div class="screenshadow bl"></div>
|
|
|
|
|
<div class="screenshadow br"></div>
|
|
|
|
|
<div id="repl_source_wrap">
|
|
|
|
|
<textarea id="repl_source" rows="100">alert "Hello CoffeeScript!"</textarea>
|
|
|
|
|
</div>
|
2010-02-21 16:13:09 -05:00
|
|
|
<pre id="repl_results"></pre>
|
2010-12-12 21:41:04 -05:00
|
|
|
<div class="minibutton dark run">Run</div>
|
2010-02-21 16:13:09 -05:00
|
|
|
<br class="clear" />
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2010-03-08 06:34:07 -05:00
|
|
|
<div class="navigation annotated">
|
|
|
|
|
<div class="button">
|
|
|
|
|
Annotated Source
|
|
|
|
|
</div>
|
2010-12-12 21:41:04 -05:00
|
|
|
<div class="contents menu">
|
2010-03-08 09:13:15 -05:00
|
|
|
<a href="documentation/docs/grammar.html">Grammar Rules — src/grammar</a>
|
|
|
|
|
<a href="documentation/docs/lexer.html">Lexing Tokens — src/lexer</a>
|
2010-03-08 06:34:07 -05:00
|
|
|
<a href="documentation/docs/rewriter.html">The Rewriter — src/rewriter</a>
|
|
|
|
|
<a href="documentation/docs/nodes.html">The Syntax Tree — src/nodes</a>
|
|
|
|
|
<a href="documentation/docs/scope.html">Lexical Scope — src/scope</a>
|
2010-03-10 09:28:00 -05:00
|
|
|
<a href="documentation/docs/helpers.html">Helpers & Utility Functions — src/helpers</a>
|
2010-03-08 06:34:07 -05:00
|
|
|
<a href="documentation/docs/coffee-script.html">The CoffeeScript Module — src/coffee-script</a>
|
|
|
|
|
<a href="documentation/docs/cake.html">Cake & Cakefiles — src/cake</a>
|
|
|
|
|
<a href="documentation/docs/command.html">"coffee" Command-Line Utility — src/command</a>
|
|
|
|
|
<a href="documentation/docs/optparse.html">Option Parsing — src/optparse</a>
|
|
|
|
|
<a href="documentation/docs/repl.html">Interactive REPL — src/repl</a>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2010-02-25 20:48:54 -05:00
|
|
|
<div id="error" style="display:none;"></div>
|
2010-02-21 14:30:21 -05:00
|
|
|
</div>
|
2009-12-19 22:55:58 -05:00
|
|
|
|
|
|
|
|
<div class="container">
|
2010-02-21 16:13:09 -05:00
|
|
|
<span class="bookmark" id="top"></span>
|
2009-12-19 22:55:58 -05:00
|
|
|
|
|
|
|
|
<p>
|
2010-12-12 15:02:27 -05:00
|
|
|
<b>CoffeeScript is a little language that compiles into JavaScript.</b> Underneath
|
2010-11-21 12:38:27 -05:00
|
|
|
all of those embarrassing braces and semicolons, JavaScript has always had
|
2010-11-21 21:12:59 -05:00
|
|
|
a gorgeous object model at its heart. CoffeeScript is an attempt to expose
|
2010-11-21 12:38:27 -05:00
|
|
|
the good parts of JavaScript in a simple way.
|
2009-12-21 11:41:45 -05:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
2010-11-21 12:38:27 -05:00
|
|
|
The golden rule of CoffeeScript is: <i>"It's just JavaScript"</i>. The code
|
|
|
|
|
compiles one-to-one into the equivalent JS, and there is
|
2010-11-21 21:12:59 -05:00
|
|
|
no interpretation at runtime. You can use any existing JavaScript library
|
|
|
|
|
seamlessly (and vice-versa). The compiled output is readable and pretty-printed,
|
|
|
|
|
passes through <a href="http://www.javascriptlint.com/">JavaScript Lint</a>
|
2010-12-12 15:02:27 -05:00
|
|
|
without warnings, and runs in every JavaScript implementation.
|
2009-12-21 11:41:45 -05:00
|
|
|
</p>
|
2010-01-04 22:19:45 -05:00
|
|
|
|
2010-01-04 19:15:24 -05:00
|
|
|
<p>
|
|
|
|
|
<b>Latest Version:</b>
|
2010-12-07 00:21:34 -05:00
|
|
|
<a href="http://github.com/jashkenas/coffee-script/tarball/0.9.6">0.9.6</a>
|
2010-01-04 19:15:24 -05:00
|
|
|
</p>
|
2009-12-21 11:41:45 -05:00
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<h2>
|
|
|
|
|
<span id="overview" class="bookmark"></span>
|
2010-11-21 12:38:27 -05:00
|
|
|
Overview
|
2010-02-21 14:30:21 -05:00
|
|
|
</h2>
|
2009-12-23 19:42:18 -05:00
|
|
|
|
|
|
|
|
<p><i>CoffeeScript on the left, compiled JavaScript output on the right.</i></p>
|
|
|
|
|
|
2010-06-28 00:19:58 -04:00
|
|
|
<%= code_for('overview', 'cubes') %>
|
2010-01-04 23:26:27 -05:00
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<h2>
|
|
|
|
|
<span id="installation" class="bookmark"></span>
|
|
|
|
|
Installation and Usage
|
|
|
|
|
</h2>
|
2009-12-25 01:29:30 -05:00
|
|
|
|
2009-12-24 03:12:07 -05:00
|
|
|
<p>
|
2010-11-21 21:12:59 -05:00
|
|
|
The CoffeeScript compiler
|
2010-11-21 19:53:31 -05:00
|
|
|
<a href="documentation/docs/grammar.html">is itself written in CoffeeScript</a>,
|
|
|
|
|
using the <a href="http://jison.org">Jison parser generator</a>. The command-line
|
2010-11-21 21:12:59 -05:00
|
|
|
version of <tt>coffee</tt> is available as a <a href="http://nodejs.org/">Node.js</a> utility.
|
|
|
|
|
The core compiler however, does not depend on Node, and can be run in any
|
2010-11-21 19:53:31 -05:00
|
|
|
JavaScript environment, or in the browser (see "Try CoffeeScript", above).
|
2010-02-21 17:30:41 -05:00
|
|
|
</p>
|
2010-02-21 18:37:52 -05:00
|
|
|
|
2010-02-21 17:30:41 -05:00
|
|
|
<p>
|
2010-12-15 23:20:32 -05:00
|
|
|
To install, first make sure you have a working copy of the latest stable version of
|
2010-11-21 21:12:59 -05:00
|
|
|
<a href="http://nodejs.org/">Node.js</a>, and <a href="http://npmjs.org">NPM</a>
|
2010-11-21 19:53:31 -05:00
|
|
|
(the Node Package Manager). You can then install CoffeeScript with NPM:
|
2010-06-28 01:06:53 -04:00
|
|
|
</p>
|
2010-07-17 10:28:06 -04:00
|
|
|
|
2010-06-28 01:06:53 -04:00
|
|
|
<pre>
|
2010-11-16 14:44:24 -05:00
|
|
|
npm install coffee-script</pre>
|
2010-06-28 01:06:53 -04:00
|
|
|
|
2010-11-21 19:53:31 -05:00
|
|
|
<p>
|
2010-11-21 21:12:59 -05:00
|
|
|
If you'd prefer to install the latest master version of CoffeeScript, you
|
2010-11-21 19:53:31 -05:00
|
|
|
can clone the CoffeeScript
|
|
|
|
|
<a href="http://github.com/jashkenas/coffee-script">source repository</a>
|
|
|
|
|
from GitHub, or download
|
|
|
|
|
<a href="http://github.com/jashkenas/coffee-script/tarball/master">the source</a> directly.
|
|
|
|
|
To install the CoffeeScript compiler system-wide
|
|
|
|
|
under <tt>/usr/local</tt>, open the directory and run:
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
|
sudo bin/cake install</pre>
|
2010-11-21 21:12:59 -05:00
|
|
|
|
2010-12-21 14:25:28 -05:00
|
|
|
<p>
|
|
|
|
|
If installing on Ubuntu or Debian,
|
|
|
|
|
<a href="http://opinionated-programmer.com/2010/12/installing-coffeescript-on-debian-or-ubuntu/">be
|
|
|
|
|
careful not to use the existing out-of-date package</a>. If installing on
|
|
|
|
|
Windows, your best bet is probably to run Node.js under Cygwin.
|
|
|
|
|
</p>
|
|
|
|
|
|
2010-06-28 01:06:53 -04:00
|
|
|
<p>
|
2010-11-21 19:53:31 -05:00
|
|
|
Both of these provide the <tt>coffee</tt> command, which can execute
|
2010-11-21 21:12:59 -05:00
|
|
|
coffee scripts, compile <tt>.coffee</tt> files into <tt>.js</tt>, and
|
|
|
|
|
provides an interactive REPL. The <tt>coffee</tt> command takes the
|
2010-11-21 19:53:31 -05:00
|
|
|
following options:
|
2009-12-23 19:42:18 -05:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<table>
|
|
|
|
|
<tr>
|
2010-02-27 00:38:04 -05:00
|
|
|
<td><code>-c, --compile</code></td>
|
2009-12-25 03:16:56 -05:00
|
|
|
<td>
|
2010-02-27 00:38:04 -05:00
|
|
|
Compile a <tt>.coffee</tt> script into a <tt>.js</tt> JavaScript file
|
|
|
|
|
of the same name.
|
2009-12-25 03:16:56 -05:00
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2010-02-27 00:38:04 -05:00
|
|
|
<td width="25%"><code>-i, --interactive</code></td>
|
2009-12-25 03:16:56 -05:00
|
|
|
<td>
|
2010-03-08 06:34:07 -05:00
|
|
|
Launch an interactive CoffeeScript session to try short snippets.
|
|
|
|
|
More pleasant if wrapped with
|
2010-03-07 18:19:41 -05:00
|
|
|
<a href="http://utopia.knoware.nl/~hlub/uck/rlwrap/rlwrap.html">rlwrap</a>.
|
2009-12-25 03:16:56 -05:00
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>-o, --output [DIR]</code></td>
|
2009-12-23 19:42:18 -05:00
|
|
|
<td>
|
|
|
|
|
Write out all compiled JavaScript files into the specified directory.
|
2010-02-27 00:38:04 -05:00
|
|
|
Use in conjunction with <tt>--compile</tt> or <tt>--watch</tt>.
|
2009-12-23 19:42:18 -05:00
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>-w, --watch</code></td>
|
|
|
|
|
<td>
|
2009-12-24 02:01:39 -05:00
|
|
|
Watch the modification times of the coffee-scripts, recompiling as
|
2009-12-23 19:42:18 -05:00
|
|
|
soon as a change occurs.
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>-p, --print</code></td>
|
|
|
|
|
<td>
|
|
|
|
|
Instead of writing out the JavaScript as a file, print it
|
|
|
|
|
directly to <b>stdout</b>.
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>-l, --lint</code></td>
|
|
|
|
|
<td>
|
2010-02-21 18:37:52 -05:00
|
|
|
If the <tt>jsl</tt>
|
|
|
|
|
(<a href="http://www.javascriptlint.com/">JavaScript Lint</a>)
|
2010-02-21 17:30:41 -05:00
|
|
|
command is installed, use it
|
2009-12-25 01:29:30 -05:00
|
|
|
to check the compilation of a CoffeeScript file. (Handy in
|
2010-08-03 01:13:31 -04:00
|
|
|
conjunction with <br /> <tt>--watch</tt>)
|
2009-12-23 19:42:18 -05:00
|
|
|
</td>
|
|
|
|
|
</tr>
|
2010-02-24 18:27:10 -05:00
|
|
|
<tr>
|
|
|
|
|
<td><code>-s, --stdio</code></td>
|
|
|
|
|
<td>
|
|
|
|
|
Pipe in CoffeeScript to STDIN and get back JavaScript over STDOUT.
|
|
|
|
|
Good for use with processes written in other languages. An example:<br />
|
2010-03-08 06:40:54 -05:00
|
|
|
<tt>cat src/cake.coffee | coffee -sc</tt>
|
2010-02-24 18:27:10 -05:00
|
|
|
</td>
|
|
|
|
|
</tr>
|
2009-12-23 19:42:18 -05:00
|
|
|
<tr>
|
|
|
|
|
<td><code>-e, --eval</code></td>
|
|
|
|
|
<td>
|
|
|
|
|
Compile and print a little snippet of CoffeeScript directly from the
|
2010-03-08 06:40:54 -05:00
|
|
|
command line. For example:<br /><tt>coffee -e "puts num for num in [10..1]"</tt>
|
2009-12-23 19:42:18 -05:00
|
|
|
</td>
|
|
|
|
|
</tr>
|
2010-08-11 00:40:15 -04:00
|
|
|
<tr>
|
|
|
|
|
<td><code>-r, --require</code></td>
|
|
|
|
|
<td>
|
|
|
|
|
Load a library before compiling or executing your script. Can be used
|
|
|
|
|
to hook in to the compiler (to add Growl notifications, for example).
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
2009-12-24 20:37:24 -05:00
|
|
|
<tr>
|
2010-10-13 15:09:56 -04:00
|
|
|
<td><code>-b, --bare</code></td>
|
2009-12-24 20:37:24 -05:00
|
|
|
<td>
|
2010-01-10 17:14:20 -05:00
|
|
|
Compile the JavaScript without the top-level function safety wrapper.
|
2010-01-29 23:30:54 -05:00
|
|
|
(Used for CoffeeScript as a Node.js module.)
|
2010-01-10 17:14:20 -05:00
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2010-02-21 17:30:41 -05:00
|
|
|
<td><code>-t, --tokens</code></td>
|
2010-01-10 17:14:20 -05:00
|
|
|
<td>
|
2010-02-21 17:30:41 -05:00
|
|
|
Instead of parsing the CoffeeScript, just lex it, and print out the
|
2010-08-04 23:14:34 -04:00
|
|
|
token stream: <tt>[IDENTIFIER square] [ASSIGN =] [PARAM_START (]</tt> ...
|
2009-12-24 20:37:24 -05:00
|
|
|
</td>
|
|
|
|
|
</tr>
|
2009-12-24 02:01:39 -05:00
|
|
|
<tr>
|
2010-02-25 18:43:33 -05:00
|
|
|
<td><code>-n, --nodes</code></td>
|
2009-12-24 02:01:39 -05:00
|
|
|
<td>
|
2010-02-21 17:30:41 -05:00
|
|
|
Instead of compiling the CoffeeScript, just lex and parse it, and print
|
|
|
|
|
out the parse tree:
|
2010-02-22 17:14:51 -05:00
|
|
|
<pre class="no_bar">
|
|
|
|
|
Expressions
|
|
|
|
|
Assign
|
|
|
|
|
Value "square"
|
|
|
|
|
Code "x"
|
|
|
|
|
Op *
|
|
|
|
|
Value "x"
|
|
|
|
|
Value "x"</pre>
|
2009-12-24 02:01:39 -05:00
|
|
|
</td>
|
|
|
|
|
</tr>
|
2010-12-18 09:29:04 -05:00
|
|
|
<tr>
|
|
|
|
|
<td><code>--nodejs</code></td>
|
|
|
|
|
<td>
|
|
|
|
|
The <tt>node</tt> executable has some useful options you can set,
|
|
|
|
|
such as <tt>--debug</tt> and <tt>--max-stack-size</tt>. Use this
|
|
|
|
|
flag to forward options directly to Node.js.
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
2009-12-23 19:42:18 -05:00
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
<b>Examples:</b>
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre>
|
2010-11-21 19:53:31 -05:00
|
|
|
coffee -o lib/ -c src/
|
2009-12-26 11:57:13 -05:00
|
|
|
coffee --watch --lint experimental.coffee
|
2010-11-21 19:53:31 -05:00
|
|
|
coffee --print app/scripts/*.coffee > concatenation.js
|
|
|
|
|
coffee --bare --print --stdio</pre>
|
2009-12-23 19:42:18 -05:00
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<h2>
|
2010-02-21 16:13:09 -05:00
|
|
|
<span id="language" class="bookmark"></span>
|
|
|
|
|
Language Reference
|
2010-02-21 14:30:21 -05:00
|
|
|
</h2>
|
2010-02-13 16:23:03 -05:00
|
|
|
|
2009-12-23 19:42:18 -05:00
|
|
|
<p>
|
|
|
|
|
<i>
|
2009-12-24 12:56:44 -05:00
|
|
|
This reference is structured so that it can be read from top to bottom,
|
2009-12-23 19:42:18 -05:00
|
|
|
if you like. Later sections use ideas and syntax previously introduced.
|
2009-12-24 02:01:39 -05:00
|
|
|
Familiarity with JavaScript is assumed.
|
2009-12-23 19:42:18 -05:00
|
|
|
In all of the following examples, the source CoffeeScript is provided on
|
|
|
|
|
the left, and the direct compilation into JavaScript is on the right.
|
|
|
|
|
</i>
|
|
|
|
|
</p>
|
2010-02-21 18:37:52 -05:00
|
|
|
|
2010-02-21 17:30:41 -05:00
|
|
|
<p>
|
|
|
|
|
<i>
|
|
|
|
|
Many of the examples can be run (where it makes sense) by pressing the "run"
|
2010-02-21 18:37:52 -05:00
|
|
|
button towards the bottom right. You can also paste examples into
|
2010-02-21 17:30:41 -05:00
|
|
|
"Try CoffeeScript" in the toolbar, and play with them from there.
|
|
|
|
|
</i>
|
2010-02-21 14:30:21 -05:00
|
|
|
<p>
|
|
|
|
|
<span id="whitespace" class="bookmark"></span>
|
2010-01-04 22:19:45 -05:00
|
|
|
<b class="header">Significant Whitespace</b>
|
|
|
|
|
CoffeeScript uses Python-style significant whitespace: You don't need to
|
|
|
|
|
use semicolons <tt>;</tt> to terminate expressions, ending
|
|
|
|
|
the line will do just as well. Semicolons can still be used to fit
|
|
|
|
|
multiple expressions onto a single line. Instead of using curly braces
|
2010-01-05 00:19:22 -05:00
|
|
|
<tt>{ }</tt> to delimit blocks of code (like <a href="#functions">functions</a>,
|
2009-12-25 01:29:30 -05:00
|
|
|
<a href="#conditionals">if-statements</a>,
|
2010-01-04 22:19:45 -05:00
|
|
|
<a href="#switch">switch</a>, and <a href="#try">try/catch</a>),
|
|
|
|
|
use indentation.
|
2009-12-23 19:42:18 -05:00
|
|
|
</p>
|
|
|
|
|
|
2010-01-26 23:23:59 -05:00
|
|
|
<p>
|
2010-02-21 17:30:41 -05:00
|
|
|
You don't need to use parentheses to invoke a function if you're passing
|
2010-11-21 19:53:31 -05:00
|
|
|
arguments:<br /><tt>print "coffee"</tt>. The implicit call wraps forward
|
|
|
|
|
to the end of the line or block expression.
|
2010-01-26 23:23:59 -05:00
|
|
|
</p>
|
2010-11-21 21:12:59 -05:00
|
|
|
|
2010-01-05 21:40:36 -05:00
|
|
|
<p>
|
2010-11-21 19:53:31 -05:00
|
|
|
Within object literals, indentation can be used to create nested objects.
|
2010-01-05 21:40:36 -05:00
|
|
|
</p>
|
|
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<p>
|
|
|
|
|
<span id="functions" class="bookmark"></span>
|
2010-11-21 19:53:31 -05:00
|
|
|
<b class="header">Functions</b>
|
2009-12-25 01:29:30 -05:00
|
|
|
Functions are defined by a list of parameters, an arrow, and the
|
2010-07-11 10:44:33 -04:00
|
|
|
function body. The empty function looks like this: <tt>-></tt>
|
2009-12-23 19:42:18 -05:00
|
|
|
</p>
|
|
|
|
|
<%= code_for('functions', 'cube(5)') %>
|
2010-11-21 21:12:59 -05:00
|
|
|
<p>
|
|
|
|
|
Functions may also have default values for arguments.
|
|
|
|
|
</p>
|
|
|
|
|
<%= code_for('default_args', 'fill("cup")') %>
|
2009-12-23 19:42:18 -05:00
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<p>
|
|
|
|
|
<span id="objects_and_arrays" class="bookmark"></span>
|
2009-12-23 19:42:18 -05:00
|
|
|
<b class="header">Objects and Arrays</b>
|
|
|
|
|
Object and Array literals look very similar to their JavaScript cousins.
|
2010-11-21 19:53:31 -05:00
|
|
|
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.
|
2009-12-23 19:42:18 -05:00
|
|
|
</p>
|
|
|
|
|
<%= code_for('objects_and_arrays', 'song.join(",")') %>
|
2010-06-28 01:00:53 -04:00
|
|
|
<p>
|
|
|
|
|
In JavaScript, you can't use reserved words, like <tt>class</tt>, as properties
|
2010-11-21 19:53:31 -05:00
|
|
|
of an object, without quoting them as strings. CoffeeScript notices reserved words
|
2010-11-21 21:12:59 -05:00
|
|
|
used as keys in objects and quotes them for you, so you don't have to worry
|
2010-11-21 19:53:31 -05:00
|
|
|
about it (say, when using jQuery).
|
2010-06-28 01:00:53 -04:00
|
|
|
</p>
|
|
|
|
|
<%= code_for('objects_reserved') %>
|
2009-12-23 19:42:18 -05:00
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<p>
|
|
|
|
|
<span id="lexical_scope" class="bookmark"></span>
|
2009-12-23 19:42:18 -05:00
|
|
|
<b class="header">Lexical Scoping and Variable Safety</b>
|
|
|
|
|
The CoffeeScript compiler takes care to make sure that all of your variables
|
2009-12-24 02:01:39 -05:00
|
|
|
are properly declared within lexical scope — you never need to write
|
|
|
|
|
<tt>var</tt> yourself.
|
2009-12-23 19:42:18 -05:00
|
|
|
</p>
|
2010-06-28 00:19:58 -04:00
|
|
|
<%= code_for('scope', 'inner') %>
|
2009-12-23 19:42:18 -05:00
|
|
|
<p>
|
2010-08-04 01:59:17 -04:00
|
|
|
Notice how all of the variable declarations have been pushed up to
|
2010-01-04 22:19:45 -05:00
|
|
|
the top of the closest scope, the first time they appear.
|
2010-07-23 12:34:54 -04:00
|
|
|
<b>outer</b> is not redeclared within the inner function, because it's
|
|
|
|
|
already in scope; <b>inner</b> within the function, on the other hand,
|
2010-01-04 22:19:45 -05:00
|
|
|
should not be able to change the value of the external variable of the same name, and
|
|
|
|
|
therefore has a declaration of its own.
|
2009-12-23 19:42:18 -05:00
|
|
|
</p>
|
2010-03-08 19:27:38 -05:00
|
|
|
<p>
|
|
|
|
|
This behavior is effectively identical to Ruby's scope for local variables.
|
2010-03-23 00:18:50 -04:00
|
|
|
Because you don't have direct access to the <tt>var</tt> 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
|
2010-03-08 19:27:38 -05:00
|
|
|
variable accidentally, if you're writing a deeply nested function.
|
|
|
|
|
</p>
|
2009-12-23 19:42:18 -05:00
|
|
|
<p>
|
2009-12-24 02:01:39 -05:00
|
|
|
Although suppressed within this documentation for clarity, all
|
2009-12-23 19:42:18 -05:00
|
|
|
CoffeeScript output is wrapped in an anonymous function:
|
|
|
|
|
<tt>(function(){ ... })();</tt> This safety wrapper, combined with the
|
|
|
|
|
automatic generation of the <tt>var</tt> keyword, make it exceedingly difficult
|
2010-01-26 23:23:59 -05:00
|
|
|
to pollute the global namespace by accident.
|
2010-01-17 18:33:31 -05:00
|
|
|
</p>
|
2010-01-26 23:23:59 -05:00
|
|
|
<p>
|
|
|
|
|
If you'd like to create top-level variables for other scripts to use,
|
|
|
|
|
attach them as properties on <b>window</b>, or on the <b>exports</b>
|
2010-08-03 01:13:31 -04:00
|
|
|
object in CommonJS. The <b>existential operator</b> (covered below), gives you a
|
2010-01-17 18:33:31 -05:00
|
|
|
reliable way to figure out where to add them, if you're targeting both
|
2010-11-21 19:53:31 -05:00
|
|
|
CommonJS and the browser: <tt>exports ? this</tt>
|
2009-12-23 19:42:18 -05:00
|
|
|
</p>
|
|
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<p>
|
|
|
|
|
<span id="conditionals" class="bookmark"></span>
|
2010-07-16 22:44:07 -04:00
|
|
|
<b class="header">If, Else, Unless, and Conditional Assignment</b>
|
2009-12-28 21:02:40 -05:00
|
|
|
<b>If/else</b> statements can be written without the use of parentheses and
|
2010-01-04 22:19:45 -05:00
|
|
|
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 <tt>if</tt> or <tt>unless</tt> at the end.
|
2009-12-23 19:42:18 -05:00
|
|
|
</p>
|
2009-12-24 04:38:32 -05:00
|
|
|
<p>
|
2010-07-16 22:44:07 -04:00
|
|
|
CoffeeScript can compile <b>if</b> 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
|
2010-11-21 19:53:31 -05:00
|
|
|
a regular <b>if</b> statement on a single line.
|
2009-12-24 04:38:32 -05:00
|
|
|
</p>
|
2009-12-23 19:42:18 -05:00
|
|
|
<%= code_for('conditionals') %>
|
|
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<p>
|
|
|
|
|
<span id="aliases" class="bookmark"></span>
|
2009-12-24 02:01:39 -05:00
|
|
|
<b class="header">Aliases</b>
|
|
|
|
|
Because the <tt>==</tt> operator frequently causes undesirable coercion,
|
|
|
|
|
is intransitive, and has a different meaning than in other languages,
|
|
|
|
|
CoffeeScript compiles <tt>==</tt> into <tt>===</tt>, and <tt>!=</tt> into
|
|
|
|
|
<tt>!==</tt>.
|
|
|
|
|
In addition, <tt>is</tt> compiles into <tt>===</tt>,
|
2009-12-24 20:21:20 -05:00
|
|
|
and <tt>isnt</tt> into <tt>!==</tt>.
|
2009-12-24 02:01:39 -05:00
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
You can use <tt>not</tt> as an alias for <tt>!</tt>.
|
|
|
|
|
</p>
|
2009-12-24 17:37:30 -05:00
|
|
|
<p>
|
|
|
|
|
For logic, <tt>and</tt> compiles to <tt>&&</tt>, and <tt>or</tt>
|
|
|
|
|
into <tt>||</tt>.
|
|
|
|
|
</p>
|
2009-12-24 04:33:59 -05:00
|
|
|
<p>
|
|
|
|
|
Instead of a newline or semicolon, <tt>then</tt> can be used to separate
|
2009-12-25 01:29:30 -05:00
|
|
|
conditions from expressions, in <b>while</b>,
|
2009-12-24 04:33:59 -05:00
|
|
|
<b>if</b>/<b>else</b>, and <b>switch</b>/<b>when</b> statements.
|
|
|
|
|
</p>
|
2009-12-24 02:01:39 -05:00
|
|
|
<p>
|
|
|
|
|
As in <a href="http://yaml.org/">YAML</a>, <tt>on</tt> and <tt>yes</tt>
|
|
|
|
|
are the same as boolean <tt>true</tt>, while <tt>off</tt> and <tt>no</tt> are boolean <tt>false</tt>.
|
2009-12-23 19:42:18 -05:00
|
|
|
</p>
|
2009-12-24 02:01:39 -05:00
|
|
|
<p>
|
|
|
|
|
For single-line statements, <tt>unless</tt> can be used as the inverse of <tt>if</tt>.
|
|
|
|
|
</p>
|
2010-02-08 10:58:49 -05:00
|
|
|
<p>
|
|
|
|
|
As a shortcut for <tt>this.property</tt>, you can use <tt>@property</tt>.
|
|
|
|
|
</p>
|
2010-06-28 01:00:53 -04:00
|
|
|
<p>
|
2010-07-17 10:28:06 -04:00
|
|
|
You can use <tt>in</tt> to test for array presence, and <tt>of</tt> to
|
2010-06-28 01:00:53 -04:00
|
|
|
test for JavaScript object-key presence.
|
|
|
|
|
</p>
|
2010-11-21 21:12:59 -05:00
|
|
|
|
2010-11-21 19:53:31 -05:00
|
|
|
<p>
|
|
|
|
|
All together now:
|
|
|
|
|
</p>
|
2010-11-21 21:12:59 -05:00
|
|
|
|
2010-11-21 19:53:31 -05:00
|
|
|
<table class="definitions">
|
|
|
|
|
<tr><th>CoffeeScript</th><th>JavaScript</th></tr>
|
|
|
|
|
<tr><td><tt>is</tt></td><td><tt>===</tt></td></tr>
|
|
|
|
|
<tr><td><tt>isnt</tt></td><td><tt>!==</tt></td></tr>
|
|
|
|
|
<tr><td><tt>not</tt></td><td><tt>!</tt></td></tr>
|
|
|
|
|
<tr><td><tt>and</tt></td><td><tt>&&</tt></td></tr>
|
|
|
|
|
<tr><td><tt>or</tt></td><td><tt>||</tt></td></tr>
|
|
|
|
|
<tr><td><tt>true, yes, on</tt></td><td><tt>true</tt></td></tr>
|
|
|
|
|
<tr><td><tt>false, no, off</tt></td><td><tt>false</tt></td></tr>
|
|
|
|
|
<tr><td><tt>@, this</tt></td><td><tt>this</tt></td></tr>
|
|
|
|
|
<tr><td><tt>of</tt></td><td><tt>in</tt></td></tr>
|
2010-12-12 15:02:27 -05:00
|
|
|
<tr><td><tt>in</tt></td><td><i><small>no JS equivalent</small></i></td></tr>
|
2010-11-21 19:53:31 -05:00
|
|
|
</table>
|
2010-11-21 21:12:59 -05:00
|
|
|
|
2009-12-24 02:01:39 -05:00
|
|
|
<%= code_for('aliases') %>
|
2009-12-23 19:42:18 -05:00
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<p>
|
|
|
|
|
<span id="splats" class="bookmark"></span>
|
2010-01-05 21:40:36 -05:00
|
|
|
<b class="header">Splats...</b>
|
2010-01-04 23:26:27 -05:00
|
|
|
The JavaScript <b>arguments object</b> is a useful way to work with
|
|
|
|
|
functions that accept variable numbers of arguments. CoffeeScript provides
|
2010-01-05 21:40:36 -05:00
|
|
|
splats <tt>...</tt>, both for function definition as well as invocation,
|
2010-01-17 18:33:31 -05:00
|
|
|
making variable numbers of arguments a little bit more palatable.
|
2010-01-04 23:26:27 -05:00
|
|
|
</p>
|
|
|
|
|
<%= code_for('splats', true) %>
|
|
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<p>
|
|
|
|
|
<span id="while" class="bookmark"></span>
|
2010-06-28 01:00:53 -04:00
|
|
|
<b class="header">While, Until, and Loop</b>
|
2010-01-13 23:24:45 -05:00
|
|
|
The only low-level loop that CoffeeScript provides is the <b>while</b> loop. The
|
|
|
|
|
main difference from JavaScript is that the <b>while</b> loop can be used
|
|
|
|
|
as an expression, returning an array containing the result of each iteration
|
|
|
|
|
through the loop.
|
2009-12-23 19:42:18 -05:00
|
|
|
</p>
|
2010-01-13 23:24:45 -05:00
|
|
|
<%= code_for('while', 'lyrics.join("\n")') %>
|
2009-12-23 19:42:18 -05:00
|
|
|
<p>
|
2010-06-28 01:00:53 -04:00
|
|
|
For readability, the <b>until</b> keyword is equivalent to <tt>while not</tt>,
|
|
|
|
|
and the <b>loop</b> keyword is equivalent to <tt>while true</tt>.
|
2009-12-23 20:24:55 -05:00
|
|
|
Other JavaScript loops, such as <b>for</b> loops and <b>do-while</b> loops
|
2010-06-28 01:00:53 -04:00
|
|
|
can be mimicked by variations on <b>loop</b>, but the hope is that you
|
2009-12-23 20:24:55 -05:00
|
|
|
won't need to do that with CoffeeScript, either because you're using
|
2009-12-23 19:42:18 -05:00
|
|
|
<b>each</b> (<b>forEach</b>) style iterators, or...
|
|
|
|
|
</p>
|
|
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<p>
|
|
|
|
|
<span id="comprehensions" class="bookmark"></span>
|
2010-01-04 22:19:45 -05:00
|
|
|
<b class="header">Comprehensions (Arrays, Objects, and Ranges)</b>
|
2009-12-23 20:24:55 -05:00
|
|
|
For your looping needs, CoffeeScript provides array comprehensions
|
2009-12-23 19:42:18 -05:00
|
|
|
similar to Python's. They replace (and compile into) <b>for</b> 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. They should be able to handle most places where you otherwise
|
|
|
|
|
would use a loop, <b>each</b>/<b>forEach</b>, <b>map</b>, or <b>select</b>/<b>filter</b>.
|
|
|
|
|
</p>
|
|
|
|
|
<%= code_for('array_comprehensions') %>
|
2009-12-26 23:46:31 -05:00
|
|
|
<p>
|
2010-01-04 22:19:45 -05:00
|
|
|
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
|
2010-06-28 00:19:58 -04:00
|
|
|
end of your comprehension.
|
2010-01-04 22:19:45 -05:00
|
|
|
</p>
|
2010-11-21 12:38:27 -05:00
|
|
|
<%= code_for('range_comprehensions', 'countdown') %>
|
2010-12-05 15:29:28 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
Note how because we are assigning the value of the comprehensions to a
|
|
|
|
|
variable in the example above, CoffeeScript is collecting the result of
|
2010-12-05 15:29:28 -05:00
|
|
|
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,
|
2010-12-11 19:44:11 -05:00
|
|
|
by adding a meaningful return value, like <tt>true</tt>, or <tt>null</tt>,
|
2010-12-05 15:29:28 -05:00
|
|
|
to the bottom of your function.
|
|
|
|
|
</p>
|
2010-12-18 11:54:40 -05:00
|
|
|
<p>
|
|
|
|
|
To step through a range comprehension in fixed-size chunks,
|
|
|
|
|
use <tt>by</tt>, for example:<br />
|
|
|
|
|
<tt>evens = (x for x in [0..10] by 2)</tt>
|
|
|
|
|
</p>
|
2010-01-04 22:19:45 -05:00
|
|
|
<p>
|
2010-01-10 15:52:23 -05:00
|
|
|
Comprehensions can also be used to iterate over the keys and values in
|
2010-01-11 22:55:01 -05:00
|
|
|
an object. Use <tt>of</tt> to signal comprehension over the properties of
|
2010-01-11 00:01:16 -05:00
|
|
|
an object instead of the values in an array.
|
2009-12-26 23:46:31 -05:00
|
|
|
</p>
|
2010-01-04 22:19:45 -05:00
|
|
|
<%= code_for('object_comprehensions', 'ages.join(", ")') %>
|
2010-08-04 23:14:34 -04:00
|
|
|
<p>
|
|
|
|
|
By default, object comprehensions are safe, and use a <tt>hasOwnProperty</tt>
|
|
|
|
|
check to make sure that you're dealing with properties on the current
|
|
|
|
|
object. If you'd like the regular JavaScript <br /><tt>for (key in obj) ...</tt>
|
|
|
|
|
loop, for speed or for another reason, you can use <br />
|
|
|
|
|
<tt>for all key, value of object</tt> in CoffeeScript.
|
|
|
|
|
</p>
|
2010-12-04 12:52:51 -05:00
|
|
|
<p>
|
|
|
|
|
<span id="slices" class="bookmark"></span>
|
|
|
|
|
<b class="header">Array Slicing and Splicing with Ranges</b>
|
|
|
|
|
Ranges can also be used to extract slices of arrays.
|
|
|
|
|
With two dots (<tt>3..6</tt>), the range is inclusive (<tt>3, 4, 5, 6</tt>);
|
|
|
|
|
with three docs (<tt>3...6</tt>), the range excludes the end (<tt>3, 4, 5</tt>).
|
|
|
|
|
</p>
|
|
|
|
|
<%= code_for('slices', 'middle') %>
|
|
|
|
|
<p>
|
|
|
|
|
The same syntax can be used with assignment to replace a segment of an array
|
|
|
|
|
with new values, splicing it.
|
|
|
|
|
</p>
|
|
|
|
|
<%= code_for('splices', 'numbers') %>
|
|
|
|
|
<p>
|
|
|
|
|
Note that JavaScript strings are immutable, and can't be spliced.
|
|
|
|
|
</p>
|
2010-02-21 14:30:21 -05:00
|
|
|
<p>
|
|
|
|
|
<span id="expressions" class="bookmark"></span>
|
2010-01-04 22:51:02 -05:00
|
|
|
<b class="header">Everything is an Expression (at least, as much as possible)</b>
|
|
|
|
|
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 <tt>return</tt> gets
|
|
|
|
|
pushed down into each possible branch of execution, in the function
|
|
|
|
|
below.
|
|
|
|
|
</p>
|
|
|
|
|
<%= code_for('expressions', 'eldest') %>
|
2010-01-10 17:14:20 -05:00
|
|
|
<p>
|
|
|
|
|
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 (<tt>return value</tt>), when you know that you're done.
|
|
|
|
|
</p>
|
2010-01-04 22:51:02 -05:00
|
|
|
<p>
|
|
|
|
|
Because variable declarations occur at the top of scope, assignment can
|
|
|
|
|
be used within expressions, even for variables that haven't been seen before:
|
|
|
|
|
</p>
|
|
|
|
|
<%= code_for('expressions_assignment', 'six') %>
|
|
|
|
|
<p>
|
|
|
|
|
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:
|
|
|
|
|
</p>
|
|
|
|
|
<%= code_for('expressions_comprehension', 'globals') %>
|
|
|
|
|
<p>
|
|
|
|
|
As well as silly things, like passing a <b>try/catch</b> statement directly
|
|
|
|
|
into a function call:
|
|
|
|
|
</p>
|
|
|
|
|
<%= code_for('expressions_try', true) %>
|
2010-01-17 18:12:59 -05:00
|
|
|
<p>
|
|
|
|
|
There are a handful of statements in JavaScript that can't be meaningfully
|
2010-01-26 23:23:59 -05:00
|
|
|
converted into expressions, namely <tt>break</tt>, <tt>continue</tt>,
|
|
|
|
|
and <tt>return</tt>. If you make use of them within a block of code,
|
2010-01-17 18:12:59 -05:00
|
|
|
CoffeeScript won't try to perform the conversion.
|
|
|
|
|
</p>
|
2010-02-13 15:25:04 -05:00
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<p>
|
|
|
|
|
<span id="existence" class="bookmark"></span>
|
2010-01-26 23:23:59 -05:00
|
|
|
<b class="header">The Existential Operator</b>
|
|
|
|
|
It's a little difficult to check for the existence of a variable in
|
|
|
|
|
JavaScript. <tt>if (variable) ...</tt> comes close, but fails for zero,
|
|
|
|
|
the empty string, and false. CoffeeScript's existential operator <tt>?</tt> returns true unless
|
|
|
|
|
a variable is <b>null</b> or <b>undefined</b>, which makes it analogous
|
|
|
|
|
to Ruby's <tt>nil?</tt>
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
It can also be used for safer conditional assignment than <tt>||=</tt>
|
|
|
|
|
provides, for cases where you may be handling numbers or strings.
|
|
|
|
|
</p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<%= code_for('existence', 'footprints') %>
|
2010-01-26 23:23:59 -05:00
|
|
|
<p>
|
|
|
|
|
The accessor variant of the existential operator <tt>?.</tt> can be used to soak
|
|
|
|
|
up null references in a chain of properties. Use it instead
|
|
|
|
|
of the dot accessor <tt>.</tt> in cases where the base value may be <b>null</b>
|
|
|
|
|
or <b>undefined</b>. If all of the properties exist then you'll get the expected
|
|
|
|
|
result, if the chain is broken, <b>undefined</b> is returned instead of
|
|
|
|
|
the <b>TypeError</b> that would be raised otherwise.
|
|
|
|
|
</p>
|
|
|
|
|
<%= code_for('soaks') %>
|
|
|
|
|
<p>
|
2010-02-13 15:25:04 -05:00
|
|
|
Soaking up nulls is similar to Ruby's
|
|
|
|
|
<a href="http://andand.rubyforge.org/">andand gem</a>, and to the
|
2010-01-26 23:23:59 -05:00
|
|
|
<a href="http://groovy.codehaus.org/Operators#Operators-SafeNavigationOperator%28%3F.%29">safe navigation operator</a>
|
|
|
|
|
in Groovy.
|
|
|
|
|
</p>
|
2009-12-23 19:42:18 -05:00
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<p>
|
2010-02-27 20:12:47 -05:00
|
|
|
<span id="classes" class="bookmark"></span>
|
|
|
|
|
<b class="header">Classes, Inheritance, and Super</b>
|
2009-12-23 19:42:18 -05:00
|
|
|
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:
|
2009-12-23 20:24:55 -05:00
|
|
|
<a href="http://code.google.com/p/base2/">Base2</a>,
|
2009-12-23 19:42:18 -05:00
|
|
|
<a href="http://prototypejs.org/">Prototype.js</a>,
|
|
|
|
|
<a href="http://jsclass.jcoglan.com/">JS.Class</a>, etc.
|
2009-12-23 20:48:55 -05:00
|
|
|
The libraries provide syntactic sugar, but the built-in inheritance would
|
2009-12-24 19:49:23 -05:00
|
|
|
be completely usable if it weren't for a couple of small exceptions:
|
|
|
|
|
it's awkward to call <b>super</b> (the prototype object's
|
|
|
|
|
implementation of the current function), and it's awkward to correctly
|
2010-01-11 22:55:01 -05:00
|
|
|
set the prototype chain.
|
2010-01-10 17:14:20 -05:00
|
|
|
</p>
|
|
|
|
|
<p>
|
2010-02-27 20:12:47 -05:00
|
|
|
Instead of repetitively attaching functions to a prototype, CoffeeScript
|
|
|
|
|
provides a basic <tt>class</tt> structure that allows you to name your class,
|
|
|
|
|
set the superclass, assign prototypal properties, and define the constructor,
|
|
|
|
|
in a single assignable expression.
|
2009-12-23 19:42:18 -05:00
|
|
|
</p>
|
2010-11-21 21:12:59 -05:00
|
|
|
<p>
|
|
|
|
|
Constructor functions are named, to better support reflection. In the
|
|
|
|
|
example below for the first class, <tt>this.constructor.name is "Animal"</tt>.
|
|
|
|
|
</p>
|
2010-02-27 20:12:47 -05:00
|
|
|
<%= code_for('classes', true) %>
|
2010-02-26 20:09:49 -05:00
|
|
|
<p>
|
2010-02-27 20:12:47 -05:00
|
|
|
If structuring your prototypes classically isn't your cup of tea, CoffeeScript
|
|
|
|
|
provides a couple of lower-level conveniences. The <tt>extends</tt> operator
|
2010-03-08 06:44:47 -05:00
|
|
|
helps with proper prototype setup, <tt>::</tt> gives you
|
2010-02-27 20:12:47 -05:00
|
|
|
quick access to an object's prototype, and <tt>super()</tt>
|
|
|
|
|
is converted into a call against the immediate ancestor's method of the same name.
|
2010-02-26 20:09:49 -05:00
|
|
|
</p>
|
2010-02-27 20:12:47 -05:00
|
|
|
<%= code_for('prototypes', '"one_two".dasherize()') %>
|
2010-04-03 20:43:50 -04:00
|
|
|
<p>
|
2010-11-21 21:12:59 -05:00
|
|
|
Finally class definitions are blocks of executable code, which make for interesting
|
|
|
|
|
metaprogramming possibilities. Because in the context of a class definition,
|
|
|
|
|
<tt>this</tt> is the class object itself (the constructor function), you
|
|
|
|
|
can assign static properties by using <br /><tt>@property: value</tt>, and call
|
|
|
|
|
functions defined in parent classes: <tt>@attr 'title', type: 'text'</tt>
|
2010-04-03 20:43:50 -04:00
|
|
|
</p>
|
2009-12-23 19:42:18 -05:00
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<p>
|
|
|
|
|
<span id="pattern_matching" class="bookmark"></span>
|
2010-01-11 22:55:01 -05:00
|
|
|
<b class="header">Pattern Matching (Destructuring Assignment)</b>
|
2010-01-12 00:09:23 -05:00
|
|
|
To make extracting values from complex arrays and objects more convenient,
|
|
|
|
|
CoffeeScript implements ECMAScript Harmony's proposed
|
2010-01-11 22:55:01 -05:00
|
|
|
<a href="http://wiki.ecmascript.org/doku.php?id=harmony:destructuring">destructuring assignment</a>
|
|
|
|
|
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:
|
|
|
|
|
</p>
|
2010-06-28 00:19:58 -04:00
|
|
|
<%= code_for('parallel_assignment', 'theBait') %>
|
2010-01-11 22:55:01 -05:00
|
|
|
<p>
|
|
|
|
|
But it's also helpful for dealing with functions that return multiple
|
|
|
|
|
values.
|
|
|
|
|
</p>
|
|
|
|
|
<%= code_for('multiple_return_values', 'forecast') %>
|
|
|
|
|
<p>
|
|
|
|
|
Pattern matching can be used with any depth of array and object nesting,
|
2010-01-12 00:09:23 -05:00
|
|
|
to help pull out deeply nested properties.
|
2010-01-11 22:55:01 -05:00
|
|
|
</p>
|
2010-05-15 01:18:05 -04:00
|
|
|
<%= code_for('object_extraction', 'name + " — " + street') %>
|
2010-03-23 00:18:50 -04:00
|
|
|
<p>
|
|
|
|
|
Pattern matching can even be combined with splats.
|
|
|
|
|
</p>
|
|
|
|
|
<%= code_for('patterns_and_splats', 'contents.join("")') %>
|
2010-01-11 22:55:01 -05:00
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<p>
|
|
|
|
|
<span id="fat_arrow" class="bookmark"></span>
|
2010-01-13 23:24:45 -05:00
|
|
|
<b class="header">Function binding</b>
|
2010-03-06 19:29:41 -05:00
|
|
|
In JavaScript, the <tt>this</tt> keyword is dynamically scoped to mean the
|
|
|
|
|
object that the current function is attached to. If you pass a function as
|
|
|
|
|
as callback, or attach it to a different object, the original value of <tt>this</tt>
|
2010-03-08 06:34:07 -05:00
|
|
|
will be lost. If you're not familiar with this behavior,
|
2010-03-06 19:29:41 -05:00
|
|
|
<a href="http://www.digital-web.com/articles/scope_in_javascript/">this Digital Web article</a>
|
|
|
|
|
gives a good overview of the quirks.
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
2010-03-23 00:18:50 -04:00
|
|
|
The fat arrow <tt>=></tt> can be used to both define a function, and to bind
|
2010-01-13 23:24:45 -05:00
|
|
|
it to the current value of <tt>this</tt>, right on the spot. This is helpful
|
|
|
|
|
when using callback-based libraries like Prototype or jQuery, for creating
|
|
|
|
|
iterator functions to pass to <tt>each</tt>, or event-handler functions
|
2010-01-26 23:23:59 -05:00
|
|
|
to use with <tt>bind</tt>. Functions created with the fat arrow are able to access
|
2010-01-13 23:24:45 -05:00
|
|
|
properties of the <tt>this</tt> where they're defined.
|
|
|
|
|
</p>
|
2010-01-26 23:23:59 -05:00
|
|
|
<%= code_for('fat_arrow') %>
|
2010-03-06 19:29:41 -05:00
|
|
|
<p>
|
|
|
|
|
If we had used <tt>-></tt> in the callback above, <tt>@customer</tt> would
|
2010-03-08 06:34:07 -05:00
|
|
|
have referred to the undefined "customer" property of the DOM element,
|
|
|
|
|
and trying to call <tt>purchase()</tt> on it would have raised an exception.
|
2010-03-06 19:29:41 -05:00
|
|
|
</p>
|
2010-01-13 23:24:45 -05:00
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<p>
|
|
|
|
|
<span id="embedded" class="bookmark"></span>
|
2009-12-23 19:42:18 -05:00
|
|
|
<b class="header">Embedded JavaScript</b>
|
2010-01-11 22:55:01 -05:00
|
|
|
Hopefully, you'll never need to use it, but if you ever need to intersperse
|
2010-01-11 09:09:06 -05:00
|
|
|
snippets of JavaScript within your CoffeeScript, you can
|
|
|
|
|
use backticks to pass it straight through.
|
2009-12-23 19:42:18 -05:00
|
|
|
</p>
|
2009-12-23 20:24:55 -05:00
|
|
|
<%= code_for('embedded', 'hi()') %>
|
2009-12-23 19:42:18 -05:00
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<p>
|
|
|
|
|
<span id="switch" class="bookmark"></span>
|
2009-12-24 04:33:59 -05:00
|
|
|
<b class="header">Switch/When/Else</b>
|
2010-09-27 15:21:45 -04:00
|
|
|
<b>Switch</b> statements in JavaScript are a bit awkward. You need to
|
|
|
|
|
remember to <b>break</b> at the end of every <b>case</b> statement to
|
|
|
|
|
avoid accidentally falling through to the default case.
|
2010-09-16 00:32:57 -04:00
|
|
|
CoffeeScript prevents accidental fall-through, and can convert the <tt>switch</tt>
|
|
|
|
|
into a returnable, assignable expression. The format is: <tt>switch</tt> condition,
|
2009-12-24 04:33:59 -05:00
|
|
|
<tt>when</tt> clauses, <tt>else</tt> the default case.
|
2009-12-23 19:42:18 -05:00
|
|
|
</p>
|
2010-01-13 23:24:45 -05:00
|
|
|
<p>
|
|
|
|
|
As in Ruby, <b>switch</b> statements in CoffeeScript can take multiple
|
|
|
|
|
values for each <b>when</b> clause. If any of the values match, the clause
|
|
|
|
|
runs.
|
|
|
|
|
</p>
|
2009-12-23 19:42:18 -05:00
|
|
|
<%= code_for('switch') %>
|
|
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<p>
|
|
|
|
|
<span id="try" class="bookmark"></span>
|
2009-12-23 19:42:18 -05:00
|
|
|
<b class="header">Try/Catch/Finally</b>
|
2009-12-24 02:01:39 -05:00
|
|
|
Try/catch statements are just about the same as JavaScript (although
|
2009-12-24 03:12:07 -05:00
|
|
|
they work as expressions).
|
2009-12-23 19:42:18 -05:00
|
|
|
</p>
|
|
|
|
|
<%= code_for('try') %>
|
|
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<p>
|
|
|
|
|
<span id="comparisons" class="bookmark"></span>
|
2010-01-17 18:12:59 -05:00
|
|
|
<b class="header">Chained Comparisons</b>
|
|
|
|
|
CoffeeScript borrows
|
|
|
|
|
<a href="http://docs.python.org/reference/expressions.html#notin">chained comparisons</a>
|
|
|
|
|
from Python — making it easy to test if a value falls within a
|
|
|
|
|
certain range.
|
|
|
|
|
</p>
|
|
|
|
|
<%= code_for('comparisons', 'healthy') %>
|
|
|
|
|
|
2010-03-23 00:18:50 -04:00
|
|
|
<p>
|
2010-11-21 21:12:59 -05:00
|
|
|
<span id="strings" class="bookmark"></span>
|
|
|
|
|
<b class="header">String Interpolation, Heredocs, and Block Comments</b>
|
2010-08-12 00:00:28 -04:00
|
|
|
Ruby-style string interpolation is included in CoffeeScript. Double-quoted
|
2010-11-21 21:12:59 -05:00
|
|
|
strings allow for interpolated values, using <tt>#{ ... }</tt>,
|
|
|
|
|
and single-quoted strings are literal.
|
2010-03-23 00:18:50 -04:00
|
|
|
</p>
|
2010-11-21 21:12:59 -05:00
|
|
|
<%= code_for('interpolation', 'sentence') %>
|
2010-03-23 00:18:50 -04:00
|
|
|
<p>
|
2009-12-23 19:42:18 -05:00
|
|
|
Multiline strings are allowed in CoffeeScript.
|
|
|
|
|
</p>
|
2010-06-28 00:19:58 -04:00
|
|
|
<%= code_for('strings', 'mobyDick') %>
|
2010-01-12 00:00:38 -05:00
|
|
|
<p>
|
|
|
|
|
Heredocs 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 heredoc is maintained throughout, so
|
|
|
|
|
you can keep it all aligned with the body of your code.
|
|
|
|
|
</p>
|
|
|
|
|
<%= code_for('heredocs') %>
|
2010-03-08 06:34:07 -05:00
|
|
|
<p>
|
2010-03-23 00:18:50 -04:00
|
|
|
Double-quoted heredocs, like double-quoted strings, allow interpolation.
|
2010-03-08 06:34:07 -05:00
|
|
|
</p>
|
2010-07-17 10:28:06 -04:00
|
|
|
<p>
|
2010-07-29 00:51:35 -04:00
|
|
|
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 synax for heredocs,
|
2010-07-17 10:28:06 -04:00
|
|
|
are preserved in the generated code.
|
|
|
|
|
</p>
|
|
|
|
|
<%= code_for('block_comment') %>
|
2010-03-08 06:34:07 -05:00
|
|
|
|
2010-11-21 21:12:59 -05:00
|
|
|
<p>
|
|
|
|
|
<span id="regexes" class="bookmark"></span>
|
|
|
|
|
<b class="header">Extended Regular Expressions</b>
|
|
|
|
|
Similar to "heredocs" and "herecomments", CoffeeScript supports "heregexes" —
|
|
|
|
|
extended regular expressions that ignore internal whitespace and can contain
|
|
|
|
|
comments, after Perl's <tt>/x</tt> modifier, but delimited by <tt>///</tt>.
|
|
|
|
|
They go a long way towards making complex regular expressions readable.
|
|
|
|
|
To quote from the CoffeeScript source:
|
|
|
|
|
</p>
|
|
|
|
|
<%= code_for('heregexes') %>
|
|
|
|
|
|
|
|
|
|
|
2010-02-21 18:37:52 -05:00
|
|
|
<h2>
|
|
|
|
|
<span id="cake" class="bookmark"></span>
|
|
|
|
|
Cake, and Cakefiles
|
|
|
|
|
</h2>
|
|
|
|
|
|
|
|
|
|
<p>
|
2010-07-29 00:51:35 -04:00
|
|
|
CoffeeScript includes a simple build system similar to
|
|
|
|
|
<a href="http://www.gnu.org/software/make/">Make</a> and
|
2010-07-17 10:28:06 -04:00
|
|
|
<a href="http://rake.rubyforge.org/">Rake</a>. Naturally,
|
2010-02-21 18:37:52 -05:00
|
|
|
it's called Cake, and is used for the build and test tasks for the CoffeeScript
|
|
|
|
|
language itself. Tasks are defined in a file named <tt>Cakefile</tt>, and
|
|
|
|
|
can be invoked by running <tt>cake taskname</tt> from within the directory.
|
2010-07-17 10:28:06 -04:00
|
|
|
To print a list of all the tasks and options, just run <tt>cake</tt>.
|
2010-02-21 18:37:52 -05:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
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
|
2010-07-17 10:28:06 -04:00
|
|
|
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 <tt>options</tt> object. Here's a task that uses
|
|
|
|
|
the Node.js API to rebuild CoffeeScript's parser:
|
2010-02-21 18:37:52 -05:00
|
|
|
</p>
|
|
|
|
|
<%= code_for('cake_tasks') %>
|
2010-09-17 20:24:10 -04:00
|
|
|
<p>
|
|
|
|
|
If you need to invoke one task before another — for example, running
|
2010-09-27 15:21:45 -04:00
|
|
|
<tt>build</tt> before <tt>test</tt>, you can use the <tt>invoke</tt> function:
|
2010-09-17 20:24:10 -04:00
|
|
|
<tt>invoke 'build'</tt>
|
|
|
|
|
</p>
|
2010-02-21 18:37:52 -05:00
|
|
|
|
2010-02-25 00:26:59 -05:00
|
|
|
<h2>
|
|
|
|
|
<span id="scripts" class="bookmark"></span>
|
|
|
|
|
"text/coffeescript" Script Tags
|
|
|
|
|
</h2>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
While it's not recommended for serious use, CoffeeScripts may be included
|
|
|
|
|
directly within the browser using <tt><script type="text/coffeescript"></tt>
|
2010-02-25 06:26:27 -05:00
|
|
|
tags. The source includes a compressed and minified version of the compiler
|
2010-11-21 21:12:59 -05:00
|
|
|
(<a href="extras/coffee-script.js">Download current version here, 39k when gzipped</a>)
|
2010-02-25 18:20:15 -05:00
|
|
|
as <tt>extras/coffee-script.js</tt>. Include this file on a page with
|
2010-02-25 06:26:27 -05:00
|
|
|
inline CoffeeScript tags, and it will compile and evaluate them in order.
|
2010-02-25 00:26:59 -05:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
In fact, the little bit of glue script that runs "Try CoffeeScript" above,
|
2010-02-25 18:20:15 -05:00
|
|
|
as well as jQuery for the menu, is implemented in just this way.
|
2010-02-25 00:26:59 -05:00
|
|
|
View source and look at the bottom of the page to see the example.
|
|
|
|
|
Including the script also gives you access to <tt>CoffeeScript.compile()</tt>
|
|
|
|
|
so you can pop open Firebug and try compiling some strings.
|
|
|
|
|
</p>
|
2010-02-25 18:20:15 -05:00
|
|
|
|
2010-02-25 00:26:59 -05:00
|
|
|
<p>
|
|
|
|
|
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 <tt>window</tt> object.
|
|
|
|
|
</p>
|
2010-11-21 21:12:59 -05:00
|
|
|
|
2010-11-21 19:53:31 -05:00
|
|
|
<h2>
|
|
|
|
|
<span id="examples" class="bookmark"></span>
|
|
|
|
|
Examples
|
|
|
|
|
</h2>
|
2010-11-21 21:12:59 -05:00
|
|
|
|
2010-11-21 19:53:31 -05:00
|
|
|
<ul>
|
|
|
|
|
<li>
|
2010-11-21 21:12:59 -05:00
|
|
|
<b>frank06</b>'s <a href="http://riakjs.org/">riak-js</a>, a Node.js client for
|
2010-11-21 19:53:31 -05:00
|
|
|
<a href="http://www.basho.com/Riak.html">Riak</a>, with support for HTTP
|
|
|
|
|
and Protocol Buffers.
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<b>technoweenie</b>'s <a href="https://github.com/technoweenie/coffee-resque">Coffee-Resque</a>,
|
|
|
|
|
a port of <a href="https://github.com/defunkt/resque">Resque</a> for Node.js.
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<b>jashkenas</b>' <a href="documentation/docs/underscore.html">Underscore.coffee</a>, a port
|
|
|
|
|
of the <a href="http://documentcloud.github.com/underscore/">Underscore.js</a>
|
|
|
|
|
library of helper functions.
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<b>stephank</b>'s <a href="https://github.com/stephank/orona">Orona</a>, a remake of
|
|
|
|
|
the Bolo tank game for modern browsers.
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
2010-11-21 21:12:59 -05:00
|
|
|
<b>josh</b>'s <a href="http://josh.github.com/nack/">nack</a>, a Node.js-powered
|
2010-11-21 19:53:31 -05:00
|
|
|
<a href="http://rack.rubyforge.org/">Rack</a> server.
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
2010-11-21 21:12:59 -05:00
|
|
|
<b>sstephenson</b>'s <a href="http://sstephenson.github.com/strscan-js/">StringScanner</a>,
|
2010-11-21 19:53:31 -05:00
|
|
|
a simple tokenizer and lexical scanner for JavaScript strings.
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
2010-02-25 00:26:59 -05:00
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<h2>
|
|
|
|
|
<span id="resources" class="bookmark"></span>
|
|
|
|
|
Resources
|
|
|
|
|
</h2>
|
2009-12-31 13:01:10 -05:00
|
|
|
|
2009-12-31 18:22:51 -05:00
|
|
|
<ul>
|
|
|
|
|
<li>
|
|
|
|
|
<a href="http://github.com/jashkenas/coffee-script/">Source Code</a><br />
|
2010-02-21 18:37:52 -05:00
|
|
|
Use <tt>bin/coffee</tt> to test your changes,<br />
|
|
|
|
|
<tt>bin/cake test</tt> to run the test suite,<br />
|
|
|
|
|
<tt>bin/cake build</tt> to rebuild the CoffeeScript compiler, and <br />
|
|
|
|
|
<tt>bin/cake build:parser</tt> to regenerate the Jison parser if you're
|
2010-03-07 21:57:08 -05:00
|
|
|
working on the grammar. <br /><br />
|
2010-03-23 00:25:37 -04:00
|
|
|
<tt>git checkout lib && bin/cake build:full</tt> is a good command to run when you're working
|
2010-03-08 06:34:07 -05:00
|
|
|
on the core language. It'll refresh the lib directory
|
|
|
|
|
(in case you broke something), build your altered compiler, use that to
|
2010-03-07 21:57:08 -05:00
|
|
|
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.
|
2009-12-31 18:22:51 -05:00
|
|
|
</li>
|
|
|
|
|
<li>
|
2010-01-27 16:38:49 -05:00
|
|
|
<a href="http://github.com/jashkenas/coffee-script/issues">CoffeeScript Issues</a><br />
|
|
|
|
|
Bugs reports, feature requests, and general discussion all belong here.
|
2009-12-31 18:22:51 -05:00
|
|
|
</li>
|
2010-02-15 18:58:27 -05:00
|
|
|
<li>
|
2010-02-25 17:18:28 -05:00
|
|
|
If you'd like to chat, stop by <tt>#coffeescript</tt> on Freenode in the
|
2010-02-25 18:20:15 -05:00
|
|
|
IRC client of your choice, or on
|
2010-02-25 17:18:28 -05:00
|
|
|
<a href="http://webchat.freenode.net/">webchat.freenode.net</a>.
|
2010-02-15 18:58:27 -05:00
|
|
|
</li>
|
2010-11-21 19:53:31 -05:00
|
|
|
<li>
|
|
|
|
|
<b>satyr</b>'s <a href="http://github.com/satyr/coco">Coco</a>
|
|
|
|
|
— a CoffeeScript dialect that aims to be more radical and practical.
|
|
|
|
|
</li>
|
2010-05-15 01:18:05 -04:00
|
|
|
<li>
|
|
|
|
|
<b>yeungda</b>'s <a href="http://github.com/yeungda/jcoffeescript">JCoffeeScript</a>
|
|
|
|
|
— A Java Library that uses Rhino to compile CoffeeScript, allowing
|
|
|
|
|
compilation within Java projects or on systems that Node.js doesn't support.
|
|
|
|
|
</li>
|
2010-03-07 17:52:14 -05:00
|
|
|
<li>
|
|
|
|
|
<b>defunkt</b>'s <a href="http://github.com/defunkt/coffee-mode">CoffeeScript Major Mode</a>
|
|
|
|
|
— a Emacs major mode that provides syntax highlighting, indentation
|
2010-04-03 20:43:50 -04:00
|
|
|
support, and some bonus commands.
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
2010-11-21 19:53:31 -05:00
|
|
|
<b>jashkenas</b>' <a href="http://github.com/jashkenas/coffee-script-tmbundle">CoffeeScript TextMate Bundle</a>
|
2010-04-03 20:43:50 -04:00
|
|
|
— which provides syntax highlighting, snippet expansion, and the
|
|
|
|
|
ability to run bits of CoffeeScript from within TextMate itself.
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<b>kchmck</b>'s <a href="http://github.com/kchmck/vim-coffee-script">Vim CoffeeScript</a>
|
|
|
|
|
— which adds Vim syntax highlighting and indentation support.
|
2010-03-07 17:52:14 -05:00
|
|
|
</li>
|
2010-07-08 10:18:18 -04:00
|
|
|
<li>
|
|
|
|
|
<b>wavded</b>'s <a href="http://github.com/wavded/gedit-coffeescript">gedit-coffeescript</a>
|
|
|
|
|
— a CoffeeScript syntax highlighter for the gedit text editor.
|
|
|
|
|
</li>
|
2010-04-13 23:41:18 -04:00
|
|
|
<li>
|
|
|
|
|
<b>yeungda</b>'s <a href="http://yeungda.github.com/coffeescript-idea/">coffeescript-idea</a>
|
|
|
|
|
— a plugin for IntelliJ IDEA and RubyMine providing syntax highlighting.
|
|
|
|
|
</li>
|
2010-03-07 17:52:14 -05:00
|
|
|
<li>
|
|
|
|
|
<b>mattly</b>'s <a href="http://github.com/mattly/rack-coffee">rack-coffee</a>
|
2010-03-08 06:34:07 -05:00
|
|
|
— a small Rack middleware for serving CoffeeScript files as
|
2010-03-07 17:52:14 -05:00
|
|
|
compiled JavaScript on the fly.
|
|
|
|
|
</li>
|
2010-04-03 20:43:50 -04:00
|
|
|
<li>
|
|
|
|
|
<b>jnicklas</b>'s <a href="http://github.com/jnicklas/bistro_car">BistroCar</a>
|
|
|
|
|
— a plugin that serves and bundles CoffeeScript from within your
|
|
|
|
|
Rails application.
|
|
|
|
|
</li>
|
2010-07-05 08:51:45 -04:00
|
|
|
<li>
|
|
|
|
|
<b>dsc</b>'s <a href="http://github.com/dsc/coffeecup">CoffeeCup</a>
|
2010-09-10 15:41:35 -04:00
|
|
|
— a Python WSGI middleware that compiles CoffeeScript to JavaScript
|
2010-07-05 08:51:45 -04:00
|
|
|
on-demand during development.
|
|
|
|
|
</li>
|
2010-05-15 01:18:05 -04:00
|
|
|
<li>
|
|
|
|
|
<b>sutto</b>'s <a href="http://github.com/Sutto/barista">Barista</a>
|
|
|
|
|
— a BistroCar alternative that integrates well with
|
|
|
|
|
<a href="http://documentcloud.github.com/jammit">Jammit</a> and Rails 3.
|
|
|
|
|
</li>
|
2010-04-11 17:57:29 -04:00
|
|
|
<li>
|
|
|
|
|
<b>inem</b> and <b>gerad</b>'s <a href="http://github.com/gerad/coffee-haml-filter">coffee-haml-filter</a>
|
|
|
|
|
— a custom filter for rendering CoffeeScript inline within
|
|
|
|
|
<a href="http://haml-lang.com/">HAML</a> templates.
|
|
|
|
|
</li>
|
2010-09-10 15:41:35 -04:00
|
|
|
<li>
|
|
|
|
|
<b>chrislloyd</b>'s <a href="http://github.com/chrislloyd/roast">Roast</a>
|
2010-09-27 15:21:45 -04:00
|
|
|
— a CoffeeScript compiler plug-in that allows you to include external
|
2010-09-10 15:41:35 -04:00
|
|
|
source files.
|
|
|
|
|
</li>
|
2010-10-10 11:33:03 -04:00
|
|
|
<li>
|
|
|
|
|
<b>andrzejsliwa</b>'s <a href="http://github.com/andrzejsliwa/coffeeapp">CoffeeApp</a>
|
|
|
|
|
— a CoffeeScript wrapper for CouchApps, web applications served
|
|
|
|
|
directly from CouchDB.
|
|
|
|
|
</li>
|
2010-11-21 19:53:31 -05:00
|
|
|
<li>
|
|
|
|
|
<b>sstephenson</b>'s <a href="http://github.com/sstephenson/eco">Eco</a>
|
|
|
|
|
— high-performance embedded CoffeeScript templates, after EJS and ERB.
|
|
|
|
|
</li>
|
2010-09-21 23:58:05 -04:00
|
|
|
<li>
|
|
|
|
|
<b>mauricemach</b>'s <a href="http://github.com/mauricemach/coffeekup">CoffeeKup</a>
|
2010-09-27 15:21:45 -04:00
|
|
|
— Markup as CoffeeScript. After _why's
|
2010-09-21 23:58:05 -04:00
|
|
|
<a href="http://markaby.github.com/">Markaby</a>.
|
|
|
|
|
</li>
|
2010-06-28 01:00:53 -04:00
|
|
|
<li>
|
2010-11-21 19:53:31 -05:00
|
|
|
<b>jashkenas</b>' <a href="http://jashkenas.github.com/docco/">Docco</a>
|
2010-09-10 15:41:35 -04:00
|
|
|
— a quick-and-dirty literate-programming-style documentation generator
|
2010-06-28 01:00:53 -04:00
|
|
|
for CoffeeScript. Used to produce the annotated source.
|
|
|
|
|
</li>
|
2010-10-24 14:29:47 -04:00
|
|
|
<li>
|
2010-12-21 12:08:04 -05:00
|
|
|
<b>naturalethic</b>'s <a href="http://github.com/naturalethic/coffee-mongo">coffee-mongo</a>
|
2010-11-21 19:53:31 -05:00
|
|
|
— an asynchronous MongoDB ORM, for use with Node.js and CoffeeScript.
|
2010-10-24 14:29:47 -04:00
|
|
|
</li>
|
|
|
|
|
<li>
|
2010-11-21 19:53:31 -05:00
|
|
|
<b>mauricemach</b>'s <a href="https://github.com/mauricemach/zappa">Zappa</a>
|
|
|
|
|
— a DSL for building web apps, built on top of Express and Socket.IO.
|
2010-10-24 14:29:47 -04:00
|
|
|
</li>
|
2009-12-31 18:22:51 -05:00
|
|
|
</ul>
|
2009-12-25 01:29:30 -05:00
|
|
|
|
2010-04-10 13:42:39 -04:00
|
|
|
<h2>
|
|
|
|
|
<span id="webchat" class="bookmark"></span>
|
|
|
|
|
Web Chat (IRC)
|
|
|
|
|
</h2>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
Quick help and advice can usually be found in the CoffeeScript IRC room.
|
|
|
|
|
Join <tt>#coffeescript</tt> on <tt>irc.freenode.net</tt>, or click the
|
|
|
|
|
button below to open a webchat session on this page.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
<button id="open_webchat">click to open #coffeescript</button>
|
|
|
|
|
</p>
|
|
|
|
|
|
2010-02-21 14:30:21 -05:00
|
|
|
<h2>
|
|
|
|
|
<span id="change_log" class="bookmark"></span>
|
|
|
|
|
Change Log
|
|
|
|
|
</h2>
|
2010-12-11 19:44:11 -05:00
|
|
|
|
2010-12-07 00:21:34 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.9.6
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Dec 6, 2010</small></span>
|
|
|
|
|
</b>
|
|
|
|
|
The REPL now properly formats stacktraces, and stays alive through
|
|
|
|
|
asynchronous exceptions. Using <tt>--watch</tt> now prints timestamps as
|
|
|
|
|
files are compiled. Fixed some accidentally-leaking variables within
|
2010-12-11 19:44:11 -05:00
|
|
|
plucked closure-loops. Constructors now maintain their declaration
|
2010-12-07 11:08:16 -05:00
|
|
|
location within a class body. Dynamic object keys were removed.
|
2010-12-11 19:44:11 -05:00
|
|
|
Nested classes are now supported. Fixes execution context for naked
|
2010-12-07 00:21:34 -05:00
|
|
|
splatted functions. Bugfix for inversion of chained comparisons.
|
|
|
|
|
Chained class instantiation now works properly with splats.
|
|
|
|
|
</p>
|
2010-09-27 15:21:45 -04:00
|
|
|
|
2010-11-21 21:12:59 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.9.5
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Nov 21, 2010</small></span>
|
|
|
|
|
</b>
|
2010-11-21 21:12:59 -05:00
|
|
|
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 <b>satyr</b>'s <a href="http://github.com/satyr/coco">Coco</a>
|
|
|
|
|
dialect of CoffeeScript. Heregexes (extended regexes) were added. Functions
|
|
|
|
|
can now have default arguments. Class bodies are now executable code.
|
2010-12-01 14:17:10 -05:00
|
|
|
Improved syntax errors for invalid CoffeeScript. <tt>undefined</tt> now
|
2010-11-21 21:19:49 -05:00
|
|
|
works like <tt>null</tt>, and cannot be assigned a new value.
|
2010-12-01 14:17:10 -05:00
|
|
|
There was a precedence change with respect to single-line comprehensions:
|
2010-12-04 12:52:51 -05:00
|
|
|
<tt>result = i for i in list</tt><br /> used to parse as <tt>result = (i for i in list)</tt>
|
2010-12-04 12:55:46 -05:00
|
|
|
by default ... it now parses as <br /><tt>(result = i) for i in list</tt>.
|
2010-11-21 21:12:59 -05:00
|
|
|
</p>
|
|
|
|
|
|
2010-09-21 23:58:05 -04:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.9.4
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Sep 21, 2010</small></span>
|
|
|
|
|
</b>
|
2010-09-21 23:58:05 -04:00
|
|
|
CoffeeScript now uses appropriately-named temporary variables, and recycles
|
|
|
|
|
their references after use. Added <tt>require.extensions</tt> support for
|
|
|
|
|
<b>Node.js 0.3</b>. Loading CoffeeScript in the browser now adds just a
|
|
|
|
|
single <tt>CoffeeScript</tt> object to global scope.
|
|
|
|
|
Fixes for implicit object and block comment edge cases.
|
|
|
|
|
</p>
|
2010-09-27 15:21:45 -04:00
|
|
|
|
2010-09-16 00:32:57 -04:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.9.3
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Sep 16, 2010</small></span>
|
|
|
|
|
</b>
|
2010-09-16 00:32:57 -04:00
|
|
|
CoffeeScript <tt>switch</tt> statements now compile into JS <tt>switch</tt>
|
2010-09-27 15:21:45 -04:00
|
|
|
statements — they previously compiled into <tt>if/else</tt> chains
|
2010-09-16 00:32:57 -04:00
|
|
|
for JavaScript 1.3 compatibility.
|
|
|
|
|
Soaking a function invocation is now supported. Users of the RubyMine
|
|
|
|
|
editor should now be able to use <tt>--watch</tt> mode.
|
|
|
|
|
</p>
|
2010-08-23 22:08:33 -04:00
|
|
|
|
|
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.9.2
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Aug 23, 2010</small></span>
|
|
|
|
|
</b>
|
2010-08-23 22:08:33 -04:00
|
|
|
Specifying the start and end of a range literal is now optional, eg. <tt>array[3..]</tt>.
|
|
|
|
|
You can now say <tt>a not instanceof b</tt>.
|
|
|
|
|
Fixed important bugs with nested significant and non-significant indentation (Issue #637).
|
|
|
|
|
Added a <tt>--require</tt> flag that allows you to hook into the <tt>coffee</tt> command.
|
|
|
|
|
Added a custom <tt>jsl.conf</tt> 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.
|
|
|
|
|
</p>
|
|
|
|
|
|
2010-08-11 00:40:15 -04:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.9.1
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Aug 11, 2010</small></span>
|
|
|
|
|
</b>
|
2010-08-11 00:40:15 -04:00
|
|
|
Bugfix release for <b>0.9.1</b>. Greatly improves the handling of mixed
|
2010-08-23 22:08:33 -04:00
|
|
|
implicit objects, implicit function calls, and implicit indentation.
|
2010-08-11 00:40:15 -04:00
|
|
|
String and regex interpolation is now strictly <tt>#{ ... }</tt> (Ruby style).
|
|
|
|
|
The compiler now takes a <tt>--require</tt> flag, which specifies scripts
|
|
|
|
|
to run before compilation.
|
|
|
|
|
</p>
|
2010-07-17 10:28:06 -04:00
|
|
|
|
2010-08-03 01:13:31 -04:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.9.0
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Aug 4, 2010</small></span>
|
|
|
|
|
</b>
|
2010-08-03 01:13:31 -04:00
|
|
|
The CoffeeScript <b>0.9</b> series is considered to be a release candidate
|
|
|
|
|
for <b>1.0</b>; let's give her a shakedown cruise. <b>0.9.0</b> introduces a massive
|
|
|
|
|
backwards-incompatible change: Assignment now uses <tt>=</tt>, and object
|
|
|
|
|
literals use <tt>:</tt>, as in JavaScript. This allows us to have implicit
|
|
|
|
|
object literals, and YAML-style object definitions. Half assignments are
|
|
|
|
|
removed, in favor of <tt>+=</tt>, <tt>or=</tt>, and friends.
|
2010-08-23 22:08:33 -04:00
|
|
|
Interpolation now uses a hash mark <tt>#</tt> instead of the dollar sign
|
2010-08-04 23:14:34 -04:00
|
|
|
<tt>$</tt> — because dollar signs may be part of a valid JS identifier.
|
2010-08-03 01:13:31 -04:00
|
|
|
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:
|
|
|
|
|
<tt>for all key, value of object</tt>. Mentioning the <tt>super</tt> keyword
|
|
|
|
|
with no arguments now forwards all arguments passed to the function,
|
|
|
|
|
as in Ruby. If you extend class <tt>B</tt> from parent class <tt>A</tt>, if
|
|
|
|
|
<tt>A</tt> has an <tt>extended</tt> method defined, it will be called, passing in <tt>B</tt> —
|
|
|
|
|
this enables static inheritance, among other things. Cleaner output for
|
|
|
|
|
functions bound with the fat arrow. <tt>@variables</tt> 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.
|
|
|
|
|
</p>
|
2010-08-23 22:08:33 -04:00
|
|
|
|
2010-07-13 23:39:58 -04:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.7.2
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Jul 12, 2010</small></span>
|
|
|
|
|
</b>
|
2010-07-13 23:39:58 -04:00
|
|
|
Quick bugfix (right after 0.7.1) for a problem that prevented <tt>coffee</tt>
|
|
|
|
|
command-line options from being parsed in some circumstances.
|
|
|
|
|
</p>
|
2010-07-17 10:28:06 -04:00
|
|
|
|
2010-07-11 10:40:44 -04:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.7.1
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Jul 11, 2010</small></span>
|
|
|
|
|
</b>
|
2010-07-11 10:40:44 -04:00
|
|
|
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.
|
|
|
|
|
</p>
|
2010-07-17 10:28:06 -04:00
|
|
|
|
2010-06-28 01:00:53 -04:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.7.0
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Jun 28, 2010</small></span>
|
|
|
|
|
</b>
|
2010-06-28 01:00:53 -04:00
|
|
|
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 <tt>by -1</tt>
|
2010-07-17 10:28:06 -04:00
|
|
|
if you'd like to iterate downward. Reporting of syntax errors is greatly
|
2010-06-28 01:00:53 -04:00
|
|
|
improved from the previous release. Running <tt>coffee</tt> with no arguments
|
2010-06-30 19:51:49 -04:00
|
|
|
now launches the REPL, with Readline support. The <tt><-</tt> bind operator
|
2010-06-28 01:00:53 -04:00
|
|
|
has been removed from CoffeeScript. The <tt>loop</tt> keyword was added,
|
|
|
|
|
which is equivalent to a <tt>while true</tt> loop. Comprehensions that contain
|
|
|
|
|
closures will now close over their variables, like the semantics of a <tt>forEach</tt>.
|
|
|
|
|
You can now use bound function in class definitions (bound to the instance).
|
|
|
|
|
For consistency, <tt>a in b</tt> is now an array presence check, and <tt>a of b</tt>
|
|
|
|
|
is an object-key check. Comments are no longer passed through to the generated
|
|
|
|
|
JavaScript.
|
|
|
|
|
</p>
|
2010-05-15 01:18:05 -04:00
|
|
|
|
|
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.6.2
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>May 15, 2010</small></span>
|
|
|
|
|
</b>
|
2010-05-15 01:18:05 -04:00
|
|
|
The <tt>coffee</tt> 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: <tt>{name, length}: func</tt>.
|
|
|
|
|
Pattern matching is now allowed within comprehension variables. <tt>unless</tt>
|
|
|
|
|
is now allowed in block form. <tt>until</tt> loops were added, as the inverse
|
|
|
|
|
of <tt>while</tt> loops. <tt>switch</tt> statements are now allowed without
|
|
|
|
|
switch object clauses. Compatible
|
|
|
|
|
with Node.js <b>v0.1.95</b>.
|
|
|
|
|
</p>
|
|
|
|
|
|
2010-04-12 21:20:00 -04:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.6.1
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Apr 12, 2010</small></span>
|
|
|
|
|
</b>
|
2010-04-12 21:20:00 -04:00
|
|
|
Upgraded CoffeeScript for compatibility with the new Node.js <b>v0.1.90</b>
|
|
|
|
|
series.
|
|
|
|
|
</p>
|
2010-04-10 13:42:39 -04:00
|
|
|
|
2010-04-03 20:43:50 -04:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.6.0
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Apr 3, 2010</small></span>
|
|
|
|
|
</b>
|
2010-04-10 13:42:39 -04:00
|
|
|
Trailing commas are now allowed, a-la Python. Static
|
|
|
|
|
properties may be assigned directly within class definitions,
|
2010-04-03 20:43:50 -04:00
|
|
|
using <tt>@property</tt> notation.
|
|
|
|
|
</p>
|
2010-03-08 06:34:07 -05:00
|
|
|
|
2010-03-23 00:18:50 -04:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.5.6
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Mar 23, 2010</small></span>
|
|
|
|
|
</b>
|
2010-03-23 00:18:50 -04:00
|
|
|
Interpolation can now be used within regular expressions and heredocs, as well as
|
|
|
|
|
strings. Added the <tt><-</tt> bind operator.
|
|
|
|
|
Allowing assignment to half-expressions instead of special <tt>||=</tt>-style
|
|
|
|
|
operators. The arguments object is no longer automatically converted into
|
|
|
|
|
an array. After requiring <tt>coffee-script</tt>, Node.js can now directly
|
|
|
|
|
load <tt>.coffee</tt> files, thanks to <b>registerExtension</b>. Multiple
|
|
|
|
|
splats can now be used in function calls, arrays, and pattern matching.
|
|
|
|
|
</p>
|
|
|
|
|
|
2010-03-08 06:34:07 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.5.5
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Mar 8, 2010</small></span>
|
|
|
|
|
</b>
|
2010-03-08 06:34:07 -05:00
|
|
|
String interpolation, contributed by
|
|
|
|
|
<a href="http://github.com/StanAngeloff">Stan Angeloff</a>.
|
|
|
|
|
Since <tt>--run</tt> has been the default since <b>0.5.3</b>, updating
|
|
|
|
|
<tt>--stdio</tt> and <tt>--eval</tt> to run by default, pass <tt>--compile</tt>
|
|
|
|
|
as well if you'd like to print the result.
|
|
|
|
|
</p>
|
|
|
|
|
|
2010-03-03 23:01:53 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.5.4
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Mar 3, 2010</small></span>
|
|
|
|
|
</b>
|
2010-03-03 23:01:53 -05:00
|
|
|
Bugfix that corrects the Node.js global constants <tt>__filename</tt> and
|
|
|
|
|
<tt>__dirname</tt>. Tweaks for more flexible parsing of nested function
|
|
|
|
|
literals and improperly-indented comments. Updates for the latest Node.js API.
|
|
|
|
|
</p>
|
2010-03-08 06:34:07 -05:00
|
|
|
|
2010-02-27 20:21:46 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.5.3
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Feb 27, 2010</small></span>
|
|
|
|
|
</b>
|
2010-03-08 06:34:07 -05:00
|
|
|
CoffeeScript now has a syntax for defining classes. Many of the core
|
2010-02-27 20:21:46 -05:00
|
|
|
components (Nodes, Lexer, Rewriter, Scope, Optparse) are using them.
|
|
|
|
|
Cakefiles can use <tt>optparse.coffee</tt> to define options for tasks.
|
|
|
|
|
<tt>--run</tt> is now the default flag for the <tt>coffee</tt> command,
|
|
|
|
|
use <tt>--compile</tt> to save JavaScripts. Bugfix for an ambiguity between
|
|
|
|
|
RegExp literals and chained divisions.
|
|
|
|
|
</p>
|
2010-02-25 18:20:15 -05:00
|
|
|
|
2010-02-25 00:26:59 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.5.2
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Feb 25, 2010</small></span>
|
|
|
|
|
</b>
|
2010-02-25 00:26:59 -05:00
|
|
|
Added a compressed version of the compiler for inclusion in web pages as
|
|
|
|
|
<br /><tt>extras/coffee-script.js</tt>. It'll automatically run any script tags
|
|
|
|
|
with type <tt>text/coffeescript</tt> for you. Added a <tt>--stdio</tt> option
|
|
|
|
|
to the <tt>coffee</tt> command, for piped-in compiles.
|
|
|
|
|
</p>
|
2010-02-25 18:20:15 -05:00
|
|
|
|
2010-02-24 18:27:10 -05:00
|
|
|
|
2010-02-24 00:54:07 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.5.1
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Feb 24, 2010</small></span>
|
|
|
|
|
</b>
|
2010-02-24 00:54:07 -05:00
|
|
|
Improvements to null soaking with the existential operator, including
|
|
|
|
|
soaks on indexed properties. Added conditions to <tt>while</tt> loops,
|
|
|
|
|
so you can use them as filters with <tt>when</tt>, in the same manner as
|
|
|
|
|
comprehensions.
|
|
|
|
|
</p>
|
2010-02-21 23:29:31 -05:00
|
|
|
|
2010-02-21 18:37:52 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.5.0
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Feb 21, 2010</small></span>
|
|
|
|
|
</b>
|
2010-02-21 19:19:58 -05:00
|
|
|
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.
|
2010-02-21 18:37:52 -05:00
|
|
|
</p>
|
2010-02-13 15:25:04 -05:00
|
|
|
|
2010-02-08 10:58:49 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.3.2
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Feb 8, 2010</small></span>
|
|
|
|
|
</b>
|
2010-02-08 10:58:49 -05:00
|
|
|
<tt>@property</tt> is now a shorthand for <tt>this.property</tt>.<br />
|
|
|
|
|
Switched the default JavaScript engine from Narwhal to Node.js. Pass
|
|
|
|
|
the <tt>--narwhal</tt> flag if you'd like to continue using it.
|
|
|
|
|
</p>
|
2009-12-25 01:29:30 -05:00
|
|
|
|
2009-12-24 12:54:12 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.3.0
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Jan 26, 2010</small></span>
|
|
|
|
|
</b>
|
2010-01-26 23:23:59 -05:00
|
|
|
CoffeeScript 0.3 includes major syntax changes:
|
|
|
|
|
<br />
|
|
|
|
|
The function symbol was changed to
|
|
|
|
|
<tt>-></tt>, and the bound function symbol is now <tt>=></tt>.
|
|
|
|
|
<br />
|
|
|
|
|
Parameter lists in function definitions must now be wrapped in parentheses.
|
|
|
|
|
<br />
|
|
|
|
|
Added property soaking, with the <tt>?.</tt> operator.
|
|
|
|
|
<br />
|
|
|
|
|
Made parentheses optional, when invoking functions with arguments.
|
|
|
|
|
<br />
|
|
|
|
|
Removed the obsolete block literal syntax.
|
2009-12-24 12:54:12 -05:00
|
|
|
</p>
|
2009-12-25 01:29:30 -05:00
|
|
|
|
2010-01-17 18:12:59 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.2.6
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Jan 17, 2010</small></span>
|
|
|
|
|
</b>
|
2010-01-17 18:12:59 -05:00
|
|
|
Added Python-style chained comparisons, the conditional existence
|
|
|
|
|
operator <tt>?=</tt>, and some examples from <i>Beautiful Code</i>.
|
|
|
|
|
Bugfixes relating to statement-to-expression conversion, arguments-to-array
|
|
|
|
|
conversion, and the TextMate syntax highlighter.
|
|
|
|
|
</p>
|
|
|
|
|
|
2010-01-13 23:24:45 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.2.5
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Jan 13, 2010</small></span>
|
|
|
|
|
</b>
|
2010-01-13 23:24:45 -05:00
|
|
|
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 <tt>==></tt>,
|
|
|
|
|
which defines and immediately binds a function to <tt>this</tt>. 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.
|
|
|
|
|
</p>
|
|
|
|
|
|
2010-01-12 00:09:23 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.2.4
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Jan 12, 2010</small></span>
|
|
|
|
|
</b>
|
2010-01-12 00:09:23 -05:00
|
|
|
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.
|
|
|
|
|
</p>
|
2010-01-11 22:55:01 -05:00
|
|
|
|
2010-01-11 00:01:16 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.2.3
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Jan 11, 2010</small></span>
|
|
|
|
|
</b>
|
2010-01-11 00:01:16 -05:00
|
|
|
Axed the unsatisfactory <tt>ino</tt> keyword, replacing it with <tt>of</tt> for
|
2010-01-11 08:46:50 -05:00
|
|
|
object comprehensions. They now look like: <tt>for prop, value of object</tt>.
|
2010-01-11 00:01:16 -05:00
|
|
|
</p>
|
2009-12-31 13:01:10 -05:00
|
|
|
|
2010-01-10 14:45:44 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.2.2
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Jan 10, 2010</small></span>
|
|
|
|
|
</b>
|
2010-01-10 16:16:59 -05:00
|
|
|
When performing a comprehension over an object, use <tt>ino</tt>, instead
|
|
|
|
|
of <tt>in</tt>, which helps us generate smaller, more efficient code at
|
|
|
|
|
compile time.
|
|
|
|
|
<br />
|
|
|
|
|
Added <tt>::</tt> as a shorthand for saying <tt>.prototype.</tt>
|
|
|
|
|
<br />
|
2010-01-10 14:45:44 -05:00
|
|
|
The "splat" symbol has been changed from a prefix asterisk <tt>*</tt>, to
|
2010-01-10 16:16:59 -05:00
|
|
|
a postfix ellipsis <tt>...</tt>
|
|
|
|
|
<br />
|
|
|
|
|
Added JavaScript's <tt>in</tt> operator,
|
2010-01-10 14:45:44 -05:00
|
|
|
empty <tt>return</tt> statements, and empty <tt>while</tt> loops.
|
2010-01-10 16:16:59 -05:00
|
|
|
<br />
|
2010-01-10 14:45:44 -05:00
|
|
|
Constructor functions that start with capital letters now include a
|
|
|
|
|
safety check to make sure that the new instance of the object is returned.
|
2010-01-10 16:16:59 -05:00
|
|
|
<br />
|
2010-01-10 14:45:44 -05:00
|
|
|
The <tt>extends</tt> keyword now functions identically to <tt>goog.inherits</tt>
|
|
|
|
|
in Google's Closure Library.
|
|
|
|
|
</p>
|
|
|
|
|
|
2010-01-05 09:29:10 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.2.1
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Jan 5, 2010</small></span>
|
|
|
|
|
</b>
|
2010-01-05 09:29:10 -05:00
|
|
|
Arguments objects are now converted into real arrays when referenced.
|
|
|
|
|
</p>
|
|
|
|
|
|
2010-01-05 00:19:22 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.2.0
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Jan 5, 2010</small></span>
|
|
|
|
|
</b>
|
2010-01-05 00:19:22 -05:00
|
|
|
Major release. Significant whitespace. Better statement-to-expression
|
|
|
|
|
conversion. Splats. Splice literals. Object comprehensions. Blocks.
|
2010-01-17 18:12:59 -05:00
|
|
|
The existential operator. Many thanks to all the folks who posted issues,
|
2010-01-05 09:29:10 -05:00
|
|
|
with special thanks to
|
2010-08-31 21:52:15 -04:00
|
|
|
<a href="http://github.com/liamoc">Liam O'Connor-Davis</a> for whitespace
|
2010-01-05 00:19:22 -05:00
|
|
|
and expression help.
|
|
|
|
|
</p>
|
|
|
|
|
|
2009-12-27 15:49:11 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.1.6
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Dec 27, 2009</small></span>
|
|
|
|
|
</b>
|
2009-12-27 15:49:11 -05:00
|
|
|
Bugfix for running <tt>coffee --interactive</tt> and <tt>--run</tt>
|
2009-12-31 13:01:10 -05:00
|
|
|
from outside of the CoffeeScript directory. Bugfix for nested
|
|
|
|
|
function/if-statements.
|
2009-12-27 15:49:11 -05:00
|
|
|
</p>
|
2009-12-31 13:01:10 -05:00
|
|
|
|
2009-12-27 00:25:37 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.1.5
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Dec 26, 2009</small></span>
|
|
|
|
|
</b>
|
2009-12-27 00:25:37 -05:00
|
|
|
Array slice literals and array comprehensions can now both take Ruby-style
|
2009-12-31 13:01:10 -05:00
|
|
|
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
|
2009-12-27 00:25:37 -05:00
|
|
|
expressions. You can use <tt>\</tt> to escape newlines.
|
|
|
|
|
The <tt>coffee-script</tt> command is now called <tt>coffee</tt>.
|
|
|
|
|
</p>
|
2009-12-25 19:35:57 -05:00
|
|
|
|
2009-12-25 17:43:24 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.1.4
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Dec 25, 2009</small></span>
|
|
|
|
|
</b>
|
2009-12-25 17:43:24 -05:00
|
|
|
The official CoffeeScript extension is now <tt>.coffee</tt> instead of
|
2009-12-25 19:35:57 -05:00
|
|
|
<tt>.cs</tt>, which properly belongs to
|
2009-12-25 17:43:24 -05:00
|
|
|
<a href="http://en.wikipedia.org/wiki/C_Sharp_(programming_language)">C#</a>.
|
|
|
|
|
Due to popular demand, you can now also use <tt>=</tt> to assign. Unlike
|
|
|
|
|
JavaScript, <tt>=</tt> can also be used within object literals, interchangeably
|
2009-12-25 19:35:57 -05:00
|
|
|
with <tt>:</tt>. Made a grammatical fix for chained function calls
|
|
|
|
|
like <tt>func(1)(2)(3)(4)</tt>. Inheritance and super no longer use
|
|
|
|
|
<tt>__proto__</tt>, so they should be IE-compatible now.
|
2009-12-25 17:43:24 -05:00
|
|
|
</p>
|
2009-12-25 17:18:05 -05:00
|
|
|
|
2009-12-25 03:16:56 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.1.3
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Dec 25, 2009</small></span>
|
|
|
|
|
</b>
|
2009-12-26 11:57:13 -05:00
|
|
|
The <tt>coffee</tt> command now includes <tt>--interactive</tt>,
|
2009-12-25 03:16:56 -05:00
|
|
|
which launches an interactive CoffeeScript session, and <tt>--run</tt>,
|
|
|
|
|
which directly compiles and executes a script. Both options depend on a
|
|
|
|
|
working installation of Narwhal.
|
2009-12-25 17:18:05 -05:00
|
|
|
The <tt>aint</tt> keyword has been replaced by <tt>isnt</tt>, which goes
|
2009-12-25 03:16:56 -05:00
|
|
|
together a little smoother with <tt>is</tt>.
|
|
|
|
|
Quoted strings are now allowed as identifiers within object literals: eg.
|
|
|
|
|
<tt>{"5+5": 10}</tt>.
|
2009-12-25 17:18:05 -05:00
|
|
|
All assignment operators now use a colon: <tt>+:</tt>, <tt>-:</tt>,
|
2009-12-25 03:16:56 -05:00
|
|
|
<tt>*:</tt>, etc.
|
|
|
|
|
</p>
|
2009-12-25 01:29:30 -05:00
|
|
|
|
2009-12-24 15:02:28 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.1.2
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Dec 24, 2009</small></span>
|
|
|
|
|
</b>
|
2009-12-25 01:29:30 -05:00
|
|
|
Fixed a bug with calling <tt>super()</tt> through more than one level of
|
2009-12-24 20:05:55 -05:00
|
|
|
inheritance, with the re-addition of the <tt>extends</tt> keyword.
|
2009-12-25 01:29:30 -05:00
|
|
|
Added experimental <a href="http://narwhaljs.org/">Narwhal</a>
|
|
|
|
|
support (as a Tusk package), contributed by
|
2009-12-24 20:05:55 -05:00
|
|
|
<a href="http://tlrobinson.net/">Tom Robinson</a>, including
|
|
|
|
|
<b>bin/cs</b> as a CoffeeScript REPL and interpreter.
|
|
|
|
|
New <tt>--no-wrap</tt> option to suppress the safety function
|
|
|
|
|
wrapper.
|
|
|
|
|
</p>
|
2009-12-25 01:29:30 -05:00
|
|
|
|
2009-12-24 20:05:55 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.1.1
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Dec 24, 2009</small></span>
|
|
|
|
|
</b>
|
2009-12-24 15:02:28 -05:00
|
|
|
Added <tt>instanceof</tt> and <tt>typeof</tt> as operators.
|
|
|
|
|
</p>
|
2009-12-25 01:29:30 -05:00
|
|
|
|
2009-12-24 03:12:07 -05:00
|
|
|
<p>
|
2010-12-11 19:44:11 -05:00
|
|
|
<b class="header" style="margin-top: 20px;">0.1.0
|
2010-12-07 00:21:34 -05:00
|
|
|
<span class="timestamp"> – <small>Dec 24, 2009</small></span>
|
|
|
|
|
</b>
|
2009-12-24 03:12:07 -05:00
|
|
|
Initial CoffeeScript release.
|
|
|
|
|
</p>
|
2009-12-21 11:41:45 -05:00
|
|
|
|
2009-12-19 22:55:58 -05:00
|
|
|
</div>
|
|
|
|
|
|
2010-02-24 20:41:56 -05:00
|
|
|
<script type="text/coffeescript">
|
|
|
|
|
|
2010-02-25 20:39:34 -05:00
|
|
|
# Set up the compilation function, to run when you stop typing.
|
2010-12-12 21:41:04 -05:00
|
|
|
compileSource = ->
|
2010-08-03 00:06:34 -04:00
|
|
|
source = $('#repl_source').val()
|
2010-12-12 21:41:04 -05:00
|
|
|
window.compiledJS = ''
|
2010-02-24 20:41:56 -05:00
|
|
|
try
|
2010-12-12 21:41:04 -05:00
|
|
|
window.compiledJS = CoffeeScript.compile source, bare: on
|
|
|
|
|
$('#repl_results').text window.compiledJS
|
2010-08-03 00:06:34 -04:00
|
|
|
$('#error').hide()
|
2010-02-25 20:39:34 -05:00
|
|
|
catch error
|
2010-08-03 00:06:34 -04:00
|
|
|
$('#error').text(error.message).show()
|
2010-02-25 20:39:34 -05:00
|
|
|
|
|
|
|
|
# Listen for keypresses and recompile.
|
2010-12-12 21:41:04 -05:00
|
|
|
$('#repl_source').keyup -> compileSource()
|
2010-02-24 20:41:56 -05:00
|
|
|
|
2010-02-25 20:39:34 -05:00
|
|
|
# Eval the compiled js.
|
2010-12-12 21:41:04 -05:00
|
|
|
$('.minibutton.run').click ->
|
2010-02-24 20:41:56 -05:00
|
|
|
try
|
2010-12-12 21:41:04 -05:00
|
|
|
eval window.compiledJS
|
2010-02-24 20:41:56 -05:00
|
|
|
catch error then alert error
|
|
|
|
|
|
2010-12-12 21:41:04 -05:00
|
|
|
# Load the console with a string of CoffeeScript.
|
|
|
|
|
window.loadConsole = (coffee) ->
|
|
|
|
|
$('#repl_source').val coffee
|
|
|
|
|
compileSource()
|
2010-12-12 21:53:17 -05:00
|
|
|
$('.navigation.try').addClass('active')
|
|
|
|
|
false
|
2010-02-24 20:41:56 -05:00
|
|
|
|
2010-02-25 20:39:34 -05:00
|
|
|
# Helper to hide the menus.
|
2010-12-12 21:41:04 -05:00
|
|
|
closeMenus = ->
|
2010-12-12 21:53:17 -05:00
|
|
|
$('.navigation.active').removeClass 'active'
|
2010-02-24 20:41:56 -05:00
|
|
|
|
2010-02-25 20:39:34 -05:00
|
|
|
# Bind navigation buttons to open the menus.
|
|
|
|
|
$('.navigation').click (e) ->
|
2010-02-24 20:41:56 -05:00
|
|
|
return if e.target.tagName.toLowerCase() is 'a'
|
2010-12-12 21:41:04 -05:00
|
|
|
return false if $(e.target).closest('.repl_wrapper').length
|
2010-12-12 21:53:17 -05:00
|
|
|
if $(this).hasClass('active')
|
2010-12-12 21:41:04 -05:00
|
|
|
closeMenus()
|
|
|
|
|
else
|
|
|
|
|
closeMenus()
|
2010-12-12 21:53:17 -05:00
|
|
|
$(this).addClass 'active'
|
2010-02-24 20:41:56 -05:00
|
|
|
false
|
|
|
|
|
|
2010-12-12 21:53:17 -05:00
|
|
|
$(document.body).click (e) ->
|
|
|
|
|
return false if $(e.target).hasClass('minibutton')
|
|
|
|
|
closeMenus()
|
2010-02-27 02:21:26 -05:00
|
|
|
|
2010-04-10 13:42:39 -04:00
|
|
|
$('#open_webchat').click ->
|
|
|
|
|
$(this).replaceWith $('<iframe src="http://webchat.freenode.net/?channels=coffeescript" width="625" height="400"></iframe>')
|
|
|
|
|
|
2010-12-12 21:41:04 -05:00
|
|
|
compileSource()
|
2010-02-25 20:39:34 -05:00
|
|
|
|
2010-02-24 20:41:56 -05:00
|
|
|
</script>
|
|
|
|
|
|
2010-12-15 21:11:43 -05:00
|
|
|
<script src="documentation/vendor/jquery-1.4.2.js"></script>
|
2010-02-24 23:57:39 -05:00
|
|
|
<script src="extras/coffee-script.js"></script>
|
2010-02-13 16:23:03 -05:00
|
|
|
|
2009-12-19 22:55:58 -05:00
|
|
|
</body>
|
|
|
|
|
</html>
|
