From ac8d0bc00bdc5bccb5a5590f503416d60b98251e Mon Sep 17 00:00:00 2001 From: jlukic Date: Tue, 21 Oct 2014 13:23:16 -0400 Subject: [PATCH] Moving more values to config --- gulpfile.js | 148 ++++++++++-------- .../docs-files.json => admin/docs.json} | 0 tasks/admin/questions.js | 42 +++++ tasks/defaults.js | 45 +++++- tasks/maintainer/docs-output.json | 19 --- 5 files changed, 161 insertions(+), 93 deletions(-) rename tasks/{maintainer/docs-files.json => admin/docs.json} (100%) mode change 100755 => 100644 create mode 100644 tasks/admin/questions.js delete mode 100755 tasks/maintainer/docs-output.json diff --git a/gulpfile.js b/gulpfile.js index 2aafac7d4..712e6158f 100755 --- a/gulpfile.js +++ b/gulpfile.js @@ -9,46 +9,46 @@ var - gulp = require('gulp-help')(require('gulp')), + gulp = require('gulp-help')(require('gulp')), // node components & oddballs - del = require('del'), - fs = require('fs'), - path = require('path'), - console = require('better-console'), - wrench = require('wrench'), + del = require('del'), + fs = require('fs'), + path = require('path'), + console = require('better-console'), + 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'), + 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'), + 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'), // local overwrite = true, @@ -77,8 +77,8 @@ var try { // try to load json var - config = require('./semantic.json'), - package = require('./package.json') + config = require(defaults.files.config), + package = require(defaults.files.npm) ; } catch(error) { @@ -147,6 +147,11 @@ gulp.task('watch', 'Watch for site/theme changes (Default Task)', function () { console.clear(); console.log('Watching source files'); + if(!fs.existsSync(defaults.files.theme)) { + console.error('Cant compile LESS. Run "grunt install" to create a theme config file'); + return; + } + // watching changes in style gulp .watch([ @@ -271,6 +276,11 @@ gulp.task('build', 'Builds all files from source', function(callback) { console.info('Building Semantic'); + if(!fs.existsSync(defaults.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 @@ -402,7 +412,7 @@ gulp.task('package compressed js', false, function() { gulp.task('check install', false, function () { setTimeout(function() { - if( !config || !fs.existsSync('./src/theme.config')) { + if( !config || !fs.existsSync(defaults.files.site)) { console.log('No semantic.json file found. Starting install...'); gulp.start('install'); } @@ -418,26 +428,20 @@ gulp.task('install', 'Set-up project for first time', function () { .src('gulpfile.js') .pipe(prompt.prompt(questions.setup, function(answers) { var - siteVariable = /@siteFolder .*\'(.*)/mg, - templates = { - themeConfig : './src/theme.config.example', - jsonConfig : './semantic.json.example', - site : './src/_site' - }, + siteVariable = /@siteFolder .*\'(.*)/mg, - siteDestination = answers.site || './src/site', - themeDestination = './src/', + siteDestination = answers.site || defaults.folders.site, - pathToSite = path.relative(path.resolve('./src'), path.resolve('./' + siteDestination)), + pathToSite = path.relative(path.resolve(defaults.folders.theme), path.resolve('./' + siteDestination)), sitePathReplace = "@siteFolder : '" + pathToSite + "/';", - configExists = fs.existsSync('./semantic.json'), - themeConfigExists = fs.existsSync('./src/theme.config'), + configExists = fs.existsSync(defaults.files.config), + themeConfigExists = fs.existsSync(defaults.files.site), siteExists = fs.existsSync(siteDestination), - jsonSource = (configExists) - ? './semantic.json' - : './semantic.json.example', + jsonSource = (configExists) + ? defaults.files.config + : defaults.templates.config, json = { paths: { source: {}, @@ -463,22 +467,22 @@ gulp.task('install', 'Set-up project for first time', function () { console.info('Creating site theme folder', siteDestination); } // copy recursively without overwrite - wrench.copyDirSyncRecursive(templates.site, siteDestination, settings.wrench.recursive); + wrench.copyDirSyncRecursive(defaults.templates.site, siteDestination, settings.wrench.recursive); // adjust less variable for site folder location - console.info('Adjusting @siteFolder', defaults.paths.source.config, themeDestination); + console.info('Adjusting @siteFolder', pathToSite); if(themeConfigExists) { - gulp.src('./src/theme.config') + gulp.src(defaults.files.site) .pipe(replace(siteVariable, sitePathReplace)) - .pipe(gulp.dest(themeDestination)) + .pipe(gulp.dest(defaults.folders.theme)) ; } else { console.info('Creating src/theme.config (LESS config)'); - gulp.src(templates.themeConfig) + gulp.src(defaults.templates.theme) .pipe(rename({ extname : '' })) .pipe(replace(siteVariable, sitePathReplace)) - .pipe(gulp.dest(themeDestination)) + .pipe(gulp.dest(defaults.folders.theme)) ; } @@ -533,14 +537,10 @@ gulp.task('install', 'Set-up project for first time', function () { })) .pipe(prompt.prompt(questions.cleanup, function(answers) { if(answers.cleanup == 'yes') { - del([ - './src/theme.config.example', - './semantic.json.example', - './src/_site' - ]); + del(defaults.setupFiles); } if(answers.build == 'yes') { - config = require('./semantic.json'); + config = require(defaults.files.config); getConfigValues(); gulp.start('build'); } @@ -548,19 +548,29 @@ gulp.task('install', 'Set-up project for first time', function () { ; }); +/******************************* + Admin Tasks +*******************************/ +var + adminQuestions = require('./tasks/admin/questions') +; +gulp.task('docs', false, function() { + gulp + .src('gulpfile.js') + .pipe(prompt.prompt(adminQuestions.docs, function(answers) { - -/*-------------- - Maintainer ----------------*/ + })) + ; +}); /* Moves watched files to static site generator output */ gulp.task('serve-docs', false, function () { - config = require('./tasks/maintainer/docs-output.json'); + config = require('./tasks/admin/docs.json'); getConfigValues(); + // copy source files gulp .watch([ @@ -580,7 +590,7 @@ gulp.task('serve-docs', false, function () { gulp.task('build-docs', false, function () { console.clear(); // pushes to docpad files - config = require('./tasks/maintainer/docs-output.json'); + config = require('./tasks/admin/docs.json'); getConfigValues(); gulp.start('build'); diff --git a/tasks/maintainer/docs-files.json b/tasks/admin/docs.json old mode 100755 new mode 100644 similarity index 100% rename from tasks/maintainer/docs-files.json rename to tasks/admin/docs.json diff --git a/tasks/admin/questions.js b/tasks/admin/questions.js new file mode 100644 index 000000000..1e2ca25df --- /dev/null +++ b/tasks/admin/questions.js @@ -0,0 +1,42 @@ +/******************************* + Install Questions +*******************************/ + +var defaults, fs, filter, when; + +fs = require('fs'); +defaults = require('../defaults'); + +filter = { + removeTrailingSlash: function(path) { + return path.replace(/(\/$|\\$)+/mg, ''); + } +}; + +when = { + + +}; + +module.exports = { + + docs: [ + { + type: 'list', + name: 'action', + message: 'How should we provide files to docs?', + when: when.hasConfig, + choices: [ + { + name: 'Watch changes', + value: 'docs-serve' + }, + { + name: 'Build all files', + value: 'docs-build' + } + ] + } + ] + +}; \ No newline at end of file diff --git a/tasks/defaults.js b/tasks/defaults.js index 81ac58e61..4bfbecf9c 100755 --- a/tasks/defaults.js +++ b/tasks/defaults.js @@ -4,6 +4,45 @@ module.exports = { base : '', + + theme : './src/theme.config', + + docs : { + source : '../docs/server/files/release/', + output : '../docs/release/' + }, + + // files cleaned after install + setupFiles: [ + './src/theme.config.example', + './semantic.json.example', + './src/_site' + ], + + // modified to create configs + templates: { + config : './semantic.json.example', + site : './src/_site', + theme : './src/theme.config.example' + }, + + // folder pathsr + folders: { + config : './', + site : './src/site', + theme : './src/' + }, + + // file paths + files: { + composer : 'composer.json', + config : './semantic.json', + npm : './package.json', + site : './src/site', + theme : './src/theme.config' + }, + + // same as semantic.json.example paths: { source: { config : 'src/theme.config', @@ -17,10 +56,6 @@ module.exports = { compressed : 'dist/components/', themes : 'dist/themes/' }, - clean : 'dist/', - docs : { - source : '../docs/server/files/release/', - output : '../docs/release/' - } + clean : 'dist/' } }; \ No newline at end of file diff --git a/tasks/maintainer/docs-output.json b/tasks/maintainer/docs-output.json deleted file mode 100755 index def2e8a3e..000000000 --- a/tasks/maintainer/docs-output.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "base": "", - "paths": { - "source": { - "config": "src/theme.config", - "definitions": "src/definitions/", - "site": "src/site/", - "themes": "src/themes/" - }, - "output": { - "less": "../docs/out/src/", - "packaged": "../docs/out/dist/", - "uncompressed": "../docs/out/dist/components/", - "compressed": "../docs/out/dist/components/", - "themes": "../docs/out/dist/themes/" - }, - "clean": "../docs/out/dist/" - } -} \ No newline at end of file