Skip to content

Commit a9bd53d

Browse files
jashkenasjashkenas
authored
Merge pull request #4448 from GeoffreyBooth/2-docs-on-master
2 docs on master
2 parents 91e3f72 + f8ce1a8 commit a9bd53d

31 files changed

+34664
-0
lines changed

‎docs/v1/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -610,6 +610,7 @@
610610
<p><strong>Latest Version:</strong> <a href="http://github.com/jashkenas/coffeescript/tarball/1.12.4">1.12.4</a></p>
611611
<blockquote>
612612
<pre><code>npm install -g coffee-script</code></pre></blockquote>
613+
<p><strong>CoffeeScript 2 is coming!</strong> It adds support for <a href="v2/#classes">ES2015 classes</a>, <a href="v2/#fat-arrow"><code>async</code>/<code>await</code></a>, and generates JavaScript using ES2015+ syntax. <a href="v2/">Learn more</a>.</p></p>
613614

614615
<h2>Overview</h2><p><em>CoffeeScript on the left, compiled JavaScript output on the right.</em></p>
615616
<div class='code'><pre><code><span class="comment"># Assignment:</span>

‎docs/v2/annotated-source/browser.html‎

Lines changed: 319 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,319 @@
1+
<!DOCTYPE html>
2+
3+
<html>
4+
<head>
5+
<title>browser.coffee</title>
6+
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
7+
<meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
8+
<link rel="stylesheet" media="all" href="docco.css" />
9+
</head>
10+
<body>
11+
<div id="container">
12+
<div id="background"></div>
13+
14+
<ul id="jump_to">
15+
<li>
16+
<a class="large" href="javascript:void(0);">Jump To &hellip;</a>
17+
<a class="small" href="javascript:void(0);">+</a>
18+
<div id="jump_wrapper">
19+
<div id="jump_page_wrapper">
20+
<div id="jump_page">
21+
22+
23+
<a class="source" href="browser.html">
24+
browser.coffee
25+
</a>
26+
27+
28+
<a class="source" href="cake.html">
29+
cake.coffee
30+
</a>
31+
32+
33+
<a class="source" href="coffeescript.html">
34+
coffeescript.coffee
35+
</a>
36+
37+
38+
<a class="source" href="command.html">
39+
command.coffee
40+
</a>
41+
42+
43+
<a class="source" href="grammar.html">
44+
grammar.coffee
45+
</a>
46+
47+
48+
<a class="source" href="helpers.html">
49+
helpers.coffee
50+
</a>
51+
52+
53+
<a class="source" href="index.html">
54+
index.coffee
55+
</a>
56+
57+
58+
<a class="source" href="lexer.html">
59+
lexer.coffee
60+
</a>
61+
62+
63+
<a class="source" href="nodes.html">
64+
nodes.coffee
65+
</a>
66+
67+
68+
<a class="source" href="optparse.html">
69+
optparse.coffee
70+
</a>
71+
72+
73+
<a class="source" href="register.html">
74+
register.coffee
75+
</a>
76+
77+
78+
<a class="source" href="repl.html">
79+
repl.coffee
80+
</a>
81+
82+
83+
<a class="source" href="rewriter.html">
84+
rewriter.coffee
85+
</a>
86+
87+
88+
<a class="source" href="scope.html">
89+
scope.litcoffee
90+
</a>
91+
92+
93+
<a class="source" href="sourcemap.html">
94+
sourcemap.litcoffee
95+
</a>
96+
97+
</div>
98+
</div>
99+
</li>
100+
</ul>
101+
102+
<ul class="sections">
103+
104+
<li id="title">
105+
<div class="annotation">
106+
<h1>browser.coffee</h1>
107+
</div>
108+
</li>
109+
110+
111+
112+
<li id="section-1">
113+
<div class="annotation">
114+
115+
<div class="pilwrap ">
116+
<a class="pilcrow" href="#section-1">&#182;</a>
117+
</div>
118+
<p>This <strong>Browser</strong> compatibility layer extends core CoffeeScript functions
119+
to make things work smoothly when compiling code directly in the browser.
120+
We add support for loading remote Coffee scripts via <strong>XHR</strong>, and
121+
<code>text/coffeescript</code> script tags, source maps via data-URLs, and so on.</p>
122+
123+
</div>
124+
125+
<div class="content"><div class='highlight'><pre>
126+
CoffeeScript = <span class="hljs-built_in">require</span> <span class="hljs-string">'./coffeescript'</span>
127+
CoffeeScript.<span class="hljs-built_in">require</span> = <span class="hljs-built_in">require</span>
128+
compile = CoffeeScript.compile</pre></div></div>
129+
130+
</li>
131+
132+
133+
<li id="section-2">
134+
<div class="annotation">
135+
136+
<div class="pilwrap ">
137+
<a class="pilcrow" href="#section-2">&#182;</a>
138+
</div>
139+
<p>Use standard JavaScript <code>eval</code> to eval code.</p>
140+
141+
</div>
142+
143+
<div class="content"><div class='highlight'><pre>CoffeeScript.eval = <span class="hljs-function"><span class="hljs-params">(code, options = {})</span> -&gt;</span>
144+
options.bare ?= <span class="hljs-literal">on</span>
145+
eval compile code, options</pre></div></div>
146+
147+
</li>
148+
149+
150+
<li id="section-3">
151+
<div class="annotation">
152+
153+
<div class="pilwrap ">
154+
<a class="pilcrow" href="#section-3">&#182;</a>
155+
</div>
156+
<p>Running code does not provide access to this scope.</p>
157+
158+
</div>
159+
160+
<div class="content"><div class='highlight'><pre>CoffeeScript.run = <span class="hljs-function"><span class="hljs-params">(code, options = {})</span> -&gt;</span>
161+
options.bare = <span class="hljs-literal">on</span>
162+
options.shiftLine = <span class="hljs-literal">on</span>
163+
Function(compile code, options)()</pre></div></div>
164+
165+
</li>
166+
167+
168+
<li id="section-4">
169+
<div class="annotation">
170+
171+
<div class="pilwrap ">
172+
<a class="pilcrow" href="#section-4">&#182;</a>
173+
</div>
174+
<p>If we’re not in a browser environment, we’re finished with the public API.</p>
175+
176+
</div>
177+
178+
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">return</span> <span class="hljs-keyword">unless</span> <span class="hljs-built_in">window</span>?</pre></div></div>
179+
180+
</li>
181+
182+
183+
<li id="section-5">
184+
<div class="annotation">
185+
186+
<div class="pilwrap ">
187+
<a class="pilcrow" href="#section-5">&#182;</a>
188+
</div>
189+
<p>Include source maps where possible. If we’ve got a base64 encoder, a
190+
JSON serializer, and tools for escaping unicode characters, we’re good to go.
191+
Ported from <a href="https://developer.mozilla.org/en-US/docs/DOM/window.btoa">https://developer.mozilla.org/en-US/docs/DOM/window.btoa</a></p>
192+
193+
</div>
194+
195+
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">if</span> btoa? <span class="hljs-keyword">and</span> JSON?
196+
<span class="hljs-function"> <span class="hljs-title">compile</span> = <span class="hljs-params">(code, options = {})</span> -&gt;</span>
197+
options.inlineMap = <span class="hljs-literal">true</span>
198+
CoffeeScript.compile code, options</pre></div></div>
199+
200+
</li>
201+
202+
203+
<li id="section-6">
204+
<div class="annotation">
205+
206+
<div class="pilwrap ">
207+
<a class="pilcrow" href="#section-6">&#182;</a>
208+
</div>
209+
<p>Load a remote script from the current domain via XHR.</p>
210+
211+
</div>
212+
213+
<div class="content"><div class='highlight'><pre>CoffeeScript.load = <span class="hljs-function"><span class="hljs-params">(url, callback, options = {}, hold = <span class="hljs-literal">false</span>)</span> -&gt;</span>
214+
options.sourceFiles = [url]
215+
xhr = <span class="hljs-keyword">if</span> <span class="hljs-built_in">window</span>.ActiveXObject
216+
<span class="hljs-keyword">new</span> <span class="hljs-built_in">window</span>.ActiveXObject(<span class="hljs-string">'Microsoft.XMLHTTP'</span>)
217+
<span class="hljs-keyword">else</span>
218+
<span class="hljs-keyword">new</span> <span class="hljs-built_in">window</span>.XMLHttpRequest()
219+
xhr.open <span class="hljs-string">'GET'</span>, url, <span class="hljs-literal">true</span>
220+
xhr.overrideMimeType <span class="hljs-string">'text/plain'</span> <span class="hljs-keyword">if</span> <span class="hljs-string">'overrideMimeType'</span> <span class="hljs-keyword">of</span> xhr
221+
xhr.onreadystatechange = <span class="hljs-function">-&gt;</span>
222+
<span class="hljs-keyword">if</span> xhr.readyState <span class="hljs-keyword">is</span> <span class="hljs-number">4</span>
223+
<span class="hljs-keyword">if</span> xhr.status <span class="hljs-keyword">in</span> [<span class="hljs-number">0</span>, <span class="hljs-number">200</span>]
224+
param = [xhr.responseText, options]
225+
CoffeeScript.run param... <span class="hljs-keyword">unless</span> hold
226+
<span class="hljs-keyword">else</span>
227+
<span class="hljs-keyword">throw</span> <span class="hljs-keyword">new</span> Error <span class="hljs-string">"Could not load <span class="hljs-subst">#{url}</span>"</span>
228+
callback param <span class="hljs-keyword">if</span> callback
229+
xhr.send <span class="hljs-literal">null</span></pre></div></div>
230+
231+
</li>
232+
233+
234+
<li id="section-7">
235+
<div class="annotation">
236+
237+
<div class="pilwrap ">
238+
<a class="pilcrow" href="#section-7">&#182;</a>
239+
</div>
240+
<p>Activate CoffeeScript in the browser by having it compile and evaluate
241+
all script tags with a content-type of <code>text/coffeescript</code>.
242+
This happens on page load.</p>
243+
244+
</div>
245+
246+
<div class="content"><div class='highlight'><pre><span class="hljs-function"><span class="hljs-title">runScripts</span> = -&gt;</span>
247+
scripts = <span class="hljs-built_in">window</span>.<span class="hljs-built_in">document</span>.getElementsByTagName <span class="hljs-string">'script'</span>
248+
coffeetypes = [<span class="hljs-string">'text/coffeescript'</span>, <span class="hljs-string">'text/literate-coffeescript'</span>]
249+
coffees = (s <span class="hljs-keyword">for</span> s <span class="hljs-keyword">in</span> scripts <span class="hljs-keyword">when</span> s.type <span class="hljs-keyword">in</span> coffeetypes)
250+
index = <span class="hljs-number">0</span>
251+
<span class="hljs-function">
252+
<span class="hljs-title">execute</span> = -&gt;</span>
253+
param = coffees[index]
254+
<span class="hljs-keyword">if</span> param <span class="hljs-keyword">instanceof</span> Array
255+
CoffeeScript.run param...
256+
index++
257+
execute()
258+
259+
<span class="hljs-keyword">for</span> script, i <span class="hljs-keyword">in</span> coffees
260+
<span class="hljs-keyword">do</span> (script, i) -&gt;
261+
options = literate: script.type <span class="hljs-keyword">is</span> coffeetypes[<span class="hljs-number">1</span>]
262+
source = script.src <span class="hljs-keyword">or</span> script.getAttribute(<span class="hljs-string">'data-src'</span>)
263+
<span class="hljs-keyword">if</span> source
264+
options.filename = source
265+
CoffeeScript.load source,
266+
<span class="hljs-function"><span class="hljs-params">(param)</span> -&gt;</span>
267+
coffees[i] = param
268+
execute()
269+
options
270+
<span class="hljs-literal">true</span>
271+
<span class="hljs-keyword">else</span></pre></div></div>
272+
273+
</li>
274+
275+
276+
<li id="section-8">
277+
<div class="annotation">
278+
279+
<div class="pilwrap ">
280+
<a class="pilcrow" href="#section-8">&#182;</a>
281+
</div>
282+
<p><code>options.filename</code> defines the filename the source map appears as
283+
in Developer Tools. If a script tag has an <code>id</code>, use that as the
284+
filename; otherwise use <code>coffeescript</code>, or <code>coffeescript1</code> etc.,
285+
leaving the first one unnumbered for the common case that there’s
286+
only one CoffeeScript script block to parse.</p>
287+
288+
</div>
289+
290+
<div class="content"><div class='highlight'><pre> options.filename = <span class="hljs-keyword">if</span> script.id <span class="hljs-keyword">and</span> script.id <span class="hljs-keyword">isnt</span> <span class="hljs-string">''</span> <span class="hljs-keyword">then</span> script.id <span class="hljs-keyword">else</span> <span class="hljs-string">"coffeescript<span class="hljs-subst">#{<span class="hljs-keyword">if</span> i <span class="hljs-keyword">isnt</span> <span class="hljs-number">0</span> <span class="hljs-keyword">then</span> i <span class="hljs-keyword">else</span> <span class="hljs-string">''</span>}</span>"</span>
291+
options.sourceFiles = [<span class="hljs-string">'embedded'</span>]
292+
coffees[i] = [script.innerHTML, options]
293+
294+
execute()</pre></div></div>
295+
296+
</li>
297+
298+
299+
<li id="section-9">
300+
<div class="annotation">
301+
302+
<div class="pilwrap ">
303+
<a class="pilcrow" href="#section-9">&#182;</a>
304+
</div>
305+
<p>Listen for window load, both in decent browsers and in IE.</p>
306+
307+
</div>
308+
309+
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">if</span> <span class="hljs-built_in">window</span>.addEventListener
310+
<span class="hljs-built_in">window</span>.addEventListener <span class="hljs-string">'DOMContentLoaded'</span>, runScripts, <span class="hljs-literal">no</span>
311+
<span class="hljs-keyword">else</span>
312+
<span class="hljs-built_in">window</span>.attachEvent <span class="hljs-string">'onload'</span>, runScripts</pre></div></div>
313+
314+
</li>
315+
316+
</ul>
317+
</div>
318+
</body>
319+
</html>

0 commit comments

Comments
 (0)