terriajs/gulpfile.js

Geospatial data visualization platform.

/*eslint-env node*/
/*eslint no-sync: 0*/


'use strict';

/*global require*/

// Every module required-in here must be a `dependency` in package.json, not just a `devDependency`,
// so that our postinstall script (which runs `gulp post-npm-install`) is able to run without
// the devDependencies available.  Individual tasks, other than `post-npm-install` and any tasks it
// calls, may require in `devDependency` modules locally.
var gulp = require('gulp');

gulp.task('default', ['lint', 'build']);
gulp.task('build', ['build-specs', 'copy-cesium-assets']);
gulp.task('release', ['release-specs', 'copy-cesium-assets']);
gulp.task('watch', ['watch-specs', 'copy-cesium-assets']);
gulp.task('post-npm-install', ['copy-cesium-assets']);

gulp.task('build-specs', function(done) {
    var runWebpack = require('./buildprocess/runWebpack.js');
    var webpack = require('webpack');
    var webpackConfig = require('./buildprocess/webpack.config.make.js')(false, true);

    runWebpack(webpack, webpackConfig, done);
});

gulp.task('release-specs', function(done) {
    var runWebpack = require('./buildprocess/runWebpack.js');
    var webpack = require('webpack');
    var webpackConfig = require('./buildprocess/webpack.config.make.js')(false, false);

    runWebpack(webpack, webpackConfig, done);
});

gulp.task('watch-specs', function(done) {
    var watchWebpack = require('./buildprocess/watchWebpack');
    var webpack = require('webpack');
    var webpackConfig = require('./buildprocess/webpack.config.make.js')(false, true);

    watchWebpack(webpack, webpackConfig, done);
});

gulp.task('make-schema', function() {
    var genSchema = require('generate-terriajs-schema');
    var schemaSourceGlob = require('./buildprocess/schemaSourceGlob');

    return genSchema({
        sourceGlob: schemaSourceGlob,
        dest: 'wwwroot/schema',
        noversionsubdir: true,
        quiet: true
    });
});

gulp.task('lint', function() {
    var runExternalModule = require('./buildprocess/runExternalModule');

    runExternalModule('eslint/bin/eslint.js', [
        'lib', 'test',
        '--ext', '.jsx',
        '--ext', '.js',
        '--ignore-pattern', 'lib/ThirdParty',
        '--max-warnings', '0'
    ]);
});

// Create a single .js file with all of TerriaJS + Cesium!
gulp.task('build-libs', function(done) {
    var fs = require('fs');
    var glob = require('glob-all');
    var path = require('path');
    var runWebpack = require('./buildprocess/runWebpack.js');
    var webpack = require('webpack');
    var webpackConfig = require('./buildprocess/webpack.config.lib.js');

    // Build an index.js to export all of the modules.
    var index = '';

    index += '\'use strict\'\n';
    index += '\n';
    index += '/*global require*/\n';
    index += '\n';

    var modules = glob.sync([
        './lib/**/*.js',
        '!./lib/CopyrightModule.js',
        '!./lib/cesiumWorkerBootstrapper.js',
        '!./lib/ThirdParty/**',
        '!./lib/SvgPaths/**'
    ]);

    var directories = {};

    modules.forEach(function(filename) {
        var module = filename.substring(0, filename.length - path.extname(filename).length);
        var moduleName = path.relative('./lib', module);
        moduleName = moduleName.replace(path.sep, '/');
        var moduleParts = moduleName.split('/');

        for (var i = 0; i < moduleParts.length - 1; ++i) {
            var propertyName = moduleParts.slice(0, i + 1).join('.');
            if (!directories[propertyName]) {
                directories[propertyName] = true;
                index += 'exports.' + propertyName + ' = {};\n';
            }
        }

        index += 'exports.' + moduleParts.join('.') + ' = require(\'' + module + '\');\n';
    });

    fs.writeFileSync('terria.lib.js', index);

    runWebpack(webpack, webpackConfig, done);
});

gulp.task('docs', ['user-guide', 'reference-guide'], function() {
    var fse = require('fs-extra');
    fse.copySync('doc/index-built.html', 'wwwroot/doc/index.html');
});

gulp.task('reference-guide', function() {
    var runExternalModule = require('./buildprocess/runExternalModule');

    runExternalModule('jsdoc/jsdoc.js', [
        './lib',
        '-c', './buildprocess/jsdoc.json'
    ]);
});

gulp.task('copy-cesium-assets', function() {
    var path = require('path');

    var cesiumPackage = require.resolve('terriajs-cesium/package.json');
    var cesiumRoot = path.dirname(cesiumPackage);
    var cesiumWebRoot = path.join(cesiumRoot, 'wwwroot');

    return gulp.src([
        path.join(cesiumWebRoot, '**')
    ], {
        base: cesiumWebRoot
    }).pipe(gulp.dest('wwwroot/build/Cesium'));
});

gulp.task('test-browserstack', function(done) {
    runKarma('./buildprocess/karma-browserstack.conf.js', done);
});

