Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Append //@ sourceURL=... to your Coffeescript files that will survive compilation and preserve source mapping.
CoffeeScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
tasks
.gitignore
LICENSE-MIT
README.md
package.json

README.md

grunt-coffeescript-sourceurl

Append //@ sourceURL=... to your cCoffeescript files and preserve source mapping.

Getting Started

This plugin requires Grunt ~0.4.1

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-coffeescript-sourceurl --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-coffeescript-sourceurl');

The "sourceurl" task

Overview

In your project's Gruntfile, add a section named sourceurl to the data object passed into grunt.initConfig().

grunt.initConfig({
  sourceurl: {
    your_target: {
      src: 'path/to/coffee/files/**/*.coffee',
      basePath: 'path/to/coffee'  // all the sourceURLs will be relative to this directory
    },
  },
})

Note: if no destination is supplied, the files will be overwritten in place.

Options

options.basePath

Type: String Default value: '.'

All the sourceURLs will be relative to this directory

Usage Examples

Default Options

In this example, the default options are used to do something with whatever. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result would be Testing, 1 2 3.

grunt.initConfig({
  sourceurl: {
    foo: {
      src: ['src/testing', 'src/123'],
      basePath: 'src'
    },
  },
})

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)

Something went wrong with that request. Please try again.