Skip to content

Latest commit

 

History

History
128 lines (101 loc) · 4.82 KB

gulp.md

File metadata and controls

128 lines (101 loc) · 4.82 KB

gulp

gulp

一、入门指南

  1. 全局安装 gulp： $ npm install --global gulp

  2. 作为项目的开发依赖（devDependencies）安装： $ npm install --save-dev gulp

  3. 在项目根目录下创建一个名为 gulpfile.js 的文件：

var gulp = require('gulp');

gulp.task('default', function() {
  // 将你的默认的任务代码放在这
});
  1. 运行 gulp： $ gulp

默认的名为 default 的任务（task）将会被运行，在这里，这个任务并未做任何事情。

二、API文档

s.pipe(fn)

pipe方法传入方法的是一个function，这个function作用无非是接受上一个流（stream）的结果
并返回一个处理后流的结果(返回值应该是一个stream对象)。
注意的是这个函数只是一个包装，并不是会直接操作文件的。

gulp.src(globs[, options])

  1. 说明：src方法是指定需要处理的源文件的路径，gulp借鉴了Unix操作系统的管道（pipe）思想，前一级的输出，直接变成后一级的输入，gulp.src返回当前文件流至可用插件；

  2. globs： 需要处理的源文件匹配符路径。类型(必填)：String or StringArray；

通配符路径匹配示例：

  • “src/a.js”：指定具体文件；
  • “”：匹配所有文件 例：src/.js(包含src下的所有js文件)；
  • “”：匹配0个或多个子文件夹 例：src//*.js(包含src的0个或多个子文件夹下的js文件)；
  • “{}”：匹配多个属性 例：src/{a,b}.js(包含a.js和b.js文件) src/*.{jpg,png,gif}(src下的所有jpg/png/gif文件)；
  • “!”：排除文件 例：!src/a.js(不包含src下的a.js文件)；
var gulp = require('gulp'),
    less = require('gulp-less');
 
gulp.task('testLess', function () {
    //gulp.src('less/test/style.less')
    gulp.src(['less/**/*.less','!less/{extend,page}/*.less'])
        .pipe(less())
        .pipe(gulp.dest('./css'));
});
  1. options：类型(可选)：Object，有3个属性buffer、read、base；
  • options.buffer：类型：Boolean 默认：true 设置为false，将返回file.content的流并且不缓冲文件，处理大文件时非常有用；
  • options.read：类型：Boolean 默认：true 设置false，将不执行读取文件操作，返回null；
  • options.base：类型：String 设置输出路径以某个路径的某个组成部分为基础向后拼接，具体看下面示例：
gulp.src('client/js/**/*.js') 
  .pipe(minify())
  .pipe(gulp.dest('build'));  // Writes 'build/somedir/somefile.js'
 
gulp.src('client/js/**/*.js', { base: 'client' })
  .pipe(minify())
  .pipe(gulp.dest('build'));  // Writes 'build/js/somedir/somefile.js'

gulp.dest(path[, options])

  1. 说明：dest方法是指定处理完后文件输出的路径；
gulp.src('./client/templates/*.jade')
  .pipe(jade())
  .pipe(gulp.dest('./build/templates'))
  .pipe(minify())
  .pipe(gulp.dest('./build/minified_templates'));

  1. path： 类型(必填)：String or Function 指定文件输出路径，或者定义函数返回文件输出路径亦可；

  2. options：类型(可选)：Object，有2个属性cwd、mode；

  • options.cwd：类型：String 默认：process.cwd()：前脚本的工作目录的路径 当文件输出路径为相对路径将会用到；
  • options.mode：类型：String 默认：0777 指定被创建文件夹的权限；

gulp.task(name[, deps], fn)

  1. 说明：task定义一个gulp任务；
  2. name：类型(必填)：String 指定任务的名称（不应该有空格）；
  3. deps：类型(可选)：StringArray，该任务依赖的任务（注意：被依赖的任务需要返回当前任务的事件流，请参看下面示例）；
gulp.task('testLess', function () {
    return gulp.src(['less/style.less'])
        .pipe(less())
        .pipe(gulp.dest('./css'));
});
 
gulp.task('minicss', ['testLess'], function () { //执行完testLess任务后再执行minicss任务
    gulp.src(['css/*.css'])
        .pipe(minifyCss())
        .pipe(gulp.dest('./dist/css'));
});
  1. fn： 类型(必填)：Function 该任务调用的插件操作；

gulp.watch(glob [, opts], tasks) 或 gulp.watch(glob [, opts, cb])

  1. 说明：watch方法是用于监听文件变化，文件一修改就会执行指定的任务；
  2. glob：需要处理的源文件匹配符路径。类型(必填)：String or StringArray；
  3. opts：类型(可选)：Object 具体参看 https://github.com/shama/gaze；
  4. tasks：类型(必填)：StringArray 需要执行的任务的名称数组；
  5. cb(event)：类型(可选)：Function 每个文件变化执行的回调函数；
gulp.task('watch1', function () {
    gulp.watch('less/**/*.less', ['testLess']);
});
 
gulp.task('watch2', function () {
    gulp.watch('js/**/*.js', function (event) {
        console.log('File ' + event.path + ' was ' + event.type + ', running tasks...');
    });
});