Grunt plugin for compiling LiveScript
JavaScript
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
tasks
test
.gitattributes
.gitignore
.jshintrc
Gruntfile.js
LICENSE-MIT
README.md
package.json

README.md

grunt-lsc

Grunt plugin for compiling LiveScript files.

NPM

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-lsc --save-dev

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

grunt.loadNpmTasks('grunt-lsc');

The "lsc" task

Overview

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

grunt.initConfig({
  lsc: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

options.bare

Type: Boolean Default value: false

Disables toplevel function wrappers in the compiled JavaScript if this option is set to true.

options.join

Type: Boolean Default value: false

A true value means the LiveScript source files will first be concatenated into one before being fed to the compiler, whereas the default behavior is to compile each file separately and join the results into one file at the end.

Usage Examples

grunt.initConfig({
  lsc: {
    noOptions: {
      files: {
        'tmp/click.js': ['test/fixtures/click.ls'],
        'tmp/compiledThenJoined.js': ['test/fixtures/take.ls', 'test/fixtures/click.ls']
      }
    },
    bare: {
      options: {
        bare: true
      },
      files: {
        'tmp/bareClick.js': ['test/fixtures/click.ls'],
        'tmp/bareCompiledThenJoined.js': ['test/fixtures/take.ls', 'test/fixtures/click.ls']
      }
    },
    join: {
      options: {
        join: true
      },
      files: {
        'tmp/joinedThenCompiled.js': ['test/fixtures/take.ls', 'test/fixtures/click.ls']
      }
    },
    bareAndJoin: {
      options: {
        bare: true,
        join: true
      },
      files: {
        'tmp/bareJoinedThenCompiled.js': ['test/fixtures/take.ls', 'test/fixtures/click.ls']
      }
    },
  },
})

Release History

  • 1.0.1 - Updated for LiveScript 1.2 (courtesy of @gmp26).
  • 1.0 - Initial release.