191

What are my restrictions if I want to code node.js and use CoffeeScript? Can I do anything I'd be able to do in JS?

Teun Zengerink
  • 4,277
  • 5
  • 30
  • 32
donald
  • 23,587
  • 42
  • 142
  • 223

8 Answers8

178

Yes, CoffeeScript simply compiles into pure JS, making it completely compatible with node.js.

To run CoffeeScripts on node, you can either:

  • Type coffee -c example.coffee to compile, followed by node example.js to run the compiled JS.
  • Simply type coffee example.coffee
David Tang
  • 92,262
  • 30
  • 167
  • 149
  • @donald, I'm not aware of any combined CoffeeScript + Node tutorials. Learning them separately is ideal. The link I gave above for Node is a perfect introduction, and for CoffeeScript, this is all you need: http://jashkenas.github.com/coffee-script/ – David Tang Jan 13 '11 at 23:23
  • @donald here, try this one: http://nodetuts.com/tutorials/16-introduction-to-coffeescript-and-nodejs.html#video – jcollum Mar 15 '12 at 20:34
  • 2
    But what about when using other CoffeeScript files? I don't want to put everything in 1 CoffeeScript – Jiew Meng Jun 10 '12 at 12:32
  • 3
    @Jiew Meng you can compile a whole directory in the same way (replace example.coffee with the directory path), or you can `require` uncompiled coffeescript files as long as you `require('coffee-script')` beforehand. – David Tang Jun 12 '12 at 03:47
  • 1
    Is running `coffee example.coffee` primarily for development? Or is it stable enough to do in production? – mrmagooey Jun 12 '13 at 11:00
  • 5
    Yeah, what's the difference between the two choices? – Steve Bennett Oct 02 '13 at 02:50
  • 4
    To install coffee `sudo npm install -g coffee-script` – Dmitry Polushkin Nov 06 '13 at 12:44
  • worth pointing out - I've found in some cases that only the version coffee example.coffee will work - worth giving that a shot before you try to debug javascript exceptions – Jordan Mar 09 '15 at 17:10
90

Not only can you run CoffeeScript files directly in Node with

coffee source.coffee

you can also require them as if they were JavaScript files. For instance, if you have lib.coffee in a directory, you can write

require './lib'

from another CoffeeScript file in the same directory. (In order to do this from a JavaScript file, you'll have to add require 'coffee-script' at the top.) So, you never have to do compilation explicitly under Node, unless you're packaging your project for deployment with a tool like npm.

One caveat: In stack traces, the line numbers you'll see refer to the compiled JavaScript, even when you're running CoffeeScript directly (so you don't have access to the JavaScript). A lot of folks are trying to fix this, but it's a big challenge.

Trevor Burnham
  • 76,828
  • 33
  • 160
  • 196
57

Yes, here's a different & simpler answer. You need to do 2 steps.

  1. npm install coffee-script --save # I assume you would have done this already.

  2. Have require('coffee-script') as the first line that would get executed in server.js of app.js. (UPDATE: since coffee script 1.7, you will have to do require('coffee-script/register'))

This registers coffeescript compiler to your app and you can start treating coffee files and js files equally now (meaning that you can require coffee files too !).

This method will require you to write just the one file (app.js) in vanilla javascript. But the advantage is that your deploy environment need not have coffeescript as an initial globally installed dependency to run your app. In this case, you would just have to copy over your code, and npm install would install all packages necessary. And npm start would have you up and running

Electric Coffee
  • 11,733
  • 9
  • 70
  • 131
gprasant
  • 15,589
  • 9
  • 43
  • 57
  • 2
    Thanks for the note about the 1.7 update @gprasant, I was pulling my hair out wondering why this stopped working. – pix0r Apr 29 '14 at 07:48
15

Video Tutorials

I've seen a great tutorial series by Pedro Teixeira. He's been building an entire series on node tutorials. He includes reference to nodemon for auto detection and compilation and reloading of edited .coffee files.

  1. Coffeescript and Node.js
  2. Nodemon
Mark Essel
  • 4,606
  • 2
  • 29
  • 47
11

You can use Jitter, a Simple continuous compilation for CoffeeScript.

npm install -g jitter

Let's say you have a bunch of *.coffee files in the coffee directory, and want to compile them to the js directory. Then run:

jitter coffee js

Jitter runs in the background until you terminate it (Ctrl+C), watching for new changes.

Roger Garzon Nieto
  • 6,554
  • 2
  • 28
  • 24
8

Coffeescript + ExpressJS + Couchdb + Redis + Auth:

https://gist.github.com/652819

Shripad Krishna
  • 10,463
  • 4
  • 52
  • 65
6

Try this

#!/usr/bin/env coffee
v = 78
console.log "The value of v is '#{v}'"

Then do:

chmod +x demo.coffee
./demo.coffee

CoffeeScript has pretty solid integration with node. Once the 'coffee-script' module is loaded, either by require('coffee-script'), by the she-bang I demo'd above, or by running coffee demo.coffee ... once loaded, you can used require('./foo') to bring in foo.coffee

Dave Dopson
  • 41,600
  • 19
  • 95
  • 85
0

If you want to automatically compile all your coffeescript files (in one directory including subdir) every time they change into javascript, just use this command:

find . -name '*.coffee' -type f -print0 | xargs -0 coffee -wc
phs
  • 10,687
  • 4
  • 58
  • 84
Taner Topal
  • 921
  • 8
  • 14