https://github.com/shinnn/broccoli-livescript

A Broccoli plugin to compile LiveScript
https://github.com/shinnn/broccoli-livescript

Last synced: 27 days ago
JSON representation

A Broccoli plugin to compile LiveScript

• Host: GitHub
• URL: https://github.com/shinnn/broccoli-livescript
• Owner: shinnn
• License: mit
• Created: 2014-02-24T13:23:36.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2018-12-21T17:38:16.000Z (almost 6 years ago)
• Last Synced: 2024-10-04T07:37:44.356Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 21.5 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# broccoli-livescript

[![npm version](https://img.shields.io/npm/v/broccoli-livescript.svg)](https://www.npmjs.com/package/broccoli-livescript)

[![Build Status](https://travis-ci.com/shinnn/broccoli-livescript.svg?branch=master)](https://travis-ci.com/shinnn/broccoli-livescript)

[![Coverage Status](https://img.shields.io/coveralls/shinnn/broccoli-livescript.svg)](https://coveralls.io/github/shinnn/broccoli-livescript)

A [Broccoli](https://github.com/broccolijs/broccoli) plugin to compile [LiveScript](https://livescript.net/)

## Installation

[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/about-npm/).

```

npm install --save-dev broccoli-livescript

```

## API

```javascript

const liveScript = require('broccoli-livescript');

```

### liveScript(*tree* [, *options*])

*tree*: `string` or `Object` (broccoli tree)  

*options*: `Object` (directly passed to [LiveScript options](https://github.com/gkz/LiveScript/blob/1.6.0/src/index.ls#L35))  

Return: `Function`

#### options.bare

Type: `boolean`  

Default: `false`

Compile without the top-level function wrapper.

#### options.header

Type: `boolean`  

Default: `true`

`false` removes `"Generated by"` header.

```javascript

//Brocfile.js

const liveScript = require('broccoli-livescript');

module.exports = liveScript('scripts', {

  bare: true,

  header: false

});

```

## License

Copyright (c) 2014 - 2018 [Shinnosuke Watanabe](https://github.com/shinnn)

Licensed under [the MIT LIcense](./LICENSE).