使用gulp自动构建工具搭建具有自动刷新、文件合并、资源压缩的项目

1.创建项目骨架

新建三个文件夹,分别命名为 app,server,tasks。其中 app 里面放置我们写的 js 代码和视图(HTML)代码,error.ejs 指向出错界面,index.ejs 是默认页面。server 放置服务端代码。tasks 中放置构建工具的任务,util 下的 args.js 是处理命令行参数的一个文件。


2. 使用express脚手架创建服务端代码

进入 server 文件夹,一句命令 express -e .,-e 代表使用 ejs 模板引擎。ejs 是嵌入式 JavaScript 模板,文件以 .ejs 结尾。
输入这句命令后(首先要 npm install express)会提示 npm install 安装所需的依赖,安装完成后,server 文件夹下目录结构增加了这么多:

3.在 tasks 文件夹下创建构建工具

util/args.js

/**
 * 对命令行参数进行解析
 */

// node.js 命令行框架
import yargs from 'yargs';

const args = yargs
    .option('production', {
        // 生产环境,默认关闭
        boolean: true,
        default: false,
        describe: 'min all scripts'
    })
    .option('watch', {
        // 监听开发环境中的文件,自动更新
        boolean: true,
        default: false,
        describe: 'min all files'
    })
    .option('verbose', {
        // 输出命令行执行日志
        boolean: true,
        default: false,
        describe: 'log'
    })
    .option('sourcemaps', {
        // 压缩
        describe: 'force the creation of sourcemaps'
    })
    .option('port', {
        // 服务器端口
        string: true,
        default: 8080,
        describe: 'server port'
    })
    .argv;

export default args;

创建 scripts.js、pages.js、css.js、server.js

/**
 * gulp 自动化配置
 * 处理 js 代码
 */

import gulp from 'gulp';
// gulp 判断语句
import gulpif from 'gulp-if';
// 字符串拼接
import concat from 'gulp-concat';
// 构建
import webpack from 'webpack';
// 基于流的构建
import gulpWebpack from 'webpack-stream';
// 处理文件信息流
import plumber from 'gulp-plumber';
// 文件命名
import named from 'vinyl-named';
// 文件重命名
import rename from 'gulp-rename';
// 浏览器热更新
import livereload from 'gulp-livereload';
// css、js压缩
import uglify from 'gulp-uglify';
// 命令行输出
import { log, colors } from 'gulp-util';
// 对命令行参数进行解析
import args from './util/args';

// 使用 gulp 创建一个任务
gulp.task('scripts', () => {
    return gulp.src('app/js/*.js')
        // 错误日志检查处理
        .pipe(plumber({
            errorHandle: function() {

            }
        }))
        // 文件命名
        .pipe(named())
        // 遇到 js 文件时,用 babel 处理
        // npm install babel-loader babel-core babel-preset-env --save-dev
        .pipe(gulpWebpack({
            module: {
                loaders: [{
                    test: /\.js$/,
                    loader: 'babel'
                }]
            }
        }), null, (err, stats) => {
            log(`Finished '${colors.cyan('scripts')}'`, stats.toString({
                chunks: false
            }));
        })
        // 文件存放路径
        .pipe(gulp.dest('server/public/js'))
        // 备份并重命名
        .pipe(rename({
            basename: 'cp',
            extname: '.min.js'
        }))
        // 压缩
        .pipe(uglify({
            compress: {
                properties: false
            },
            output: {
                'quote_keys': true
            }
        }))
        // 文件存放路径
        .pipe(gulp.dest('server/public/js'))
        // 热更新,若命令行中有 watch 这个参数才执行
        .pipe(gulpif(args.watch, livereload()));
});
/**
 * gulp 自动化配置
 * 处理模板 views 信息
 */

import gulp from 'gulp';
// gulp 判断语句
import gulpif from 'gulp-if';
// 浏览器热更新
import livereload from 'gulp-livereload';
// 对命令行参数进行解析
import args from './util/args';

// 使用 gulp 创建一个任务
gulp.task('pages', () => {
    return gulp.src('app/**/*.ejs')
        // 文件存放路径
        .pipe(gulp.dest('server'))
        // 热更新,若命令行中有 watch 这个参数才执行
        .pipe(gulpif(args.watch, livereload()));
});
/**
 * gulp 自动化配置
 * 处理 css 文件
 */

import gulp from 'gulp';
// gulp 判断语句
import gulpif from 'gulp-if';
// 浏览器热更新
import livereload from 'gulp-livereload';
// 对命令行参数进行解析
import args from './util/args';

// 使用 gulp 创建一个任务
gulp.task('styles', () => {
    return gulp.src('app/**/*.css')
        // 文件存放路径
        .pipe(gulp.dest('server/public'))
        // 热更新,若命令行中有 watch 这个参数才执行
        .pipe(gulpif(args.watch, livereload()));
});
/**
 * gulp 自动化配置
 * 处理服务器的脚本
 */

import gulp from 'gulp';
// gulp 判断语句
import gulpif from 'gulp-if';
// 启动服务器
import liveserver from 'gulp-live-server';
// 对命令行参数进行解析
import args from './util/args';

