-
Notifications
You must be signed in to change notification settings - Fork 71
/
Copy pathindex.html
159 lines (119 loc) · 4.79 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<link href='https://fonts.googleapis.com/css?family=Architects+Daughter' rel='stylesheet' type='text/css'>
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen" />
<link rel="stylesheet" type="text/css" href="stylesheets/pygment_trac.css" media="screen" />
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<title>CoffeeScript Sublime Plugin by Xavura</title>
</head>
<body>
<header>
<div class="inner">
<h1>CoffeeScript Sublime Plugin</h1>
<h2></h2>
<a href="https://github.com/Xavura/CoffeeScript-Sublime-Plugin" class="button"><small>View project on</small>GitHub</a>
</div>
</header>
<div id="content-wrapper">
<div class="inner clearfix">
<section id="main-content">
<h1>Installation</h1>
<p><strong>Package Path</strong></p>
<p>Sublime stores packages in the following locations:</p>
<pre><code>Nix: ~/.config/sublime-text-2/packages
Mac: ~/Library/Application\ Support/Sublime\ Text\ 2/Packages
Win: %APPDATA%\Sublime Text 2\Packages
</code></pre>
<p>When you see <em>PACKAGE_PATH</em>, replace it with one of the above.</p>
<h3>Nix/Mac</h3>
<pre><code>cd PACKAGE_PATH
git clone https://github.com/Xavura/CoffeeScript-Sublime-Plugin.git CoffeeScript
</code></pre>
<h1>Updating</h1>
<pre><code>cd PACKAGE_PATH/CoffeeScript
git fetch origin
git merge origin/master
</code></pre>
<h1>Commands/Shortcuts</h1>
<p>You can access the commands either using the command palette (meta+shift+P) or via shortcuts.</p>
<pre><code>alt+shift+t - Run a Cake task
alt+shift+r - Run some CoffeeScript (puts/print for output)
alt+shift+s - Run a syntax check
alt+shift+c - Compile a file
alt+shift+d - Display compiled JavaScript
alt+shift+l - Display lexer tokens
alt+shift+n - Display parser nodes
alt+shift+w - Toggle watch mode
alt+shift+z - Toggle output panel
</code></pre>
<p><strong>Note:</strong> Some of the commands use the status bar for output, so you'll probably want to enable it (Tools - Show Status Bar)</p>
<h1>Snippets</h1>
<ul>
<li>Use <code>TAB</code> to run a snippet after typing the trigger.</li>
<li>Use <code>TAB</code> & <code>shift+TAB</code> to cycle forward/backward through fields.</li>
<li>Use <code>ESC</code> to exit snippet mode.</li>
</ul><h3>Snippet Triggers</h3>
<p><strong>Comprehension</strong></p>
<pre><code>Array: forin
Object: forof
Range: fori (inclusive)
Range: forx (exclusive)
</code></pre>
<p><strong>Statements</strong></p>
<pre><code>If: if
Else: el
If Else: ifel
Else If: elif
Switch: swi
Ternary: ter
Try Catch: try
Unless: unl
</code></pre>
<p><strong>Classes</strong></p>
<pre><code>Class - cla
</code></pre>
<p><strong>Other</strong></p>
<pre><code>Function: -
Function: = (bound)
Interpolation: #
</code></pre>
<h1>Building</h1>
<p>Hitting <code>F7</code> (Tools - Build) will run the Cake task 'sbuild'.</p>
<h1>Settings</h1>
<p><strong>binDir</strong>
If your Coffee binary isn't in <code>/usr/local/bin</code> then you can change this.</p>
<p><strong>noWrapper</strong>
Compile without the top level function wrapper (<code>coffee --bare</code>).</p>
<p><strong>watchEnabled</strong>
Globally enable/disable watch mode (a wrapper over <code>coffee --watch</code>).</p>
<p><strong>watchOutputMode</strong>
Where output from watch mode will be sent (panel, status, console).</p>
<p><strong>watchOutputOnSuccess
watchOutputOnFailure</strong>
Useful if you, for instance, only want to show compile errors.</p>
<p><strong>watchHighlightErrors</strong>
Files will be automagically opened, if they contain an error. Also, your cursor shall of course be placed on the offending line.</p>
</section>
<aside id="sidebar">
<a href="https://github.com/Xavura/CoffeeScript-Sublime-Plugin/zipball/master" class="button">
<small>Download</small>
.zip file
</a>
<a href="https://github.com/Xavura/CoffeeScript-Sublime-Plugin/tarball/master" class="button">
<small>Download</small>
.tar.gz file
</a>
<p class="repo-owner"><a href="https://github.com/Xavura/CoffeeScript-Sublime-Plugin"></a> is maintained by <a href="https://github.com/Xavura">Xavura</a>.</p>
<p>This page was generated by <a href="pages.github.com">GitHub Pages</a> using the Architect theme by <a href="http://twitter.com/jasonlong">Jason Long</a>.</p>
</aside>
</div>
</div>
</body>
</html>