/* All configurable options are defined inside build.config Please adjust this to your site's settings */ /******************************* Set-up *******************************/ var gulp = require('gulp-help')(require('gulp')), // node components & oddballs console = require('better-console'), del = require('del'), extend = require('extend'), fs = require('fs'), path = require('path'), wrench = require('wrench'), // gulp dependencies autoprefixer = require('gulp-autoprefixer'), clone = require('gulp-clone'), concat = require('gulp-concat'), concatCSS = require('gulp-concat-css'), copy = require('gulp-copy'), debug = require('gulp-debug'), flatten = require('gulp-flatten'), header = require('gulp-header'), jeditor = require('gulp-json-editor'), karma = require('gulp-karma'), less = require('gulp-less'), minifyCSS = require('gulp-minify-css'), notify = require('gulp-notify'), plumber = require('gulp-plumber'), print = require('gulp-print'), prompt = require('gulp-prompt'), rename = require('gulp-rename'), replace = require('gulp-replace'), sourcemaps = require('gulp-sourcemaps'), uglify = require('gulp-uglify'), util = require('gulp-util'), watch = require('gulp-watch'), // config banner = require('./tasks/banner'), comments = require('./tasks/comments'), defaults = require('./tasks/defaults'), log = require('./tasks/log'), questions = require('./tasks/questions'), settings = require('./tasks/gulp-settings'), // admin release = require('./tasks/admin/release'), git = require('gulp-git'), githubAPI = require('github'), oAuthToken = fs.existsSync('./tasks/admin/oauth.js') ? require('./tasks/admin/oauth') : false, github, // local runSetup = false, overwrite = true, config, package, github, // derived base, clean, output, source, assetPaths, componentGlob, // temporary folder ; /******************************* Read Settings *******************************/ try { // try to load json var config = require(defaults.files.config), package = require(defaults.files.npm) ; } catch(error) { var config = false; } /******************************* Values Derived From Config *******************************/ var getConfigValues = function() { if(!config) { runSetup = true; config = defaults; } config = extend(true, {}, defaults, config); // shorthand base = config.base; clean = config.paths.clean; output = config.paths.output; source = config.paths.source; // create glob for matching filenames from selected components componentGlob = (typeof config.components == 'object') ? (config.components.length > 1) ? '{' + config.components.join(',') + '}' : config.components[0] : '' ; // relative paths assetPaths = { uncompressed : path.relative(output.uncompressed, output.themes), compressed : path.relative(output.compressed, output.themes), packaged : path.relative(output.packaged, output.themes) }; // add base to values for(var folder in source) { if(source.hasOwnProperty(folder)) { source[folder] = base + source[folder]; } } for(folder in output) { if(output.hasOwnProperty(folder)) { output[folder] = base + output[folder]; } } clean = base + clean; } ; getConfigValues(); /******************************* Tasks *******************************/ gulp.task('default', false, [ 'check install' ]); gulp.task('watch', 'Watch for site/theme changes (Default Task)', function(callback) { console.log('Watching source files'); if(!fs.existsSync(config.files.theme)) { console.error('Cant compile LESS. Run "grunt install" to create a theme config file'); return; } // watching changes in style gulp .watch([ source.config, source.definitions + '**/*.less', source.site + '**/*.{overrides,variables}', source.themes + '**/*.{overrides,variables}' ], function(file) { var srcPath, stream, compressedStream, uncompressedStream ; gulp.src(file.path) .pipe(print(log.modified)) ; // recompile only definition file srcPath = util.replaceExtension(file.path, '.less'); srcPath = srcPath.replace(config.regExp.themePath, source.definitions); srcPath = srcPath.replace(source.site, source.definitions); // get relative asset path (path returns wrong path? hardcoded) // assetPaths.source = path.relative(srcPath, path.resolve(source.themes)); assetPaths.source = '../../themes'; if( fs.existsSync(srcPath) ) { // unified css stream stream = gulp.src(srcPath) .pipe(plumber()) //.pipe(sourcemaps.init()) .pipe(less(settings.less)) .pipe(replace(comments.variables.in, comments.variables.out)) .pipe(replace(comments.large.in, comments.large.out)) .pipe(replace(comments.small.in, comments.small.out)) .pipe(replace(comments.tiny.in, comments.tiny.out)) .pipe(autoprefixer(settings.prefix)) ; // use 2 concurrent streams from same source uncompressedStream = stream.pipe(clone()); compressedStream = stream.pipe(clone()); uncompressedStream .pipe(replace(assetPaths.source, assetPaths.uncompressed)) //.pipe(sourcemaps.write('/', settings.sourcemap)) .pipe(header(banner, settings.header)) .pipe(gulp.dest(output.uncompressed)) .pipe(print(log.created)) .on('end', function() { gulp.start('package uncompressed css'); }) ; compressedStream = stream .pipe(clone()) .pipe(replace(assetPaths.source, assetPaths.compressed)) .pipe(minifyCSS(settings.minify)) .pipe(rename(settings.rename.minCSS)) //.pipe(sourcemaps.write('/', settings.sourcemap)) .pipe(header(banner, settings.header)) .pipe(gulp.dest(output.compressed)) .pipe(print(log.created)) .on('end', function() { gulp.start('package compressed css'); }) ; } }) ; // watch changes in assets gulp .watch([ source.themes + '**/assets/**' ], function(file) { // copy assets gulp.src(file.path, { base: source.themes }) .pipe(gulp.dest(output.themes)) .pipe(print(log.created)) ; }) ; // watch changes in js gulp .watch([ source.definitions + '**/*.js' ], function(file) { gulp.src(file.path) .pipe(gulp.dest(output.uncompressed)) .pipe(print(log.created)) .pipe(sourcemaps.init()) .pipe(uglify(settings.uglify)) .pipe(rename(settings.rename.minJS)) .pipe(gulp.dest(output.compressed)) .pipe(print(log.created)) .on('end', function() { gulp.start('package compressed js'); gulp.start('package uncompressed js'); }) ; }) ; }); // Builds all files gulp.task('build', 'Builds all files from source', function(callback) { var stream, compressedStream, uncompressedStream ; console.info('Building Semantic'); if(!fs.existsSync(config.files.theme)) { console.error('Cant build LESS. Run "grunt install" to create a theme config file'); return; } // get relative asset path (path returns wrong path?) // assetPaths.source = path.relative(srcPath, path.resolve(source.themes)); assetPaths.source = '../../themes'; // hardcoded // copy assets gulp.src(source.themes + '**/assets/**') .pipe(gulp.dest(output.themes)) ; // javascript stream gulp.src(source.definitions + '**/*.js') .pipe(flatten()) .pipe(gulp.dest(output.uncompressed)) .pipe(print(log.created)) // .pipe(sourcemaps.init()) .pipe(uglify(settings.uglify)) .pipe(rename(settings.rename.minJS)) .pipe(header(banner, settings.header)) .pipe(gulp.dest(output.compressed)) .pipe(print(log.created)) .on('end', function() { gulp.start('package compressed js'); gulp.start('package uncompressed js'); }) ; // unified css stream stream = gulp.src(source.definitions + '**/*.less') .pipe(plumber()) //.pipe(sourcemaps.init()) .pipe(less(settings.less)) .pipe(flatten()) .pipe(replace(comments.variables.in, comments.variables.out)) .pipe(replace(comments.large.in, comments.large.out)) .pipe(replace(comments.small.in, comments.small.out)) .pipe(replace(comments.tiny.in, comments.tiny.out)) .pipe(autoprefixer(settings.prefix)) ; // use 2 concurrent streams from same source uncompressedStream = stream.pipe(clone()); compressedStream = stream.pipe(clone()); uncompressedStream .pipe(replace(assetPaths.source, assetPaths.uncompressed)) //.pipe(sourcemaps.write('/', settings.sourcemap)) .pipe(header(banner, settings.header)) .pipe(gulp.dest(output.uncompressed)) .pipe(print(log.created)) .on('end', function() { gulp.start('package uncompressed css'); }) ; compressedStream = stream .pipe(clone()) .pipe(replace(assetPaths.source, assetPaths.compressed)) .pipe(minifyCSS(settings.minify)) .pipe(rename(settings.rename.minCSS)) //.pipe(sourcemaps.write('/', settings.sourcemap)) .pipe(header(banner, settings.header)) .pipe(gulp.dest(output.compressed)) .pipe(print(log.created)) .on('end', function() { callback(); gulp.start('package compressed css'); }) ; }); // cleans distribution files gulp.task('clean', 'Clean dist folder', function(callback) { return del([clean], settings.del, callback); }); gulp.task('version', 'Displays current version of Semantic', function(callback) { console.log('Semantic UI ' + package.version); }); /*-------------- Internal ---------------*/ gulp.task('package uncompressed css', false, function() { return gulp.src(output.uncompressed + '**/' + componentGlob + '!(*.min|*.map).css') .pipe(replace(assetPaths.uncompressed, assetPaths.packaged)) .pipe(concatCSS('semantic.css')) .pipe(gulp.dest(output.packaged)) .pipe(print(log.created)) ; }); gulp.task('package compressed css', false, function() { return gulp.src(output.uncompressed + '**/' + componentGlob + '!(*.min|*.map).css') .pipe(replace(assetPaths.uncompressed, assetPaths.packaged)) .pipe(concatCSS('semantic.min.css')) .pipe(minifyCSS(settings.minify)) .pipe(header(banner, settings.header)) .pipe(gulp.dest(output.packaged)) .pipe(print(log.created)) ; }); gulp.task('package uncompressed js', false, function() { return gulp.src(output.uncompressed + '**/' + componentGlob + '!(*.min|*.map).js') .pipe(replace(assetPaths.uncompressed, assetPaths.packaged)) .pipe(concat('semantic.js')) .pipe(header(banner, settings.header)) .pipe(gulp.dest(output.packaged)) .pipe(print(log.created)) ; }); gulp.task('package compressed js', false, function() { return gulp.src(output.uncompressed + '**/' + componentGlob + '!(*.min|*.map).js') .pipe(replace(assetPaths.uncompressed, assetPaths.packaged)) .pipe(concat('semantic.min.js')) .pipe(uglify(settings.uglify)) .pipe(header(banner, settings.header)) .pipe(gulp.dest(output.packaged)) .pipe(print(log.created)) ; }); /*-------------- Config ---------------*/ gulp.task('check install', false, function () { setTimeout(function() { if( runSetup || !fs.existsSync(config.files.site)) { console.log('No semantic.json file found. Starting install...'); gulp.start('install'); } else { gulp.start('watch'); } }, 50); }); gulp.task('install', 'Set-up project for first time', function () { console.clear(); gulp .src('gulpfile.js') .pipe(prompt.prompt(questions.setup, function(answers) { var siteVariable = /@siteFolder .*\'(.*)/mg, siteDestination = answers.site || config.folders.site, pathToSite = path.relative(path.resolve(config.folders.theme), path.resolve(siteDestination)), sitePathReplace = "@siteFolder : '" + pathToSite + "/';", configExists = fs.existsSync(config.files.config), themeConfigExists = fs.existsSync(config.files.theme), siteExists = fs.existsSync(siteDestination), jsonSource = (configExists) ? config.files.config : config.templates.config, json = { paths: { source: {}, output: {} } } ; // exit if config exists and user specifies no overwrite if(answers.overwrite !== undefined && answers.overwrite == 'no') { return; } console.clear(); console.log('Installing'); console.log('------------------------------'); // create site files if(siteExists) { console.info('Site folder exists, merging files (no overwrite)', siteDestination); } else { console.info('Creating site theme folder', siteDestination); } // copy recursively without overwrite wrench.copyDirSyncRecursive(config.templates.site, siteDestination, settings.wrench.recursive); // adjust less variable for site folder location console.info('Adjusting @siteFolder', sitePathReplace); if(themeConfigExists) { gulp.src(config.files.site) .pipe(replace(siteVariable, sitePathReplace)) .pipe(gulp.dest(config.folders.theme)) ; } else { console.info('Creating src/theme.config (LESS config)'); gulp.src(config.templates.theme) .pipe(rename({ extname : '' })) .pipe(replace(siteVariable, sitePathReplace)) .pipe(gulp.dest(config.folders.theme)) ; } // determine semantic.json config if(answers.components) { json.components = answers.components; } if(answers.dist) { answers.dist = answers.dist; json.paths.output = { packaged : answers.dist + '/', uncompressed : answers.dist + '/components/', compressed : answers.dist + '/components/', themes : answers.dist + '/themes/' }; } if(answers.site) { json.paths.source.site = answers.site + '/'; } if(answers.packaged) { json.paths.output.packaged = answers.packaged + '/'; } if(answers.compressed) { json.paths.output.compressed = answers.compressed + '/'; } if(answers.uncompressed) { json.paths.output.uncompressed = answers.uncompressed + '/'; } // write semantic.json if(configExists) { console.info('Extending semantic.json (Gulp config)'); gulp.src(jsonSource) .pipe(plumber()) .pipe(rename(settings.rename.json)) .pipe(jeditor(json)) .pipe(gulp.dest('./')) ; } else { console.info('Creating semantic.json (Gulp config)'); gulp.src(jsonSource) .pipe(plumber()) .pipe(rename({ extname : '' })) .pipe(jeditor(json)) .pipe(gulp.dest('./')) ; } console.log(''); console.log(''); })) .pipe(prompt.prompt(questions.cleanup, function(answers) { if(answers.cleanup == 'yes') { del(config.setupFiles); } if(answers.build == 'yes') { config = require(config.files.config); getConfigValues(); gulp.start('build'); } })) ; }); /******************************* Admin Tasks *******************************/ var adminQuestions = require('./tasks/admin/questions') ; gulp.task('docs', false, function() { gulp .src('gulpfile.js') .pipe(prompt.prompt(adminQuestions.docs, function(answers) { })) ; }); /* Moves watched files to static site generator output */ gulp.task('serve-docs', false, function () { config = require('./tasks/admin/docs.json'); getConfigValues(); // copy source files gulp .watch([ 'src/**/*.*' ], function(file) { console.clear(); return gulp.src(file.path, { base: 'src/' }) .pipe(gulp.dest(output.less)) .pipe(print(log.created)) ; }) ; gulp.start('watch'); }); /* Builds files to docs source */ gulp.task('build-docs', false, function () { console.clear(); // pushes to docpad files config = require('./tasks/admin/docs.json'); getConfigValues(); gulp.start('build'); // copy source gulp.src('src/**/*.*') .pipe(gulp.dest(output.less)) .pipe(print(log.created)) ; }); /* Release */ gulp.task('release', false, function() { // gulp bump // Ask for release type (minor, major, patch) // Bump package.json // Bump composer.json if(!oAuthToken) { console.error('Must add node include tasks/admin/oauth.js with oauth token for GitHub'); return; } github = new githubAPI({ version : '3.0.0', debug : true, protocol : 'https', timeout : 5000 }); github.authenticate({ type: "oauth", token: oAuthToken }); // gulp build gulp.start('release components'); // release-component // #Create SCSS Version // #Create RTL Release }); /* Bump Version */ gulp.task('bump', false, function () { // bump package.json // bump composer.json }); /*-------------- Internal ---------------*/ //gulp.task('release components', false, ['build', 'copy release components'], function() { gulp.task('release components', false, ['copy release components'], function() { var index = 0, total = release.components.length, stream, stepGit ; console.log('Handling git'); // Do Git commands synchronously, to avoid issues stepGit = function() { index = index + 1; var component = release.components[index], outputDirectory = release.folderRoot + component, capitalizedComponent = component.charAt(0).toUpperCase() + component.slice(1), repo = release.repoRoot + capitalizedComponent, gitURL = 'git@github.com:' + release.owner + '/' + repo + '.git', repoURL = 'https://github.com/' + release.owner + '/' + repo + '/', gitOptions = { cwd: path.resolve(outputDirectory) } ; // exit conditions if(index > total) { return; } // try pull git.pull('origin', 'master', gitOptions, function(error) { if(error) { // initialize local repo git.init(gitOptions, function(error) { if(error) { console.error('Error initializing repo', error); return; } // add remote url git.addRemote('origin', gitURL, gitOptions, function(error) { if(error) { console.error('Unable to add remote', error); } // try pull git.pull('origin', 'master', gitOptions, function(error) { if(error) { // Repo doesnt exist creating } stepGit(); }); }); }); } else { stepGit(); } }); }; stepGit(); // create bower.json *ignore* /* // check if is a repo locally git .add('./') ; // if not try creating repo github.repos.get({ user : release.owner, repo : release.repo }, function(error, response) { if(error) { console.log(error); } else { console.log(JSON.stringify(response)); } }); // after create add remote to git */ // create tagged version // Copy dist/components/{name}(.css|.min.css|.min.js|.js) to "../ui-{name}/" // (manually copy over asset changes) }); gulp.task('copy release components', false, function() { var stream, index ; console.log('Moving files to component folders'); for(index in release.components) { var component = release.components[index], outputDirectory = release.folderRoot + component ; // copy files into folder stream = gulp.src(output.compressed + component + '.*') .pipe(plumber()) .pipe(flatten()) .pipe(gulp.dest(outputDirectory)) // pipe to output directory ; } });