Jump to Section
via Package Control
This is the recommended installation method.
If you have Sublime Package Control, you know what to do. If not, well: it's a package manager for Sublime Text 2; it's awesome and you can read about it here.
To install Package Control, open the Python Console (
cmd+`) and paste the following into it:
import urllib2,os; pf='Package Control.sublime-package'; ipp=sublime.installed_packages_path(); os.makedirs(ipp) if not os.path.exists(ipp) else None; urllib2.install_opener(urllib2.build_opener(urllib2.ProxyHandler())); open(os.path.join(ipp,pf),'wb').write(urllib2.urlopen('http://sublime.wbond.net/'+pf.replace(' ','%20')).read()); print 'Please restart Sublime Text to finish installation'
After installing the package and restarting the editor:
- Open the Command Pallete (
- Type "Install Package" and hit return.
- Type "CoffeeScript" and hit return.
via Source Control
If you plan to contribute, then you should install via this method. Otherwise it is recommended that you install the package via Package Control, see above.
Sublime stores packages in the following locations:
Nix: ~/.config/sublime-text-2/packages Mac: ~/Library/Application\ Support/Sublime\ Text\ 2/Packages Win: %APPDATA%\Sublime Text 2\Packages
As a repository within the packages directory
Open a Terminal/Console and run the following commands, replacing
PACKAGE_PATH with the path corresponding to your OS above.
cd PACKAGE_PATH git clone https://github.com/Xavura/CoffeeScript-Sublime-Plugin.git CoffeeScript
As a repository outside of the packages directory
If you use Github for Mac/Windows which store repositories in a specific location, or if you just don't want a repository in your packages directory, then instead you can use a link.
If you don't yet have the repository, then grab it via your GUI program or via the command line:
cd WHEREVER_YOU_WANT git clone https://github.com/Xavura/CoffeeScript-Sublime-Plugin.git
Once that is done, we will create the link:
cd PACKAGE_PATH mklink /D CoffeeScript ABSOLUTE_PATH_TO_REPOSITORY
cd PACKAGE_PATH ln -s ABSOLUTE_PATH_TO_REPOSITORY CoffeeScript
A note on Package Control
When Package Control tries to update your packages, if you have a repository in your packages directory then it will try to pull down and merge any changes. If you don't want this to happen and would rather handle everything yourself, then you can add the following to your settings (Preferences » Package Settings » Package Control » Settings - User):
If you are using Package Control, updating will be automatic and you don't have to worry about it.
If using Source Control:
cd PACKAGE_PATH/CoffeeScript git fetch origin git merge origin/master
You can access the commands either using the command palette (
cmd+shift+P) or via shortcuts.
Note: Some of the commands use the Status Bar for output, so you'll probably want to enable it (Tools » Show Status Bar).
TABto run a snippet after typing the trigger.
shift+TABto cycle forward/backward through fields.
ESCto exit snippet mode.
Array: forin Object: forof Range: fori (inclusive) Range: forx (exclusive)
If: if Else: el If Else: ifel Else If: elif Switch: swi Ternary: ter Try Catch: try Unless: unl
Class - cla
Function: - Function: = (bound) Interpolation: #
When using the build system, it is assumed that your
.sublime-projectfile lives in your project's base directory (due to limitations with the build system).
F7 (Tools » Build) will run the Cake task 'sbuild'.
If you're not quite sure what the point of this is then read on.
Let's say before distributing your project that you would like to combine all of your
.js files into one and then minify them them using UglifyJS or something.
That's what this is for! You would create a
Cakefile and inside it you would write a task:
task 'sbuild', 'Prepare project for distribution.', -> # ...
Examples coming soon.