|
| 1 | +const gulp = require('gulp'); |
| 2 | +const loadPlugins = require('gulp-load-plugins'); |
| 3 | +const del = require('del'); |
| 4 | +const glob = require('glob'); |
| 5 | +const path = require('path'); |
| 6 | +const isparta = require('isparta'); |
| 7 | +const webpack = require('webpack'); |
| 8 | +const webpackStream = require('webpack-stream'); |
| 9 | +const source = require('vinyl-source-stream'); |
| 10 | + |
| 11 | +const Instrumenter = isparta.Instrumenter; |
| 12 | +const mochaGlobals = require('./test/setup/.globals'); |
| 13 | +const manifest = require('./package.json'); |
| 14 | + |
| 15 | +// Load all of our Gulp plugins |
| 16 | +const $ = loadPlugins(); |
| 17 | + |
| 18 | +// Gather the library data from `package.json` |
| 19 | +const config = manifest.babelBoilerplateOptions; |
| 20 | +const mainFile = manifest.main; |
| 21 | +const destinationFolder = path.dirname(mainFile); |
| 22 | +const exportFileName = path.basename(mainFile, path.extname(mainFile)); |
| 23 | + |
| 24 | +function cleanDist(done) { |
| 25 | + del([destinationFolder]).then(() => done()); |
| 26 | +} |
| 27 | + |
| 28 | +function cleanTmp(done) { |
| 29 | + del(['tmp']).then(() => done()); |
| 30 | +} |
| 31 | + |
| 32 | +// Lint a set of files |
| 33 | +function lint(files) { |
| 34 | + return gulp.src(files) |
| 35 | + .pipe($.eslint()) |
| 36 | + .pipe($.eslint.format()) |
| 37 | + .pipe($.eslint.failAfterError()); |
| 38 | +} |
| 39 | + |
| 40 | +function lintSrc() { |
| 41 | + return lint('src/**/*.js'); |
| 42 | +} |
| 43 | + |
| 44 | +function lintTest() { |
| 45 | + return lint('test/**/*.js'); |
| 46 | +} |
| 47 | + |
| 48 | +function lintGulpfile() { |
| 49 | + return lint('gulpfile.js'); |
| 50 | +} |
| 51 | + |
| 52 | +function build() { |
| 53 | + return gulp.src(path.join('src', config.entryFileName)) |
| 54 | + .pipe(webpackStream({ |
| 55 | + output: { |
| 56 | + filename: exportFileName + '.js', |
| 57 | + libraryTarget: 'umd', |
| 58 | + library: config.mainVarName |
| 59 | + }, |
| 60 | + // Add your own externals here. For instance, |
| 61 | + // { |
| 62 | + // jquery: true |
| 63 | + // } |
| 64 | + // would externalize the `jquery` module. |
| 65 | + externals: {}, |
| 66 | + module: { |
| 67 | + loaders: [ |
| 68 | + { test: /\.js$/, exclude: /node_modules/, loader: 'babel-loader' } |
| 69 | + ] |
| 70 | + }, |
| 71 | + devtool: 'source-map' |
| 72 | + })) |
| 73 | + .pipe(gulp.dest(destinationFolder)) |
| 74 | + .pipe($.filter(['**', '!**/*.js.map'])) |
| 75 | + .pipe($.rename(exportFileName + '.min.js')) |
| 76 | + .pipe($.sourcemaps.init({ loadMaps: true })) |
| 77 | + .pipe($.uglify()) |
| 78 | + .pipe($.sourcemaps.write('./')) |
| 79 | + .pipe(gulp.dest(destinationFolder)); |
| 80 | +} |
| 81 | + |
| 82 | +function _mocha() { |
| 83 | + return gulp.src(['test/setup/node.js', 'test/unit/**/*.js'], {read: false}) |
| 84 | + .pipe($.mocha({ |
| 85 | + reporter: 'dot', |
| 86 | + globals: Object.keys(mochaGlobals.globals), |
| 87 | + ignoreLeaks: false |
| 88 | + })); |
| 89 | +} |
| 90 | + |
| 91 | +function _registerBabel() { |
| 92 | + require('babel-register'); |
| 93 | +} |
| 94 | + |
| 95 | +function test() { |
| 96 | + _registerBabel(); |
| 97 | + return _mocha(); |
| 98 | +} |
| 99 | + |
| 100 | +function coverage(done) { |
| 101 | + _registerBabel(); |
| 102 | + gulp.src(['src/**/*.js']) |
| 103 | + .pipe($.istanbul({ instrumenter: Instrumenter })) |
| 104 | + .pipe($.istanbul.hookRequire()) |
| 105 | + .on('finish', () => { |
| 106 | + return test() |
| 107 | + .pipe($.istanbul.writeReports()) |
| 108 | + .on('end', done); |
| 109 | + }); |
| 110 | +} |
| 111 | + |
| 112 | +const watchFiles = ['src/**/*', 'test/**/*', 'package.json', '**/.eslintrc', '.jscsrc']; |
| 113 | + |
| 114 | +// Run the headless unit tests as you make changes. |
| 115 | +function watch() { |
| 116 | + gulp.watch(watchFiles, ['test']); |
| 117 | +} |
| 118 | + |
| 119 | +function testBrowser() { |
| 120 | + // Our testing bundle is made up of our unit tests, which |
| 121 | + // should individually load up pieces of our application. |
| 122 | + // We also include the browser setup file. |
| 123 | + const testFiles = glob.sync('./test/unit/**/*.js'); |
| 124 | + const allFiles = ['./test/setup/browser.js'].concat(testFiles); |
| 125 | + |
| 126 | + // Lets us differentiate between the first build and subsequent builds |
| 127 | + var firstBuild = true; |
| 128 | + |
| 129 | + // This empty stream might seem like a hack, but we need to specify all of our files through |
| 130 | + // the `entry` option of webpack. Otherwise, it ignores whatever file(s) are placed in here. |
| 131 | + return gulp.src('') |
| 132 | + .pipe($.plumber()) |
| 133 | + .pipe(webpackStream({ |
| 134 | + watch: true, |
| 135 | + entry: allFiles, |
| 136 | + output: { |
| 137 | + filename: '__spec-build.js' |
| 138 | + }, |
| 139 | + // Externals isn't necessary here since these are for tests. |
| 140 | + module: { |
| 141 | + loaders: [ |
| 142 | + // This is what allows us to author in future JavaScript |
| 143 | + { test: /\.js$/, exclude: /node_modules/, loader: 'babel-loader' }, |
| 144 | + // This allows the test setup scripts to load `package.json` |
| 145 | + { test: /\.json$/, exclude: /node_modules/, loader: 'json-loader' } |
| 146 | + ] |
| 147 | + }, |
| 148 | + plugins: [ |
| 149 | + // By default, webpack does `n=>n` compilation with entry files. This concatenates |
| 150 | + // them into a single chunk. |
| 151 | + new webpack.optimize.LimitChunkCountPlugin({ maxChunks: 1 }) |
| 152 | + ], |
| 153 | + devtool: 'inline-source-map' |
| 154 | + }, null, function() { |
| 155 | + if (firstBuild) { |
| 156 | + $.livereload.listen({port: 35729, host: 'localhost', start: true}); |
| 157 | + var watcher = gulp.watch(watchFiles, ['lint']); |
| 158 | + } else { |
| 159 | + $.livereload.reload('./tmp/__spec-build.js'); |
| 160 | + } |
| 161 | + firstBuild = false; |
| 162 | + })) |
| 163 | + .pipe(gulp.dest('./tmp')); |
| 164 | +} |
| 165 | + |
| 166 | +// Remove the built files |
| 167 | +gulp.task('clean', cleanDist); |
| 168 | + |
| 169 | +// Remove our temporary files |
| 170 | +gulp.task('clean-tmp', cleanTmp); |
| 171 | + |
| 172 | +// Lint our source code |
| 173 | +gulp.task('lint-src', lintSrc); |
| 174 | + |
| 175 | +// Lint our test code |
| 176 | +gulp.task('lint-test', lintTest); |
| 177 | + |
| 178 | +// Lint this file |
| 179 | +gulp.task('lint-gulpfile', lintGulpfile); |
| 180 | + |
| 181 | +// Lint everything |
| 182 | +gulp.task('lint', ['lint-src', 'lint-test', 'lint-gulpfile']); |
| 183 | + |
| 184 | +// Build two versions of the library |
| 185 | +gulp.task('build', ['lint', 'clean'], build); |
| 186 | + |
| 187 | +// Lint and run our tests |
| 188 | +gulp.task('test', ['lint'], test); |
| 189 | + |
| 190 | +// Set up coverage and run tests |
| 191 | +gulp.task('coverage', ['lint'], coverage); |
| 192 | + |
| 193 | +// Set up a livereload environment for our spec runner `test/runner.html` |
| 194 | +gulp.task('test-browser', ['lint', 'clean-tmp'], testBrowser); |
| 195 | + |
| 196 | +// Run the headless unit tests as you make changes. |
| 197 | +gulp.task('watch', watch); |
| 198 | + |
| 199 | +// An alias of test |
| 200 | +gulp.task('default', ['test']); |
0 commit comments