2009-12-21 16:41:45 +00:00
|
|
|
<%
|
|
|
|
|
require 'uv'
|
|
|
|
|
def code_for(file, executable=false)
|
|
|
|
|
@stripper ||= /(\A\(function\(\)\{\n|\}\)\(\);\Z|^ )/
|
2009-12-24 00:42:18 +00:00
|
|
|
return '' unless File.exists?("documentation/js/#{file}.js")
|
2009-12-21 16:41:45 +00:00
|
|
|
cs = File.read("documentation/cs/#{file}.cs")
|
|
|
|
|
js = File.read("documentation/js/#{file}.js").gsub(@stripper, '')
|
|
|
|
|
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}"
|
|
|
|
|
button = executable ? "<button onclick='javascript: #{js};#{append}'>#{run}</button>" : ''
|
|
|
|
|
"<div class='code'>#{cshtml}#{jshtml}#{button}<br class='clear' /></div>"
|
|
|
|
|
end
|
|
|
|
|
%>
|
|
|
|
|
|
|
|
|
|
|
2009-12-20 03:55:58 +00:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
|
2009-12-24 01:24:55 +00:00
|
|
|
<title>CoffeeScript</title>
|
2009-12-21 16:41:45 +00:00
|
|
|
<link rel="stylesheet" type="text/css" href="documentation/css/docs.css" />
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="documentation/css/idle.css" />
|
2009-12-20 03:55:58 +00:00
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<div class="container">
|
|
|
|
|
|
2009-12-21 16:41:45 +00:00
|
|
|
<h1><sub style="font-size: 100px;">☕</sub> CoffeeScript</h1>
|
|
|
|
|
|
2009-12-20 03:55:58 +00:00
|
|
|
<p>
|
|
|
|
|
CoffeeScript is a little language that compiles into JavaScript. Think
|
2009-12-24 00:42:18 +00:00
|
|
|
of it as JavaScript's less ostentatious kid brother — the same genes,
|
2009-12-24 08:12:07 +00:00
|
|
|
roughly the same height, but a different sense of style. Apart from a handful of
|
2009-12-24 01:24:55 +00:00
|
|
|
bonus goodies, statements in CoffeeScript correspond one-to-one with their
|
2009-12-24 00:42:18 +00:00
|
|
|
equivalent in JavaScript, it's just another way of saying it.
|
2009-12-21 16:41:45 +00:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<!-- <%# code_for('intro') %>-->
|
|
|
|
|
|
|
|
|
|
<p>
|
2009-12-22 17:18:27 +00:00
|
|
|
<b>Disclaimer:</b>
|
2009-12-24 06:22:41 +00:00
|
|
|
CoffeeScript is just for fun and seriously alpha. I'm sure that there are still
|
2009-12-24 07:01:39 +00:00
|
|
|
plenty of holes in the lexer and leaks in the syntax. <i>There is no guarantee,
|
2009-12-24 00:42:18 +00:00
|
|
|
explicit or implied, of its suitability for any purpose.</i> That said,
|
|
|
|
|
it compiles into clean JavaScript (the good parts) that can use existing
|
2009-12-24 07:01:39 +00:00
|
|
|
JavaScript libraries seamlessly, and passes through
|
2009-12-24 00:42:18 +00:00
|
|
|
<a href="http://www.jslint.com/">JSLint</a> without warnings. The compiled
|
2009-12-24 01:57:35 +00:00
|
|
|
output is quite readable — pretty-printed, with comments
|
2009-12-24 00:42:18 +00:00
|
|
|
preserved intact.
|
2009-12-21 16:41:45 +00:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<h2>Table of Contents</h2>
|
|
|
|
|
|
|
|
|
|
<p>
|
2009-12-24 00:42:18 +00:00
|
|
|
<a href="#overview">Mini Overview</a><br />
|
|
|
|
|
<a href="#installation">Installation and Usage</a><br />
|
2009-12-21 16:41:45 +00:00
|
|
|
<a href="#punctuation">Punctuation Primer</a><br />
|
|
|
|
|
<a href="#functions">Functions and Invocation</a><br />
|
|
|
|
|
<a href="#assignment">Assignment</a><br />
|
2009-12-24 00:42:18 +00:00
|
|
|
<a href="#objects_and_arrays">Objects and Arrays</a><br />
|
2009-12-21 16:41:45 +00:00
|
|
|
<a href="#lexical_scope">Lexical Scoping and Variable Safety</a><br />
|
|
|
|
|
<a href="#conditionals">Conditionals, Ternaries, and Conditional Assignment</a><br />
|
|
|
|
|
<a href="#expressions">Everything is an Expression</a><br />
|
2009-12-24 07:01:39 +00:00
|
|
|
<a href="#aliases">Aliases</a><br />
|
2009-12-21 16:41:45 +00:00
|
|
|
<a href="#while">While Loops</a><br />
|
|
|
|
|
<a href="#array_comprehensions">Array Comprehensions</a><br />
|
|
|
|
|
<a href="#slice">Array Slice Literals</a><br />
|
2009-12-25 00:49:23 +00:00
|
|
|
<a href="#inheritance">Inheritance, and Calling Super from a Subclass</a><br />
|
2009-12-21 16:41:45 +00:00
|
|
|
<a href="#embedded">Embedded JavaScript</a><br />
|
2009-12-24 09:33:59 +00:00
|
|
|
<a href="#switch">Switch/When/Else</a><br />
|
2009-12-21 16:41:45 +00:00
|
|
|
<a href="#try">Try/Catch/Finally</a><br />
|
|
|
|
|
<a href="#strings">Multiline Strings</a><br />
|
2009-12-24 17:54:12 +00:00
|
|
|
<a href="#contributing">Contributing</a><br />
|
2009-12-24 08:12:07 +00:00
|
|
|
<a href="#change_log">Change Log</a><br />
|
2009-12-20 03:55:58 +00:00
|
|
|
</p>
|
2009-12-21 16:41:45 +00:00
|
|
|
|
2009-12-24 00:42:18 +00:00
|
|
|
<h2 id="overview">Mini Overview</h2>
|
|
|
|
|
|
|
|
|
|
<p><i>CoffeeScript on the left, compiled JavaScript output on the right.</i></p>
|
|
|
|
|
|
|
|
|
|
<%= code_for('overview', 'cubed_list') %>
|
|
|
|
|
|
|
|
|
|
<h2 id="installation">Installation and Usage</h2>
|
2009-12-24 08:12:07 +00:00
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
The CoffeeScript compiler is written in pure Ruby, and is available
|
|
|
|
|
as a Ruby Gem.
|
|
|
|
|
</p>
|
2009-12-24 00:42:18 +00:00
|
|
|
|
|
|
|
|
<pre>
|
2009-12-24 08:12:07 +00:00
|
|
|
gem install coffee-script</pre>
|
2009-12-24 00:42:18 +00:00
|
|
|
|
2009-12-20 03:56:27 +00:00
|
|
|
<p>
|
2009-12-24 00:42:18 +00:00
|
|
|
Installing the gem provides the <tt>coffee-script</tt> command, which can
|
|
|
|
|
be used to compile CoffeeScript <tt>.cs</tt> files into JavaScript, as
|
2009-12-24 07:01:39 +00:00
|
|
|
well as debug them. By default, <tt>coffee-script</tt> writes out the
|
2009-12-24 00:42:18 +00:00
|
|
|
JavaScript as <tt>.js</tt> files in the same directory, but output
|
|
|
|
|
can be customized with the following options:
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<table>
|
|
|
|
|
<tr>
|
|
|
|
|
<td width="25%"><code>-o, --output [DIR]</code></td>
|
|
|
|
|
<td>
|
|
|
|
|
Write out all compiled JavaScript files into the specified directory.
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>-w, --watch</code></td>
|
|
|
|
|
<td>
|
2009-12-24 07:01:39 +00:00
|
|
|
Watch the modification times of the coffee-scripts, recompiling as
|
2009-12-24 00:42:18 +00: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>
|
|
|
|
|
If the <tt>jsl</tt> (JavaScript Lint) command is installed, use it
|
2009-12-24 07:01:39 +00:00
|
|
|
to check the compilation of a CoffeeScript file. (Handy in
|
|
|
|
|
conjunction with <tt>--watch</tt>)
|
2009-12-24 00:42:18 +00:00
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>-e, --eval</code></td>
|
|
|
|
|
<td>
|
|
|
|
|
Compile and print a little snippet of CoffeeScript directly from the
|
2009-12-24 07:01:39 +00:00
|
|
|
command line (or from <b>stdin</b>). For example:<br /><tt>coffee-script -e "square: x => x * x."</tt>
|
2009-12-24 00:42:18 +00:00
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>-t, --tokens</code></td>
|
|
|
|
|
<td>
|
|
|
|
|
Instead of parsing the CoffeeScript, just lex it, and print out the
|
|
|
|
|
token stream: <tt>[:IDENTIFIER, "square"], [":", ":"], [:PARAM, "x"]</tt> ...
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td><code>-v, --verbose</code></td>
|
|
|
|
|
<td>
|
|
|
|
|
As the JavaScript is being generated, print out every step of code
|
|
|
|
|
generation, including lexical scope and the node in the
|
|
|
|
|
AST.
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
2009-12-24 07:01:39 +00:00
|
|
|
<tr>
|
|
|
|
|
<td><code>--install-bundle</code></td>
|
|
|
|
|
<td>
|
|
|
|
|
Install the TextMate bundle for CoffeeScript syntax highlighting.
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
2009-12-24 00:42:18 +00:00
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
<b>Examples:</b>
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
|
coffee-script path/to/script.cs
|
|
|
|
|
coffee-script --watch --lint experimental.cs
|
|
|
|
|
coffee-script --print app/scripts/*.cs > concatenation.js</pre>
|
|
|
|
|
|
|
|
|
|
<h2>Language Reference</h2>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
<i>
|
2009-12-24 17:56:44 +00:00
|
|
|
This reference is structured so that it can be read from top to bottom,
|
2009-12-24 00:42:18 +00:00
|
|
|
if you like. Later sections use ideas and syntax previously introduced.
|
2009-12-24 07:01:39 +00:00
|
|
|
Familiarity with JavaScript is assumed.
|
2009-12-24 00:42:18 +00: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>
|
|
|
|
|
|
|
|
|
|
<p id="punctuation">
|
|
|
|
|
<b class="header">Punctuation Primer</b>
|
|
|
|
|
You don't need to use semicolons <tt>;</tt> to terminate expressions, ending
|
|
|
|
|
the line will do just as well. All other whitespace is
|
|
|
|
|
not significant. Instead of using curly braces <tt>{ }</tt>
|
|
|
|
|
to delimit a block of code, use a period <tt>.</tt> to mark the end of a
|
2009-12-24 07:01:39 +00:00
|
|
|
block, for
|
2009-12-24 06:22:41 +00:00
|
|
|
<a href="#functions">functions</a>,
|
|
|
|
|
<a href="#conditionals">if-statements</a>,
|
|
|
|
|
<a href="#switch">switch</a>, and <a href="#try">try/catch</a>.
|
2009-12-24 00:42:18 +00:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p id="functions">
|
|
|
|
|
<b class="header">Functions and Invocation</b>
|
2009-12-24 07:01:39 +00:00
|
|
|
Functions are defined by a list of parameters, an arrow, and the
|
|
|
|
|
function body. The empty function looks like this: <tt>=>.</tt>
|
2009-12-24 00:42:18 +00:00
|
|
|
</p>
|
|
|
|
|
<%= code_for('functions', 'cube(5)') %>
|
|
|
|
|
|
|
|
|
|
<p id="assignment">
|
|
|
|
|
<b class="header">Assignment</b>
|
|
|
|
|
Use a colon <tt>:</tt> to assign, as in
|
|
|
|
|
<a href="http://json.org">JSON</a>. Equal signs are only needed for
|
|
|
|
|
mathy things.
|
|
|
|
|
</p>
|
|
|
|
|
<%= code_for('assignment', 'greeting') %>
|
|
|
|
|
|
|
|
|
|
<p id="objects_and_arrays">
|
|
|
|
|
<b class="header">Objects and Arrays</b>
|
|
|
|
|
Object and Array literals look very similar to their JavaScript cousins.
|
|
|
|
|
When you spread out each assignment on a separate line, the commas are
|
|
|
|
|
optional. In this way, assigning object properties looks the same as
|
|
|
|
|
assigning local variables.
|
|
|
|
|
</p>
|
|
|
|
|
<%= code_for('objects_and_arrays', 'song.join(",")') %>
|
|
|
|
|
|
|
|
|
|
<p id="lexical_scope">
|
|
|
|
|
<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 07:01:39 +00:00
|
|
|
are properly declared within lexical scope — you never need to write
|
|
|
|
|
<tt>var</tt> yourself.
|
2009-12-24 00:42:18 +00:00
|
|
|
</p>
|
|
|
|
|
<%= code_for('scope', 'new_num') %>
|
|
|
|
|
<p>
|
|
|
|
|
Notice how the variables are declared with <tt>var</tt> the first time
|
|
|
|
|
they appear. The second reference of <b>num</b>, within the function,
|
|
|
|
|
is not redeclared because <b>num</b> is still in scope. As opposed
|
2009-12-24 07:01:39 +00:00
|
|
|
to the second occurrence of <b>new_num</b>, in the last line.
|
2009-12-24 00:42:18 +00:00
|
|
|
</p>
|
|
|
|
|
<p>
|
2009-12-24 07:01:39 +00:00
|
|
|
Although suppressed within this documentation for clarity, all
|
2009-12-24 00:42:18 +00: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
|
|
|
|
|
to pollute the global namespace by accident.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p id="conditionals">
|
|
|
|
|
<b class="header">Conditionals, Ternaries, and Conditional Assignment</b>
|
2009-12-24 09:38:32 +00:00
|
|
|
<b>If/else</b> statements can be written without the use of parenthesis and
|
2009-12-24 00:42:18 +00:00
|
|
|
curly brackets. As with functions and other block expressions, conditionals
|
|
|
|
|
are closed with periods. No period is necessary when using the single-line
|
|
|
|
|
postfix form, with the <tt>if</tt> at the end.
|
|
|
|
|
</p>
|
2009-12-24 09:38:32 +00:00
|
|
|
<p>
|
|
|
|
|
CoffeeScript will compile <b>if</b> statements using the ternary operator
|
|
|
|
|
when possible, to make it easier to use the result as an expression.
|
|
|
|
|
</p>
|
2009-12-24 00:42:18 +00:00
|
|
|
<%= code_for('conditionals') %>
|
|
|
|
|
<p>
|
2009-12-24 09:38:32 +00:00
|
|
|
The conditional assignment operators are available: <tt>||:</tt>,
|
2009-12-24 00:42:18 +00:00
|
|
|
which only assigns a value to a variable if the variable's current value
|
2009-12-24 01:24:55 +00:00
|
|
|
is falsy, and <tt>&&:</tt>, which only replaces the value of
|
2009-12-24 00:42:18 +00:00
|
|
|
truthy variables.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p id="expressions">
|
|
|
|
|
<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
|
2009-12-24 07:01:39 +00:00
|
|
|
to CoffeeScript functions, they nonetheless return their final value.
|
2009-12-24 00:42:18 +00:00
|
|
|
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') %>
|
|
|
|
|
<p>
|
2009-12-24 07:01:39 +00:00
|
|
|
The same mechanism is used to push down assignment through <b>switch</b>
|
|
|
|
|
statements, and <b>if-elses</b> (although the ternary operator is preferred).
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p id="aliases">
|
|
|
|
|
<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-25 01:21:20 +00:00
|
|
|
and <tt>isnt</tt> into <tt>!==</tt>.
|
2009-12-24 07:01:39 +00:00
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
You can use <tt>not</tt> as an alias for <tt>!</tt>.
|
|
|
|
|
</p>
|
2009-12-24 22:37:30 +00:00
|
|
|
<p>
|
|
|
|
|
For logic, <tt>and</tt> compiles to <tt>&&</tt>, and <tt>or</tt>
|
|
|
|
|
into <tt>||</tt>.
|
|
|
|
|
</p>
|
2009-12-24 09:33:59 +00:00
|
|
|
<p>
|
|
|
|
|
Instead of a newline or semicolon, <tt>then</tt> can be used to separate
|
|
|
|
|
conditions from expressions, in <b>while</b>,
|
|
|
|
|
<b>if</b>/<b>else</b>, and <b>switch</b>/<b>when</b> statements.
|
|
|
|
|
</p>
|
2009-12-24 07:01:39 +00: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-24 00:42:18 +00:00
|
|
|
</p>
|
2009-12-24 07:01:39 +00:00
|
|
|
<p>
|
|
|
|
|
For single-line statements, <tt>unless</tt> can be used as the inverse of <tt>if</tt>.
|
|
|
|
|
</p>
|
|
|
|
|
<%= code_for('aliases') %>
|
2009-12-24 00:42:18 +00:00
|
|
|
|
|
|
|
|
<p id="while">
|
|
|
|
|
<b class="header">While Loops</b>
|
|
|
|
|
The only low-level loop that CoffeeScript provides is the while loop.
|
|
|
|
|
</p>
|
|
|
|
|
<%= code_for('while') %>
|
|
|
|
|
<p>
|
2009-12-24 01:24:55 +00:00
|
|
|
Other JavaScript loops, such as <b>for</b> loops and <b>do-while</b> loops
|
|
|
|
|
can be mimicked by variations on <b>while</b>, but the hope is that you
|
|
|
|
|
won't need to do that with CoffeeScript, either because you're using
|
2009-12-24 00:42:18 +00:00
|
|
|
<b>each</b> (<b>forEach</b>) style iterators, or...
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p id="array_comprehensions">
|
|
|
|
|
<b class="header">Array Comprehensions</b>
|
2009-12-24 01:24:55 +00:00
|
|
|
For your looping needs, CoffeeScript provides array comprehensions
|
2009-12-24 00:42:18 +00: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') %>
|
|
|
|
|
|
|
|
|
|
<p id="slice">
|
|
|
|
|
<b class="header">Array Slice Literals</b>
|
|
|
|
|
CoffeeScript includes syntax for extracting slices of arrays.
|
|
|
|
|
The first argument is the index of the first element in the slice, and
|
|
|
|
|
the second is the index of the last one.
|
|
|
|
|
</p>
|
|
|
|
|
<%= code_for('slices', 'three_to_six') %>
|
|
|
|
|
|
2009-12-25 00:49:23 +00:00
|
|
|
<p id="inheritance">
|
|
|
|
|
<b class="header">Inheritance, and Calling Super from a Subclass</b>
|
2009-12-24 00:42:18 +00: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-24 01:24:55 +00:00
|
|
|
<a href="http://code.google.com/p/base2/">Base2</a>,
|
2009-12-24 00:42:18 +00:00
|
|
|
<a href="http://prototypejs.org/">Prototype.js</a>,
|
|
|
|
|
<a href="http://jsclass.jcoglan.com/">JS.Class</a>, etc.
|
2009-12-24 01:48:55 +00:00
|
|
|
The libraries provide syntactic sugar, but the built-in inheritance would
|
2009-12-25 00:49:23 +00: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
|
|
|
|
|
set the prototype chain. CoffeeScript provides <tt>extends</tt>
|
|
|
|
|
to help with prototype setup, and converts
|
2009-12-24 01:48:55 +00:00
|
|
|
<tt>super()</tt> calls into calls against the immediate ancestor's
|
|
|
|
|
method of the same name.
|
2009-12-24 00:42:18 +00:00
|
|
|
</p>
|
|
|
|
|
<%= code_for('super', true) %>
|
|
|
|
|
|
|
|
|
|
<p id="embedded">
|
|
|
|
|
<b class="header">Embedded JavaScript</b>
|
|
|
|
|
If you ever need to interpolate literal JavaScript snippets, you can
|
|
|
|
|
use backticks to pass JavaScript straight through.
|
|
|
|
|
</p>
|
2009-12-24 01:24:55 +00:00
|
|
|
<%= code_for('embedded', 'hi()') %>
|
2009-12-24 00:42:18 +00:00
|
|
|
|
|
|
|
|
<p id="switch">
|
2009-12-24 09:33:59 +00:00
|
|
|
<b class="header">Switch/When/Else</b>
|
2009-12-24 07:01:39 +00:00
|
|
|
<b>Switch</b> statements in JavaScript are rather broken. You can only
|
2009-12-24 08:12:07 +00:00
|
|
|
do comparisons based on string equality, and need to remember to <b>break</b> at the end of
|
2009-12-24 06:22:41 +00:00
|
|
|
every <b>case</b> statement to avoid accidentally falling through to
|
2009-12-24 09:33:59 +00:00
|
|
|
the default case. CoffeeScript compiles <b>switch</b> statements into JavaScript if-else chains, allowing you to
|
2009-12-24 00:42:18 +00:00
|
|
|
compare any object (via <b>===</b>), preventing fall-through, and resulting
|
2009-12-24 09:33:59 +00:00
|
|
|
in a returnable, assignable expression. The format is: <tt>switch</tt> condition,
|
|
|
|
|
<tt>when</tt> clauses, <tt>else</tt> the default case.
|
2009-12-24 00:42:18 +00:00
|
|
|
</p>
|
|
|
|
|
<%= code_for('switch') %>
|
|
|
|
|
|
|
|
|
|
<p id="try">
|
|
|
|
|
<b class="header">Try/Catch/Finally</b>
|
2009-12-24 07:01:39 +00:00
|
|
|
Try/catch statements are just about the same as JavaScript (although
|
2009-12-24 08:12:07 +00:00
|
|
|
they work as expressions).
|
2009-12-24 00:42:18 +00:00
|
|
|
</p>
|
|
|
|
|
<%= code_for('try') %>
|
|
|
|
|
|
|
|
|
|
<p id="try">
|
|
|
|
|
<b class="header">Multiline Strings</b>
|
|
|
|
|
Multiline strings are allowed in CoffeeScript.
|
|
|
|
|
</p>
|
2009-12-24 06:22:41 +00:00
|
|
|
<%= code_for('strings', 'moby_dick') %>
|
2009-12-24 08:12:07 +00:00
|
|
|
|
2009-12-24 17:54:12 +00:00
|
|
|
<h2 id="contributing">Contributing</h2>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
Here's a wish list of things that would be wonderful to have in
|
|
|
|
|
CoffeeScript:
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
<li>
|
|
|
|
|
A JavaScript version of the compiler, perhaps using Alessandro Warth's
|
|
|
|
|
<a href="http://tinlizzie.org/ometa/">OMeta</a>.
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
Ideas for alternate syntax to end blocks of expressions — the periods
|
|
|
|
|
can look a little weird with deeply nested structure.
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
Test cases for any syntax errors you encounter that you think CoffeeScript
|
|
|
|
|
should be able to compile properly.
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
A tutorial that introduces CoffeeScript from the ground up for folks
|
|
|
|
|
without knowledge of JavaScript.
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
Integration with Processing.js's JavaScript API (this would depend on
|
|
|
|
|
having a JavaScript version of the compiler).
|
|
|
|
|
</li>
|
2009-12-24 18:31:44 +00:00
|
|
|
<li>
|
|
|
|
|
A lot of the code generation in <tt>nodes.rb</tt> gets into messy
|
|
|
|
|
string manipulation. Techniques for cleaning this up across the board
|
|
|
|
|
would be appreciated.
|
|
|
|
|
</li>
|
2009-12-24 17:54:12 +00:00
|
|
|
</ul>
|
|
|
|
|
|
2009-12-24 08:12:07 +00:00
|
|
|
<h2 id="change_log">Change Log</h2>
|
|
|
|
|
|
2009-12-24 20:02:28 +00:00
|
|
|
<p>
|
2009-12-25 01:05:55 +00:00
|
|
|
<b class="header" style="margin-top: 20px;">0.1.2</b>
|
|
|
|
|
Fixed a bug with calling <tt>super()</tt> through more than one level of
|
|
|
|
|
inheritance, with the re-addition of the <tt>extends</tt> keyword.
|
|
|
|
|
Added experimental <a href="http://narwhaljs.org/">Narwhal</a>
|
|
|
|
|
support (as a Tusk package), contributed by
|
|
|
|
|
<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>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
<b class="header" style="margin-top: 20px;">0.1.1</b>
|
2009-12-24 20:02:28 +00:00
|
|
|
Added <tt>instanceof</tt> and <tt>typeof</tt> as operators.
|
|
|
|
|
</p>
|
|
|
|
|
|
2009-12-24 08:12:07 +00:00
|
|
|
<p>
|
2009-12-25 01:05:55 +00:00
|
|
|
<b class="header" style="margin-top: 20px;">0.1.0</b>
|
2009-12-24 08:12:07 +00:00
|
|
|
Initial CoffeeScript release.
|
|
|
|
|
</p>
|
2009-12-21 16:41:45 +00:00
|
|
|
|
2009-12-20 03:55:58 +00:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
