Coffeescript plugin for gulp
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test Remove unneeded Mocha require statement Apr 8, 2018
.gitignore 3.0.3 Nov 1, 2018
.npmignore closes #82 Dec 31, 2017
.travis.yml closes #81 Dec 31, 2017
LICENSE dep updates Nov 13, 2016
README.md Update repo location Apr 8, 2018
index.js Avoid implicit type coercion Apr 8, 2018
package.json 3.0.3 Nov 1, 2018

README.md

Build Status

Information

Packagegulp-coffee
Description Compiles CoffeeScript
Node Version >= 6

Usage

var coffee = require('gulp-coffee');

gulp.task('coffee', function() {
  gulp.src('./src/*.coffee')
    .pipe(coffee({bare: true}))
    .pipe(gulp.dest('./public/'));
});

Options

  • coffee (optional): A reference to a custom CoffeeScript version/fork (eg. coffee: require('my-name/coffeescript'))

Additionally, the options object supports all options that are supported by the standard CoffeeScript compiler.

Source maps

gulp 3.x

gulp-coffee can be used in tandem with gulp-sourcemaps to generate source maps for the coffee to javascript transition. You will need to initialize gulp-sourcemaps prior to running the gulp-coffee compiler and write the source maps after.

var sourcemaps = require('gulp-sourcemaps');

gulp.src('./src/*.coffee')
  .pipe(sourcemaps.init())
  .pipe(coffee())
  .pipe(sourcemaps.write())
  .pipe(gulp.dest('./dest/js'));

// will write the source maps inline in the compiled javascript files

By default, gulp-sourcemaps writes the source maps inline in the compiled javascript files. To write them to a separate file, specify a relative file path in the sourcemaps.write() function.

var sourcemaps = require('gulp-sourcemaps');

gulp.src('./src/*.coffee')
  .pipe(sourcemaps.init())
  .pipe(coffee({ bare: true }))
  .pipe(sourcemaps.write('./maps'))
  .pipe(gulp.dest('./dest/js'));

// will write the source maps to ./dest/js/maps

gulp 4.x

In gulp 4, sourcemaps are built-in by default.

gulp.src('./src/*.coffee', { sourcemaps: true })
  .pipe(coffee({ bare: true }))
  .pipe(gulp.dest('./dest/js'));

LICENSE

(MIT License)

Copyright (c) 2015 Fractal contact@wearefractal.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.