# gulp-mina

**Repository Path**: tinajs/gulp-mina

## Basic Information

- **Project Name**: gulp-mina
- **Description**: split/precompile mina single-file-component
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-03-12
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# gulp-mina
> :oden: split/precompile mina single-file-component

[![npm](https://img.shields.io/npm/v/@tinajs/gulp-mina.svg?style=flat-square)](https://www.npmjs.com/package/@tinajs/gulp-mina)
[![license](https://img.shields.io/github/license/tinajs/gulp-mina.svg?style=flat-square)](./LICENSE)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

## Install
```bash
npm install --save-dev @tinajs/gulp-mina
```

## Usage
### Precompile mina single-file-component library
```javascript
const gulp = require('gulp')
const babel = require('gulp-babel')
const mina = require('@tinajs/gulp-mina')

gulp.task('default', () => {
  return gulp.src('src/**/*.mina')
    .pipe(mina({
      script: (stream) => stream.pipe(babel({ presets: ['env'] })),
    }))
    .pipe(gulp.dest('dist'))
})
```

[Example (more complicated)](./examples/precompile-mina-library)

### Split mina single-file-component to a group of files (``wxml``, ``wxss``, ``json`` and ``js``)
```javascript
const gulp = require('gulp')
const babel = require('gulp-babel')
const mina = require('@tinajs/gulp-mina')
gulp.task('default', ['clean'], () => {
  return gulp.src('src/**/*.mina')
    .pipe(mina.split({
      script: (stream) => stream.pipe(babel({ presets: ['env'] })),
    }))
    .pipe(gulp.dest('dist'))
})
```

[Example](./examples/split-to-a-group-of-files)

## API
### mina([mapping])
Separate mina-sfc to multiple streams, and pipe the recombined results down. 

#### mapping
Type: ``Object``  
Default: {}  

Each separated streams of mina-sfc file will be passed to these mapping functions.

##### script
Type: ``Function``  

Receive the stream of ``<script>`` part as a ``.js`` file.

##### config
Type: ``Function``  

Receive the stream of ``<config>`` part as a ``.json`` file.

##### style
Type: ``Function``  

Receive the stream of ``<style>`` part as a ``.wxss`` file.

##### template
Type: ``Function``  

Receive the stream of ``<template>`` part as a ``.wxml`` file.

### mina.split([mapping])
Just like ``mina([mapping])``, but pipe separated mina-sfc as multiple files to the downstream.

## Related
- [gulp](https://github.com/gulpjs/gulp)
- [mina-sfc](https://github.com/tinajs/mina-sfc)

## License
MIT &copy; [yelo](https://github.com/imyelo), 2017 - present