// 使用 gulp 创建一个任务
gulp.task('serve', (cb) => {
    // 若命令行不处于监听状态,返回
    // if (!args.watch) {
    //     return cb();
    // }

    // 创建一个服务器并启动
    var server = liveserver.new(['--harmony', 'server/bin/www']);
    server.start();

    // 热更新
    gulp.watch(['server/public/**/*.js', 'server/public/**/*.css', 'server/views/*.ejs'], (file) => {
        server.notify.apply(server, [file]);
    });

    // 需要重启服务器才能更新
    gulp.watch(['server/routes/**/*.js', 'server/app.js'], () => {
        server.start.bind(server)();
    });
});

要热更新 (控制台输入 gulp --watch 实时监控文件变化),还必须在服务器代码上加 app.use(require('connect-livereload'))) 这句代码。位置在
server/app.js:


app.use()使用的中间件的顺序不能随意放,划线部分的代码必须放在那,即在监听根目录下的文件变化。

创建 browser.js

/**
 * gulp 自动化配置
 * 浏览器热更新监听
 * 当 app/js 变化时,启动 task/scripts.js
 * 当 app/css 变化时,启动 task/styles.js
 * 当 app/views 变化时,启动 task/pages.js
 */

import gulp from 'gulp';
// gulp 判断语句
import gulpif from 'gulp-if';
// 浏览器热更新
import livereload from 'gulp-livereload';
// 命令行输出
import util from 'gulp-util';
// 对命令行参数进行解析
import args from './util/args';

// 使用 gulp 创建一个任务
gulp.task('browser', (cb) => {
    if (!args.watch) {
        return cb();
    }

    // 热更新
    gulp.watch(['app/**/*.js'], ['scripts']);
    gulp.watch(['app/**/*.css'], ['styles']);
    gulp.watch(['app/**/*.ejs'], ['pages']);
});

clean.js

/**
 * gulp 自动化配置
 * 清空指定文件夹里的文件
 */

import gulp from 'gulp';
// 删除命令
import del from 'del';
// 对命令行参数进行解析
import args from './util/args';

// 使用 gulp 创建一个任务
gulp.task('clean', () => {
    return del(['server/public', 'server/views']);
});

创建 build.js,按顺序依次执行各任务

/**
 * gulp 自动化配置
 * 设置 gulp task 的顺序
 */

import gulp from 'gulp';
// 删除命令
import gulpSequence from 'gulp-sequence';
// 设置 gulp task 的顺序

// 使用 gulp 创建一个任务
gulp.task('build', gulpSequence('clean', 'styles', 'pages', 'scripts', ['browser', 'serve']));

default.js

/**
 * gulp 自动化配置
 * 默认文件
 * 执行:gulp
 */

import gulp from 'gulp';

// 使用 gulp 创建一个任务
gulp.task('default', ['build']);

4. 放在项目最外面的 gulpfile.babel.js

gulpfile.babel.js(名字固定,且不为 gulpfile.js,,因为要使用 babel 转 ES6 语法.)

import requireDir from 'require-dir';

requireDir('./tasks');

最好的写法是将 tasks 下的文件全写在 gulpfile.babel.js 里,减少 js 文件有利于提升页面渲染速度,上面的分解步骤只是为了看的更容易。

5. 必不可少的 .babelrc 文件

{
    // ES6 转 ES5
    "presets": ["es2015"]
}

6. app/views/index.ejs 里编辑文件

<!doctype html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport"
          content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Document</title>
</head>
<body>
test
</body>
</html>

在控制台输入 gulp --watch 打包文件,启动服务器,并实时监听,服务启动后,在浏览器地址栏输入 http://localhost:3000 可以看到test字样,修改 index.ejs 里面的内容,不用刷新浏览器,gulp 会自动删除之前的打包后的文件重新编译生成新的文件并自动刷新浏览器。

参考链接:https://github.com/bxm0927/lottery

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,783评论 5 472
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,396评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,834评论 0 333
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,036评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,035评论 5 362
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,242评论 1 278
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,727评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,376评论 0 255
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,508评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,415评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,463评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,140评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,734评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,809评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,028评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,521评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,119评论 2 341

推荐阅读更多精彩内容

  • gulpjs是一个前端构建工具,与gruntjs相比,gulpjs无需写一大堆繁杂的配置参数,API也非常简单,学...
    依依玖玥阅读 3,146评论 7 55
  • 安装Gulp首先需要安装Node.js,并在控制台输入$ npm install gulp -gMac端需要写成$...
    LaBaby_阅读 906评论 0 1
  • gulpjs是一个前端构建工具,与gruntjs相比,gulpjs无需写一大堆繁杂的配置参数,API也非常简单,学...
    井皮皮阅读 1,289评论 0 10
  • 在现在的前端开发中,前后端分离、模块化开发、版本控制、文件合并与压缩、mock数据等等一些原本后端的思想开始...
    Charlot阅读 5,422评论 1 32
  • gulpjs是一个前端构建工具,与gruntjs相比,gulpjs无需写一大堆繁杂的配置参数,API也非常简单,学...
    小裁缝sun阅读 916评论 0 3