Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/e-jigsaw/gulp-riot
gulp plugin for riot
https://github.com/e-jigsaw/gulp-riot
Last synced: about 2 months ago
JSON representation
gulp plugin for riot
- Host: GitHub
- URL: https://github.com/e-jigsaw/gulp-riot
- Owner: e-jigsaw
- Created: 2015-01-25T06:18:00.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-12-07T02:53:30.000Z (about 6 years ago)
- Last Synced: 2024-10-11T23:27:10.257Z (2 months ago)
- Language: JavaScript
- Size: 178 KB
- Stars: 105
- Watchers: 7
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
gulp-riot [](http://badge.fury.io/js/gulp-riot) [](https://travis-ci.org/e-jigsaw/gulp-riot) [](https://devtoken.rocks/package/gulp-riot)
=========
[](https://www.npmjs.com/package/gulp-riot)
gulp plugin for riot
# Usage
This plugin compile [riot](https://github.com/muut/riotjs)'s `.tag` files.
## Example
`example.tag`:
```jsx
This is { sample }
this.sample = 'example'
```
`gulpfile.babel.js`:
```js
import gulp from 'gulp';
import riot from 'gulp-riot';
gulp.task('riot', ()=> {
gulp.src('example.tag')
.pipe(riot())
.pipe(gulp.dest('dest'));
});
```
Run task:
```sh
% gulp riot
% cat example.js
riot.tag('example', '
This is { sample }
', function(opts) {
this.sample = 'example'
})
```
## Compile options
This plugin can give riot's compile options.
```js
gulp.src('example.tag')
.pipe(riot({
compact: true // <- this
}))
.pipe(gulp.dest('dest'));
```
### Available option
* compact: `Boolean`
* Minify `
` to `
`
* whitespace: `Boolean`
* Escape `\n` to `\\n`
* expr: `Boolean`
* Run expressions through parser defined with `--type`
* type: `String, coffeescript | typescript | cs | es6 | livescript | none`
* JavaScript parser
* template: `String, jade`
* Template parser
* See more: https://muut.com/riotjs/compiler.html
* modular: `Boolean`
* For AMD and CommonJS option
* See more: http://riotjs.com/guide/compiler/#pre-compilation
* parsers: `Object`
* Define custom parsers
* css: `Function`
* See more: http://riotjs.com/api/compiler/#css-parser
* js: `Function`
* See more: http://riotjs.com/api/compiler/#js-parser
* html: `Function`
* See more: http://riotjs.com/api/compiler/#html-parser
# Installation
```sh
% npm install gulp-riot
```
# Requirements
* Node.js
* gulp
# Build
```sh
% npm run build
```
# Test
```sh
% npm test
```
# Author
* jigsaw (http://jgs.me, [@e-jigsaw](http://github.com/e-jigsaw))
* And contributors!
# License
MIT
The MIT License (MIT)
Copyright (c) 2015 Takaya Kobayashi
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.