使用Gulp进行模块打包

中文技术文档

gulp-js

入门指南

1、全局安装 gulp：

1
npm install --global gulp

2、作为项目的开发依赖（devDependencies）安装：

1
npm install --save-dev gulp

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

1
2
3
4
5
var gulp = require('gulp');

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

使用typescript语言

1、除以上安装模块，还必须在项目的开发依赖（devDependencies）安装：

1
npm install --save-dev typescript gulp-typescript ts-node gulpclass

2、在项目根目录下创建一个名为 gulpfile.ts 的文件：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
import { Gulpclass, Task, SequenceTask, MergedTask } from "gulpclass";

const gulp = require("gulp");
const del = require("del");
const sourcemaps = require("gulp-sourcemaps");
const uglify = require('gulp-uglify');
const ts = require("gulp-typescript");

@Gulpclass()
export class Gulpfile {
    @Task()
    clean(cb: Function) {
        return del(["./lib/**"], cb);
    }

    /**
     * Copies all sources to the package directory.
     */
    @MergedTask()
    packageCompile() {
        const tsProject = ts.createProject("tsconfig.json", { typescript: require("typescript") });
        const tsResult = gulp.src(["./src/**/*.ts", "./node_modules/@types/**/*.ts"])
            .pipe(sourcemaps.init())
            .pipe(tsProject());

        return [
            tsResult.dts.pipe(gulp.dest("./lib")),
            tsResult.js
                .pipe(uglify())
                .pipe(sourcemaps.write(".", { sourceRoot: "", includeContent: true }))
                .pipe(gulp.dest("./lib"))
        ];
    }

    @SequenceTask()
    package() {
        return [
            "clean",
            "packageCompile",
        ];
    }
}

4、运行，以上面例子，输入下面命令即可运行

1
gulp package

注意

在使用gulpfile.ts文件时，必须在项目的开发依赖（devDependencies）中安装ts-node模块，运行gulp命令时才能找到任务

  • 检查方法，在项目目录中输入

    1
    gulp -v

    显示以上内容及安装正确，如有错误则异常，需检查安装是否正确

  • 运行gulp package出现Task 'package' is not in your gulpfile，则检查gulp的相关依赖

    1
    npm list gulp gulp-typescript gulpclass ts-node