gulp.task('test-saucelabs', function(done) {
    runKarma('./buildprocess/karma-saucelabs.conf.js', done);
});

gulp.task('test-electron', function(done) {
    runKarma('./buildprocess/karma-electron.conf.js', done);
});

gulp.task('test-travis', function(done) {
    if (process.env.SAUCE_ACCESS_KEY) {
        runKarma('./buildprocess/karma-saucelabs.conf.js', done);
    } else {
        console.log('SauceLabs testing is not available for pull requests outside the main repo; using Electron instead.');
        runKarma('./buildprocess/karma-electron.conf.js', done);
    }
});

gulp.task('test', function(done) {
    runKarma('./buildprocess/karma-local.conf.js', done);
});

function runKarma(configFile, done) {
    var karma = require('karma').Server;
    var path = require('path');

    karma.start({
        configFile: path.join(__dirname, configFile)
    }, function(e) {
        return done(e);
    });
}

gulp.task('user-guide', ['make-schema'], function() {
    var fse = require('fs-extra');
    var gutil = require('gulp-util');
    var klawSync = require('klaw-sync');
    var path = require('path');
    var spawnSync = require('child_process').spawnSync;

    fse.copySync('doc/mkdocs.yml', 'build/mkdocs.yml');
    fse.copySync('doc', 'build/doc');

    var files = klawSync('build/doc').map(o => o.path);
    var markdown = files.filter(name => path.extname(name) === '.md');
    var readmes = markdown.filter(name => name.indexOf('README.md') === name.length - 'README.md'.length);

    // Rename all README.md to index.md
    readmes.forEach(readme => fse.renameSync(readme, path.join(path.dirname(readme), 'index.md')));

    // Replace links to README.md with links to index.md
    markdown.forEach(function(name) {
        name = name.replace(/README\.md/, 'index.md');
        var content = fse.readFileSync(name, 'UTF-8');
        var replaced = content.replace(/README\.md/g, 'index.md');
        if (content !== replaced) {
            fse.writeFileSync(name, replaced, 'UTF-8');
        }
    });

    // Replace README.md with index.md in mkdocs.yml.
    // Also replace swap in the actual path to mkdocs-material in node_modules.
    var mkdocsyml = fse.readFileSync('build/mkdocs.yml', 'UTF-8');
    mkdocsyml = mkdocsyml.replace(/README\.md/g, 'index.md');
    fse.writeFileSync('build/mkdocs.yml', mkdocsyml, 'UTF-8');

    generateCatalogMemberPages('wwwroot/schema', 'build/doc/connecting-to-data/catalog-type-details');

    var result = spawnSync('mkdocs', ['build', '--clean', '--config-file', 'mkdocs.yml'], {
        cwd: 'build',
        stdio: 'inherit',
        shell: false
    });
    if (result.status !== 0) {
        throw new gutil.PluginError('user-doc', 'External module exited with an error.', { showStack: false });
    }
});

function generateCatalogMemberPages(schemaPath, outputPath) {
    var fse = require('fs-extra');
    var klawSync = require('klaw-sync');
    var path = require('path');

    var schemaFiles = klawSync(schemaPath).map(o => o.path);
    var typeFiles = schemaFiles.filter(name => name.endsWith('_type.json'));

    typeFiles.forEach(function(typeFile) {
        var json = JSON.parse(fse.readFileSync(typeFile, 'UTF-8'));
        var type = json.properties.type.enum[0];
        var file = path.join(outputPath, type + '.md');
        var propertiesFile = typeFile.replace(/_type\.json/, '.json');

        var properties = {};
        addProperties(propertiesFile, properties);

        var content = '!!! note\r\r' +
                      '    This page is automatically generated from the source code, and is a bit rough.  If you have\r' +
                      '    trouble, check the [source code for this type](https://github.com/TerriaJS/terriajs/blob/master/lib/Models/' + path.basename(propertiesFile, '.json') + '.js) or post a message to the [forum](https://groups.google.com/forum/#!forum/terriajs).\r\r';
        content += json.description + '\r\r';
        content += '## [Initialization File](../../customizing/initialization-files.md) properties:\r\r';
        content += '`"type": "' + type + '"`\r\r';

        var propertyKeys = Object.keys(properties);
        propertyKeys.sort().forEach(function(property) {
            var details = properties[property];
            content += '`' + property + '`\r\r';
            content += details.description + '\r\r';
        });

        fse.writeFileSync(file, content, 'UTF-8');
    });
}

function addProperties(file, result) {
    var fse = require('fs-extra');
    var path = require('path');

    var propertiesJson = JSON.parse(fse.readFileSync(file, 'UTF-8'));

    if (propertiesJson.allOf) {
        propertiesJson.allOf.forEach(function(allOf) {
            addProperties(path.join(path.dirname(file), allOf['$ref']), result);
        });
    }

    for (var property in propertiesJson.properties) {
        result[property] = propertiesJson.properties[property];
    }
}