coffee-loader
Compile CoffeeScript to JavaScript.
Getting Started
To begin, you'll need to install coffeescript and coffee-loader:
npm install --save-dev coffeescript coffee-loader copy
or
yarn add -D coffeescript coffee-loader copy
or
pnpm add -D coffeescript coffee-loader copy
Then add the loader to your webpack.config.js. For example:
file.coffee
# Assignment:
number = 42
opposite = true
# Conditions:
number = - 42 if opposite
# Functions:
square = (x) -> x * x
# Arrays:
list = [ 1 , 2 , 3 , 4 , 5 ]
# Objects:
math =
root : Math .sqrt
square : square
cube : (x) -> x * square x
webpack.config.js
module . exports = {
module: {
rules: [
{
test: /\.coffee$/ ,
loader: "coffee-loader" ,
},
],
},
}; copy
Alternative usage:
import coffee from "coffee-loader!./file.coffee" ; copy
Finally, run webpack using the method you normally use (e.g., via CLI or an npm script).
Options
Type: Object
Default: { bare: true }
You can find all available CoffeeScript options here .
For documentation on the transpile option, see this section .
[!NOTE]
The sourceMap option takes a value from the compiler.devtool value by default.
[!NOTE]
The filename option takes a value from webpack loader API, but it's value will be ignored.
webpack.config.js
module . exports = {
module: {
rules: [
{
test: /\.coffee$/ ,
loader: "coffee-loader" ,
options: {
bare: false ,
transpile: {
presets: [ "@babel/env" ],
},
},
},
],
},
}; copy
Examples
CoffeeScript and Babel
From CoffeeScript 2 documentation:
[!NOTE]
CoffeeScript 2 generates JavaScript using the latest, modern syntax.
The runtime or browsers where you want your code to run might not support all of that syntax.
In that case, modern JavaScript needs to be converted into an older JavaScript that will run in older versions of Node or older browsers; for example: { a } = obj into a = obj.a.
This conversion is done using transpilers like Babel, Bublé or Traceur Compiler.
You'll need to install @babel/core and @babel/preset-env and then create a configuration file:
npm install --save-dev @babel/core @babel/preset-env
echo '{ "presets": ["@babel/env"] }' > .babelrc copy
webpack.config.js
module . exports = {
module: {
rules: [
{
test: /\.coffee$/ ,
loader: "coffee-loader" ,
options: {
transpile: {
presets: [ "@babel/env" ],
},
},
},
],
},
}; copy
Literate CoffeeScript
To use Literate CoffeeScript you should setup:
webpack.config.js
module . exports = {
module: {
rules: [
{
test: /\.coffee$/ ,
loader: "coffee-loader" ,
options: {
literate: true ,
},
},
],
},
}; copy
Contributing
Please take a moment to read our contributing guidelines if you haven't yet done so.
License
MIT