forked from FredrikNoren/ungit
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathGruntfile.js
496 lines (470 loc) · 17.1 KB
/
Gruntfile.js
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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
const childProcess = require('child_process');
const path = require('path');
const fs = require('./source/utils/fs-async');
const npm = require('npm');
const semver = require('semver');
const browserify = require('browserify');
const electronPackager = require('electron-packager');
const Bluebird = require('bluebird');
const cliColor = require('ansi-color');
const maxConcurrency = 5;
module.exports = (grunt) => {
const packageJson = grunt.file.readJSON('package.json');
grunt.initConfig({
pkg: packageJson,
less: {
production: {
files: {
"public/css/styles.css": ["public/less/styles.less", "public/vendor/css/animate.css", "public/less/d2h.less"],
"components/commit/commit.css": ["components/commit/commit.less"],
"components/commitdiff/commitdiff.css": ["components/commitdiff/commitdiff.less"],
"components/graph/graph.css": ["components/graph/graph.less"],
"components/header/header.css": ["components/header/header.less"],
"components/home/home.css": ["components/home/home.less"],
"components/imagediff/imagediff.css": ["components/imagediff/imagediff.less"],
"components/repository/repository.css": ["components/repository/repository.less"],
"components/staging/staging.css": ["components/staging/staging.less"],
"components/stash/stash.css": ["components/stash/stash.less"],
"components/refreshbutton/refreshbutton.css": ["components/refreshbutton/refreshbutton.less"],
}
}
},
watch: {
scripts: {
files: ['public/source/**/*.js', 'source/**/*.js', 'components/**/*.js'],
tasks: ['browserify-common', 'browserify-components', 'babel:prod'],
options: {
spawn: false,
},
},
less: {
files: ['public/less/*.less', 'public/styles/*.less', 'components/**/*.less'],
tasks: ['less:production'],
options: {
spawn: false,
},
}
},
lineending: {
// Debian won't accept bin files with the wrong line ending
production: {
options: {
eol: 'lf'
},
files: {
'./bin/ungit': ['./bin/ungit'],
'./bin/credentials-helper': ['./bin/credentials-helper']
}
},
},
release: {
options: {
commitMessage: 'Release <%= version %>',
}
},
// Run mocha tests
mochaTest: {
unit: {
options: {
reporter: 'spec'
},
src: 'test/*.js'
},
click: {
options: {
reporter: 'spec',
timeout: 15000,
bail: true
},
src: 'nmclicktests/spec.*.js'
}
},
// Plato code analysis
plato: {
all: {
files: {
'report': ['source/**/*.js', 'public/source/**/*.js'],
}
},
},
// Minify images (basically just lossless compression)
imagemin: {
default: {
options: {
optimizationLevel: 3
},
files: [{
expand: true,
cwd: 'assets/client/images/',
src: ['**/*.png'],
dest: 'public/images/'
}]
}
},
// Embed images in css
imageEmbed: {
default: {
files: {
"public/css/styles.css": [ "public/css/styles.css" ],
"components/graph/graph.css": ["components/graph/graph.css"],
"components/header/header.css": ["components/header/header.css"],
"components/staging/staging.css": ["components/staging/staging.css"],
},
options: {
deleteAfterEncoding: false
}
}
},
jshint: {
options: {
undef: true, // check for usage of undefined constiables
indent: 2,
esnext: true,
'-W033': true, // ignore Missing semicolon
'-W041': true, // ignore Use '===' to compare with '0'
'-W065': true, // ignore Missing radix parameter
'-W069': true, // ignore ['HEAD'] is better written in dot notation
},
web: {
options: {
node: true,
browser: true,
globals: {
'ungit': true,
'io': true,
'keen': true,
'Raven': true,
'$': true,
'nprogress': true
}
},
files: [
{
src: ['public/source/**/*.js', 'components/**/*.js'],
// Filter out the "compiled" components files; see the browserify task for components
filter: (src) => src.indexOf('bundle.js') == -1
}
]
},
node: {
options: {
node: true
},
src: ['source/**/*.js']
},
bin: {
options: {
node: true
},
src: [
'Gruntfile.js',
'bin/*'
]
},
mocha: {
options: {
node: true,
globals: {
'it': true,
'describe': true,
'before': true,
'after': true,
'window': true,
'document': true,
'navigator': true,
'ungit': true
}
},
src: [
'test/**/*.js',
'nmclicktests/**/*.js'
]
}
},
copy: {
main: {
files: [
// includes files within path
{ expand: true, flatten: true, src: ['node_modules/octicons/octicons/octicons.ttf'], dest: 'public/css/' },
{ expand: true, flatten: true, src: ['node_modules/octicons/octicons/octicons.woff'], dest: 'public/css/' }
]
},
electron: {
files: [
{ expand: true, src: ['public/**'], dest: 'build/resource/' },
{ expand: true, src: ['src/**'], dest: 'build/resource/' },
{ expand: true, src: ['components/**'], dest: 'build/resource/' },
{ expand: true, src: ['assets/**'], dest: 'build/resource/' },
{ expand: true, src: ['node_modules/**'], dest: 'build/resource/' },
{ expand: true, src: ['package.json'], dest: 'build/resource/'}
]
}
},
clean: {
electron: ['./build'],
coverage: ['./coverage'],
'coverage-unit': ['./coverage/coverage-unit'],
babel: ['./src']
},
electron: {
package: {
options: {
name: 'ungit',
dir: './build/resource',
out: './build',
icon: './icon.ico',
version: '0.31.1',
platform: 'all',
arch: 'all',
asar: true,
prune: true,
'version-string': {
FileDescription : 'ungit',
OriginalFilename : 'ungit.exe',
FileVersion : '<%= version %>',
ProductVersion : '<%= version %>',
ProductName : 'ungit',
InternalName : 'ungit.exe'
}
}
}
},
mocha_istanbul: {
unit: {
src: './test',
options: {
coverageFolder: './coverage/coverage-unit',
mask: 'spec.*.js'
}
}
},
babel: {
prod: {
options: {
presets: ['es2015', 'stage-0']
},
files: [{
expand: true,
cwd: 'source',
src: ['**/*.js'],
dest: 'src',
ext: '.js'
}]
},
electron: {
options: {
presets: ['es2015', 'stage-0']
},
files: [{
expand: true,
cwd: 'source',
src: ['**/*.js'],
dest: 'src',
ext: '.js'
}]
}
}
});
grunt.registerTask('browserify-common', '', function() {
const done = this.async();
const b = browserify({
noParse: ['public/vendor/js/superagent.js'],
debug: true
});
b.add('./public/source/main.js');
b.require('./public/source/main.js', { expose: 'ungit-main' });
b.require('./public/source/components.js', { expose: 'ungit-components' });
b.require('./public/source/program-events.js', { expose: 'ungit-program-events' });
b.require('./public/source/navigation.js', { expose: 'ungit-navigation' });
b.require('./public/source/main.js', { expose: 'ungit-main' });
b.require('./source/address-parser.js', { expose: 'ungit-address-parser' });
b.require('knockout', { expose: 'knockout' });
b.require('lodash', { expose: 'lodash' });
b.require('hasher', { expose: 'hasher' });
b.require('crossroads', { expose: 'crossroads' });
b.require('async', { expose: 'async' });
b.require('moment', { expose: 'moment' });
b.require('blueimp-md5', { expose: 'blueimp-md5' });
b.require('color', { expose: 'color' });
b.require('signals', { expose: 'signals' });
b.require('util', { expose: 'util' });
b.require('path', { expose: 'path' });
b.require('diff2html', { expose: 'diff2html' });
b.require('bluebird', { expose: 'bluebird' });
b.require('just-detect-adblock', { expose: 'just-detect-adblock' });
b.require('./node_modules/snapsvg/src/mina.js', { expose: 'mina' });
b.require('nprogress', { expose: 'nprogress' });
const outFile = fs.createWriteStream('./public/js/ungit.js');
outFile.on('close', () => done());
b.bundle().pipe(outFile);
});
grunt.registerTask('browserify-components', '', function() {
Bluebird.each(fs.readdirSync('components'), (component) => {
return new Bluebird((resolve, reject) => {
const b = browserify({
bundleExternal: false,
debug: true
});
const src = `./components/${component}/${component}.js`;
if (!fs.existsSync(src)) {
grunt.log.error(`${src} does not exist. If this component is obsolete, please remove that directory or perform a clean build.`);
return;
}
b.add(src);
b.external(['ungit-components',
'ungit-program-events',
'ungit-navigation',
'ungit-main',
'ungit-address-parser',
'knockout',
'lodash',
'hasher',
'crossroads',
'async',
'moment',
'blueimp-md5']);
const outFile = fs.createWriteStream(`./components/${component}/${component}.bundle.js`);
outFile.on('close', () => resolve());
b.bundle().pipe(outFile);
});
}).then(this.async());
});
const bumpDependency = (packageJson, packageName) => {
return new Bluebird((resolve, reject) => {
const dependencyType = packageJson['dependencies'][packageName] ? 'dependencies' : 'devDependencies'
let currentVersion = packageJson[dependencyType][packageName];
if (currentVersion[0] == '~' || currentVersion[0] == '^') currentVersion = currentVersion.slice(1);
npm.commands.show([packageName, 'versions'], true, (err, data) => {
if(err) reject(err);
const versions = data[Object.keys(data)[0]].versions.filter((v) => {
return v.indexOf('alpha') == -1;
});
const latestVersion = versions[versions.length - 1];
if (semver.gt(latestVersion, currentVersion)) {
packageJson[dependencyType][packageName] = '~' + latestVersion;
}
resolve();
});
});
}
const updatePackageJsonBuildVersion = (commitHash) => {
const packageJson = JSON.parse(fs.readFileSync('package.json'));
packageJson.version += `+${commitHash}`;
fs.writeFileSync('package.json', `${JSON.stringify(packageJson, null, 2)}\n`);
}
grunt.registerTask('travisnpmpublish', 'Automatically publish to NPM via travis.', function() {
const done = this.async();
if (process.env.TRAVIS_BRANCH != 'master' || (process.env.TRAVIS_PULL_REQUEST && process.env.TRAVIS_PULL_REQUEST != 'false')) {
console.log('Skipping travis npm publish');
return done();
}
childProcess.exec("git rev-parse --short HEAD", (err, stdout, stderr) => {
const hash = stdout.trim();
updatePackageJsonBuildVersion(hash);
fs.writeFileSync('.npmrc', '//registry.npmjs.org/:_authToken=' + process.env.NPM_TOKEN);
childProcess.exec("npm publish", () => { done(); });
});
});
/**
* Run clicktest in parallel at test suite level.
* This test does intermittently fails depends on the maxConcurrency level set
* above and the capacity of the computer as sometimes lack of resource allocation
* triggers timeouts.
* Use at own discretion.
*/
grunt.registerTask('clickParallel', 'Parallelized click tests.', function() {
const done = this.async();
fs.readdirAsync('./nmclicktests')
.then((files) => files.filter((file) => file.startsWith("spec.")))
.then((tests) => {
grunt.log.writeln('Running click tests in parallel... (this will take a while...)');
return Bluebird.map(tests, (file) => {
let output = "";
const outStream = (data) => output += data
grunt.log.writeln(cliColor.set(`Clicktest started! \t${file}`, 'blue'));
return new Bluebird((resolve, reject) => {
const child = childProcess.execFile('./node_modules/mocha/bin/mocha', [path.join(__dirname, 'nmclicktests', file), '--timeout=20000', '-b'], { maxBuffer: 10*1024*1024 });
child.stdout.on('data', outStream);
child.stderr.on('data', outStream);
child.on('exit', (code) => {
if (code == 0) resolve(file);
else reject();
});
}).then(() => {
grunt.log.writeln(cliColor.set(`'Clicktest success! \t${file}`, 'green'));
return { name: file, output: output, isSuccess: true };
}).catch(() => {
grunt.log.writeln(cliColor.set(`'Clicktest fail! \t'${file}`, 'red'));
return { name: file, output: output, isSuccess: false };
});
}, { concurrency: maxConcurrency });
}).then((results) => {
let isSuccess = true;
results.forEach((result) => {
if (!result.isSuccess) {
grunt.log.writeln(`---- start of ${result.name} log ----`)
grunt.log.writeln(result.output);
grunt.log.writeln(`----- end of ${result.name} log -----`)
isSuccess = false;
}
});
done(isSuccess);
});
});
grunt.registerTask('bumpdependencies', 'Bump dependencies to their latest versions.', function() {
const done = this.async();
grunt.log.writeln('Bumping dependencies...');
npm.load(() => {
const tempPackageJson = JSON.parse(JSON.stringify(packageJson));
const keys = Object.keys(tempPackageJson.dependencies).concat(Object.keys(tempPackageJson.devDependencies))
const bumps = Bluebird.map(keys, (dep) => {
// winston 3.x has different API
if (dep == 'winston') return;
// babel 7.x.x has alot of changes.... :(
if (dep.indexOf('babel') > -1) return;
// Octicon moved to SCSS instead of less
if (dep == 'octicons') return;
return bumpDependency(tempPackageJson, dep);
});
Bluebird.all(bumps).then(() => {
fs.writeFileSync('package.json', `${JSON.stringify(tempPackageJson, null, 2)}\n`);
grunt.log.writeln('Dependencies bumped, run npm install to install latest versions.');
}).then(() => { done(); }).catch(done);
});
});
grunt.registerMultiTask('electron', 'Package Electron apps', function() {
electronPackager(this.options(), this.async());
});
grunt.event.on('coverage', (lcovFileContents) => {
// Check below on the section "The coverage event"
console.log(lcovFileContents);
console.log('\n\n=== html report: ./coverage/coverage-unit/lcove-report/index.html ===\n\n');
});
grunt.loadNpmTasks('grunt-contrib-less');
grunt.loadNpmTasks('grunt-contrib-watch');
grunt.loadNpmTasks('grunt-lineending');
grunt.loadNpmTasks('grunt-release');
grunt.loadNpmTasks('grunt-mocha-test');
grunt.loadNpmTasks('grunt-plato');
grunt.loadNpmTasks('grunt-contrib-imagemin');
grunt.loadNpmTasks('grunt-image-embed');
grunt.loadNpmTasks('grunt-contrib-jshint');
grunt.loadNpmTasks('grunt-contrib-copy');
grunt.loadNpmTasks('grunt-contrib-clean');
grunt.loadNpmTasks('grunt-mocha-istanbul');
grunt.loadNpmTasks('grunt-babel');
// Default task, builds everything needed
grunt.registerTask('default', ['clean:babel', 'less:production', 'jshint', 'babel:prod', 'browserify-common', 'browserify-components', 'lineending:production', 'imageEmbed:default', 'copy:main', 'imagemin:default']);
// Run tests without compile (use watcher or manually build)
grunt.registerTask('unittest', ['mochaTest:unit']);
grunt.registerTask('clicktest', ['mochaTest:click']);
grunt.registerTask('test', ['unittest', 'clicktest']);
// Builds, and then creates a release (bump patch version, create a commit & tag, publish to npm)
grunt.registerTask('publish', ['default', 'test', 'release:patch']);
// Same as publish but for minor version
grunt.registerTask('publishminor', ['default', 'test', 'release:minor']);
// Create electron package
grunt.registerTask('package', ['clean:electron', 'clean:babel', 'babel:electron', 'copy:electron', 'electron']);
// run unit test coverage, assumes project is compiled
grunt.registerTask('coverage-unit', ['clean:coverage-unit', 'mocha_istanbul:unit']);
};