forked from typeorm/typeorm
-
Notifications
You must be signed in to change notification settings - Fork 0
/
gulpfile.ts
364 lines (324 loc) · 10.2 KB
/
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
///<reference path="node_modules/@types/node/index.d.ts"/>
///<reference path="node_modules/@types/chai/index.d.ts"/>
///<reference path="node_modules/@types/mocha/index.d.ts"/>
import {Gulpclass, Task, SequenceTask, MergedTask} from "gulpclass";
const gulp = require("gulp");
const del = require("del");
const shell = require("gulp-shell");
const replace = require("gulp-replace");
const rename = require("gulp-rename");
const mocha = require("gulp-mocha");
const chai = require("chai");
const eslint = require("gulp-eslint");
const sourcemaps = require("gulp-sourcemaps");
const istanbul = require("gulp-istanbul");
const remapIstanbul = require("remap-istanbul/lib/gulpRemapIstanbul");
const ts = require("gulp-typescript");
const args = require("yargs").argv;
@Gulpclass()
export class Gulpfile {
// -------------------------------------------------------------------------
// General tasks
// -------------------------------------------------------------------------
/**
* Creates a delay and resolves after 15 seconds.
*/
@Task()
wait(cb: Function) {
setTimeout(() => cb(), 15000);
}
/**
* Cleans build folder.
*/
@Task()
clean(cb: Function) {
return del(["./build/**"], cb);
}
/**
* Runs typescript files compilation.
*/
@Task()
compile() {
return gulp.src("package.json", { read: false })
.pipe(shell(["npm run compile"]));
}
// -------------------------------------------------------------------------
// Build and packaging for browser
// -------------------------------------------------------------------------
/**
* Copies all source files into destination folder in a correct structure.
*/
@Task()
browserCopySources() {
return gulp.src([
"./src/**/*.ts",
"!./src/commands/*.ts",
"!./src/cli.ts",
"!./src/typeorm.ts",
"!./src/typeorm-model-shim.ts",
"!./src/platform/PlatformTools.ts"
])
.pipe(gulp.dest("./build/browser/src"));
}
/**
* Replaces PlatformTools with browser-specific implementation called BrowserPlatformTools.
*/
@Task()
browserCopyPlatformTools() {
return gulp.src("./src/platform/BrowserPlatformTools.template")
.pipe(rename("PlatformTools.ts"))
.pipe(gulp.dest("./build/browser/src/platform"));
}
/**
* Adds dummy classes for disabled drivers (replacement is done via browser entry point in package.json)
*/
@Task()
browserCopyDisabledDriversDummy() {
return gulp.src("./src/platform/BrowserDisabledDriversDummy.template")
.pipe(rename("BrowserDisabledDriversDummy.ts"))
.pipe(gulp.dest("./build/browser/src/platform"));
}
@MergedTask()
browserCompile() {
const tsProject = ts.createProject("tsconfig.json", {
module: "es2015",
"lib": ["es5", "es6", "dom"],
typescript: require("typescript")
});
const tsResult = gulp.src(["./build/browser/src/**/*.ts", "./node_modules/reflect-metadata/**/*.d.ts", "./node_modules/@types/**/*.ts"])
.pipe(sourcemaps.init())
.pipe(tsProject());
return [
tsResult.dts.pipe(gulp.dest("./build/package/browser")),
tsResult.js
.pipe(sourcemaps.write(".", { sourceRoot: "", includeContent: true }))
.pipe(gulp.dest("./build/package/browser"))
];
}
@Task()
browserClearPackageDirectory(cb: Function) {
return del([
"./build/browser/**"
]);
}
// -------------------------------------------------------------------------
// Main Packaging and Publishing tasks
// -------------------------------------------------------------------------
/**
* Publishes a package to npm from ./build/package directory.
*/
@Task()
packagePublish() {
return gulp.src("package.json", { read: false })
.pipe(shell([
"cd ./build/package && npm publish"
]));
}
/**
* Publishes a package to npm from ./build/package directory with @next tag.
*/
@Task()
packagePublishNext() {
return gulp.src("package.json", { read: false })
.pipe(shell([
"cd ./build/package && npm publish --tag next"
]));
}
/**
* 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("./build/package")),
tsResult.js
.pipe(sourcemaps.write(".", { sourceRoot: "", includeContent: true }))
.pipe(gulp.dest("./build/package"))
];
}
/**
* Moves all compiled files to the final package directory.
*/
@Task()
packageMoveCompiledFiles() {
return gulp.src("./build/package/src/**/*")
.pipe(gulp.dest("./build/package"));
}
/**
* Removes /// <reference from compiled sources.
*/
@Task()
packageReplaceReferences() {
return gulp.src("./build/package/**/*.d.ts")
.pipe(replace(`/// <reference types="node" />`, ""))
.pipe(replace(`/// <reference types="chai" />`, ""))
.pipe(gulp.dest("./build/package"));
}
/**
* Moves all compiled files to the final package directory.
*/
@Task()
packageClearPackageDirectory(cb: Function) {
return del([
"build/package/src/**"
], cb);
}
/**
* Change the "private" state of the packaged package.json file to public.
*/
@Task()
packagePreparePackageFile() {
return gulp.src("./package.json")
.pipe(replace("\"private\": true,", "\"private\": false,"))
.pipe(gulp.dest("./build/package"));
}
/**
* Copies README.md into the package.
*/
@Task()
packageCopyReadme() {
return gulp.src("./README.md")
.pipe(replace(/```typescript([\s\S]*?)```/g, "```javascript$1```"))
.pipe(gulp.dest("./build/package"));
}
/**
* Copies shims to use typeorm in different environment and conditions file into package.
*/
@Task()
packageCopyShims() {
return gulp.src(["./extra/typeorm-model-shim.js", "./extra/typeorm-class-transformer-shim.js"])
.pipe(gulp.dest("./build/package"));
}
/**
* Creates a package that can be published to npm.
*/
@SequenceTask()
package() {
return [
"clean",
["browserCopySources", "browserCopyPlatformTools", "browserCopyDisabledDriversDummy"],
["packageCompile", "browserCompile"],
"packageMoveCompiledFiles",
[
"browserClearPackageDirectory",
"packageClearPackageDirectory",
"packageReplaceReferences",
"packagePreparePackageFile",
"packageCopyReadme",
"packageCopyShims"
],
];
}
/**
* Creates a package and publishes it to npm.
*/
@SequenceTask()
publish() {
return ["package", "packagePublish"];
}
/**
* Creates a package and publishes it to npm with @next tag.
*/
@SequenceTask("publish-next")
publishNext() {
return ["package", "packagePublishNext"];
}
// -------------------------------------------------------------------------
// Run tests tasks
// -------------------------------------------------------------------------
/**
* Runs ts linting to validate source code.
*/
@Task()
eslint() {
return gulp.src(["./src/**/*.ts", "./test/**/*.ts", "./sample/**/*.ts"])
.pipe(eslint())
.pipe(eslint.format('stylish'))
.pipe(eslint.failAfterError())
}
/**
* Runs before test coverage, required step to perform a test coverage.
*/
@Task()
coveragePre() {
return gulp.src(["./build/compiled/src/**/*.js"])
.pipe(istanbul())
.pipe(istanbul.hookRequire());
}
/**
* Runs post coverage operations.
*/
@Task()
coveragePost() {
return gulp.src(["./build/compiled/test/**/*.js"])
.pipe(istanbul.writeReports());
}
/**
* Runs mocha tests.
*/
@Task()
runTests() {
chai.should();
chai.use(require("sinon-chai"));
chai.use(require("chai-as-promised"));
return gulp.src(["./build/compiled/test/**/*.js"])
.pipe(mocha({
bail: true,
grep: !!args.grep ? new RegExp(args.grep) : undefined,
timeout: 15000
}));
}
@Task()
coverageRemap() {
return gulp.src("./coverage/coverage-final.json")
.pipe(remapIstanbul())
.pipe(gulp.dest("./coverage"));
}
/**
* Compiles the code and runs tests + makes coverage report.
*/
@SequenceTask()
tests() {
return [
"compile",
"coveragePre",
"runTests",
"coveragePost",
"coverageRemap"
];
}
/**
* Runs tests, but creates a small delay before running them to make sure to give time for docker containers to be initialized.
*/
@SequenceTask("ci-tests")
ciTests() {
return [
"clean",
"compile",
"tslint",
"wait",
"coveragePre",
"runTests",
"coveragePost",
"coverageRemap"
];
}
// -------------------------------------------------------------------------
// CI tasks
// -------------------------------------------------------------------------
@Task()
createTravisOrmConfig() {
return gulp.src("./ormconfig.travis.json")
.pipe(rename("ormconfig.json"))
.pipe(gulp.dest("./"));
}
}