require()'ing a CoffeeScript file from a JavaScript file or REPL

Question

I'm using Node.js and wanting to incorporate CoffeeScript into my workflow. I have two use-cases:

I want to be able to write JavaScript files which require() CoffeeScript modules
I want to be able to load CoffeeScript modules from within the node REPL

For case #1: I can just compile from .coffee to .js and require() the .js module, as a workaround.

For case #2: Right now I'm eval()ing the output of coffee-script.compile().

Is there a better, more unified way to do this?

That REPL is very primitive compared to the node one: it lacks colour, autocompletion, multi-line statements etc — nicolaskruchten, Jan 22 '11 at 19:06

score 95 · Accepted Answer · edited Feb 10 '14 at 13:05

95

The coffee-script module registers its extension once required.

$ echo 'console.log "works"' > module.coffee

$ echo '
> require("coffee-script")
> require("./module")
> ' > test.js

$ node test.js
works

$ node
> require('coffee-script'); require('./module')
works
{}

Edit: This behaviour has changed with the relase of CoffeeScript 1.7.0. Now you need to do:

require('coffee-script/register');

edited Feb 10 '14 at 13:05

TheHippo

61,720
15
75
100

answered Jan 22 '11 at 16:39

matyr

5,774
28
22

Huh, why didn't I think of that? :) – nicolaskruchten Jan 22 '11 at 19:03
2

`require.extensions` is now deprecated and there is no alternative yet. – vaughan Jun 22 '13 at 06:18
I expect it to stick around as it's a stable feature and, as you mentioned, there are not alternatives yet. – Gunchars Dec 14 '15 at 18:14

score 12 · Answer 2 · edited Jan 02 '13 at 15:51

12

A more versatile solution would be to use better-require.

npm install better-require

It lets you require() CoffeeScript files, no pre-compilation needed. (It also lets you require() a bunch of other file formats: CoffeeScript, clojurescript, yaml, xml, etc.)

In the case of CoffeeScript, it simply requires the coffee-script module.

require('better-require')();
var myModule = require('./mymodule.coffee');
var clojurescriptModule = require('./mymodule.cljs');
// etc.

Disclosure: I wrote better-require.

edited Jan 02 '13 at 15:51

Zearin

1,474
2
17
36

answered Nov 01 '12 at 15:19

Olivier Lalonde

19,423
28
76
91

1

the central problem with `require.extensions`—that registering an extension changes global state, for your entire application—is, sadly, not addressed by `better-require`, meaning that things will break if any of your 3rd party sub-modules happen to depend upon a different version of, say, Yaml, or CoffeeScript. – flow Nov 23 '13 at 20:43
better-require also doesn't load ".litcoffee" modules by default, whereas they can be loaded via `require('coffee-script/register');` – shaunc Mar 24 '15 at 17:44

require()'ing a CoffeeScript file from a JavaScript file or REPL

2 Answers2

Linked