Coder Social home page Coder Social logo

grunt-coffee's Introduction

grunt-coffee

JavaScripts your Coffee

Getting Started

Install this grunt plugin next to your project's grunt.js gruntfile with: npm install grunt-coffee

Then add this line to your project's grunt.js gruntfile:

grunt.loadNpmTasks('grunt-coffee');

Documentation

You'll need to install grunt-coffee first:

npm install grunt-coffee

Then modify your grunt.js file by adding the following line:

grunt.loadNpmTasks('grunt-coffee');

Then add some configuration for the plugin like so:

grunt.initConfig({
    ...
    coffee: {
      app: {
        src: ['path/to/coffee/files/*.coffee'],
        dest: 'where/you/want/your/js/files',
        options: {
            bare: true
        }
      }
    },
    ...
});

Then just run grunt coffee and enjoy!

Grunt Coffee will, by default, run coffee with the --bare flag set. If you want to run it with the top level variable safety, make sure you set your options to:

options: {
    bare: false
}

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

0.0.2 - added the options object, thanks Derek! 0.0.1 - The bare minimum necessary... don't expect it to work

License

Copyright (c) 2012 Aaron D. Valade Licensed under the MIT license.

grunt-coffee's People

Contributors

avalade avatar jfhbrook avatar petebacondarwin avatar timoxley avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.