generator-white-label 3.2.0 → 5.0.0

package/gulp/config.js

@@ -1,224 +0,0 @@
-(() => {
-
-    'use strict';
-
-    // ## Load Modules
-
-    const yargs = require('yargs').argv;
-
-    // ## Environment Config
-
-    let isProduction;
-    if (yargs.production) {
-        isProduction = yargs.production;
-    } else {
-        isProduction = false;
-    }
-
-    // setting the build version
-    let version;
-    if (yargs.version) {
-        version = yargs.version;
-    } else {
-        //by default set the version to a timestamp
-        version = Math.floor(new Date() / 1000);
-    }
-
-    //setting a www domain for build
-    let www;
-    //test if www is defined
-    if (yargs.www) {
-        www = yargs.www + '/';
-    } else {
-        www = '/';
-    }
-
-    //setting a cdn domain for build
-    let cdn;
-    //test if cdn is defined
-    if (yargs.cdn) {
-        cdn = yargs.cdn + '/release/' + version + '/';
-    } else {
-        cdn = '/';
-    }
-
-    //setting a service domain for build
-    let service;
-    //test if www is defined
-    if (yargs.service) {
-        service = yargs.service + '/';
-    } else {
-        service = '/service-endpoint/';
-    }
-
-    // ## paths
-    module.exports = {
-        // ## Path Variables
-        path: {
-            // ### build
-            // where to save deployable files
-            build: '_deploy',
-            root: 'app/',
-            version: version,
-            www: www,
-            cdn: cdn,
-            service: service,
-            proxy: {
-                target: 'http://127.0.0.1:8000/service-endpoint',
-                rewrite: {
-                    '/service-endpoint': '/'
-                }
-            },
-            // is this a production build?
-            isProduction: isProduction,
-            // ### image
-            image: {
-                // glob of all image files and directories
-                source: [
-                    'app/assets/image/**'
-                ],
-                // location to save processed images by tasks
-                destination: 'assets/image'
-            },
-            // ### markup
-            markup: {
-                // htmllint config file
-                htmlLint: '.htmllintrc',
-                // glob of handlebars templates
-                source: [
-                    'app/**/*.hbs',
-                    'app/**/*.handlebars',
-                    '!app/assets/**',
-                    '!app/report/**',
-                    '!app/service/**'
-                ],
-                // glob of generated html files
-                destination: [
-                    'app/**/*.html',
-                    '!app/assets/**',
-                    '!app/report/**',
-                    '!app/service/**'
-                ],
-                partials: {
-                    //glob of handlebars partials
-                    source: [
-                        'app/assets/markup'
-                    ],
-                    // glob of handlebars partials, needed for watch task
-                    watch: 'app/assets/markup/**',
-                    // where to save generated js templates
-                    destination: 'app/assets/script/template'
-                }
-            },
-            // ### font
-            font: {
-                // glob of fonts
-                source: 'app/assets/font/**',
-                // where to save fonts
-                destination: 'assets/font'
-            },
-            // ### script
-            script: {
-                // karma test runner conig file
-                karma: __dirname + '/../karma.conf.js',
-                // where to save out the modernizr built file
-                modernizr: 'node_modules/modernizr/modernizr.js',
-                // glob of all js files including gulp and application
-                all: [
-                    '*.js',
-                    'gulp/tasks/*.js',
-                    'gulp/*.js',
-                    'app/assets/script/**',
-                    'app/assets/test/spec/*.js',
-                    'app/assets/test/*.js',
-                    '!app/assets/script/template/**',
-                    '!app/assets/script/*.compiled.js'
-                ],
-                // glob of only gulp js files for documentation task
-                gulp: [
-                    '*.js',
-                    'gulp/tasks/*.js',
-                    'gulp/*.js'
-                ],
-                // glob of only application files for documentation task
-                source: [
-                    'app/assets/script/*.js',
-                    'app/assets/script/**',
-                    '!app/assets/script/template/**',
-                    '!app/assets/script/*.compiled.js'
-                ],
-                // glob js files to be delployed duirng release
-                release: 'app/assets/script/*.compiled.js',
-                // file to be compliled by browserify
-                compile: {
-                    source: 'app/assets/script/global.js',
-                    destination: 'app/assets/script',
-                    filename: 'global.compiled.js'
-                },
-                // where to save script files in release task
-                destination: 'assets/script',
-                // common libraries found when browserify builds entries
-                entriesGlobal: 'app/assets/script/global.compiled.js',
-                // browserify entries
-                entries: 'app/assets/script/*.js'
-            },
-            // ### style
-            style: {
-                // scsslint config file
-                scssLint: '.scss-lint.yml',
-                source: {
-                    // glob of all scss files
-                    scss: [
-                        'app/assets/style/*.scss',
-                        'app/assets/style/**/*.scss'
-                    ],
-                    // glob of all css files
-                    css: [
-                        'app/assets/style/*.css'
-                    ]
-                },
-                // where to save style files
-                destination: {
-                    watch: 'app/assets/style',
-                    release: 'assets/style'
-                }
-            },
-            // ### font
-            data: {
-                // where to save data returns glob
-                sourceGlob: 'app/assets/data/**',
-                // where to save data
-                source: 'app/assets/data',
-                // where to save data
-                destination: 'assets/data',
-                // global config data
-                globalConfig: {
-                    'www': www,
-                    'cdn': cdn,
-                    'service': service,
-                    'version': version
-                },
-                // global config file name
-                globalConfigFile: 'app/assets/data/config.json',
-                pageDirectory: 'view/',
-                pageDefaultData: 'global.json'
-            },
-            // ### release
-            release: {
-                destination: '/release/',
-                copy: [
-                    'app/sitemap.xml',
-                    'app/robots.txt',
-                    'app/favicon.ico'
-                ]
-            },
-            // ### report
-            report: {
-                // where to save code complexity report
-                source: 'app/report/**',
-                destination: 'report'
-            }
-        }
-    };
-
-})();

package/gulp/tasks/accessibility.js

@@ -1,34 +0,0 @@
-'use strict';
-
-// ## Load Modules
-
-const gulp = require('gulp');
-const accessibility = require('gulp-accessibility');
-const plumber = require('gulp-plumber');
-const notify = require('gulp-notify');
-
-// ## Environment Config
-
-const config = require('../config');
-
-// ## Accessibility Task
-// dependacy on markup task to have markup compiled
-
-gulp.task('accessibility', () => {
-
-    return gulp.src(config.path.markup.destination)
-        //support for better error handling
-        .pipe(plumber())
-        //show only errors for AAA spec
-        .pipe(accessibility({
-            accessibilityLevel: 'WCAG2AAA',
-            reportLevels: {
-                notice: false,
-                warning: false,
-                error: true,
-                verbose: true
-            }
-        }))
-        .on('error', notify.onError('accessibility: <%= error.message %>'));
-
-});

package/gulp/tasks/build.js

@@ -1,19 +0,0 @@
-'use strict';
-
-// ## Load Modules
-
-const gulp = require('gulp');
-const runSequence = require('run-sequence');
-
-// ## Build Task
-
-gulp.task('build', callback => {
-    //runSequence support is only for gulp 3.x, 4.x natively support this functionalty
-    return runSequence(
-        ['cleanTemplate'],
-        ['data'],
-        ['markup', 'style', 'script', 'documentation'],
-        ['accessibility'],
-        callback
-    );
-});

package/gulp/tasks/clean.js

@@ -1,34 +0,0 @@
-'use strict';
-
-// ## Load Modules
-
-const gulp = require('gulp');
-const rimraf = require('gulp-rimraf');
-
-// ## Environment Config
-
-const config = require('../config');
-
-// ## cleanDeploy Task
-
-gulp.task('cleanDeploy', (done) => {
-    'use strict';
-    return gulp.src(config.path.build, {read: false})
-        .pipe(rimraf());
-});
-
-// ## cleanTemplate Task
-
-gulp.task('cleanTemplate', (done) => {
-    'use strict';
-    return gulp.src(config.path.markup.partials.destination, {read: false})
-        .pipe(rimraf());
-});
-
-// ## cleanHTML Task
-
-gulp.task('cleanHTML', (done) => {
-    'use strict';
-    return gulp.src(config.path.markup.destination, {read: false})
-        .pipe(rimraf());
-});

package/gulp/tasks/data.js

@@ -1,22 +0,0 @@
-'use strict';
-
-// ## Load Modules
-
-const gulp = require('gulp');
-const fs = require('fs');
-
-// ## Environment Config
-
-const config = require('../config');
-
-// ## Data Write Config json Task
-
-gulp.task('data', callback => {
-
-    fs.writeFile(
-        config.path.data.globalConfigFile,
-        JSON.stringify(config.path.data.globalConfig),
-        callback
-    );
-
-});

package/gulp/tasks/default.js

@@ -1,9 +0,0 @@
-'use strict';
-
-// ## Load Modules
-
-const gulp = require('gulp');
-
-// ## Default Task
-// this is just a proxy for watch
-gulp.task('default', ['watch']);

package/gulp/tasks/deploy.js

@@ -1,225 +0,0 @@
-'use strict';
-
-// ## Load Modules
-
-const gulp = require('gulp');
-const htmlmin = require('gulp-htmlmin');
-const sourcemaps = require('gulp-sourcemaps');
-const imagemin = require('gulp-imagemin');
-const stripDebug = require('gulp-strip-debug');
-const uglify = require('gulp-uglify');
-const plumber = require('gulp-plumber');
-const sitemap = require('gulp-sitemap');
-const runSequence = require('run-sequence');
-const cssnano = require('gulp-cssnano');
-const sizereport = require('gulp-sizereport');
-
-// ## Environment Config
-
-const config = require('../config');
-
-// ## Release Task
-// release task dependent on tasks to do code quality checks and build documentation
-
-gulp.task('deploy', callback => {
-    //runSequence support is only for gulp 3.x, 4.x natively support this functionalty
-    return runSequence(
-        ['cleanDeploy', 'cleanTemplate'],
-        ['data'],
-        ['markup', 'style', 'script', 'documentation'],
-        ['accessibility'],
-        ['copyRoot', 'copyReport', 'copyFonts', 'minifyMarkup', 'copyData', 'minifyStyle', 'minifyScript',
-            'minifyImage', 'sitemap'],
-        ['sizeReportCSS', 'sizeReportJS', 'sizeReportImage'],
-        callback
-    );
-});
-
-// ## Copy Root Task
-// copy root dependency files to deploy directory
-gulp.task('copyRoot', () => {
-    return gulp.src(config.path.release.copy)
-        //support for better error handling
-        .pipe(plumber())
-        .pipe(gulp.dest(config.path.build));
-
-});
-
-// ## Copy Report Task
-// copy report dependency files to deploy directory
-gulp.task('copyReport', () => {
-    return gulp.src(config.path.report.source)
-        //support for better error handling
-        .pipe(plumber())
-        .pipe(gulp.dest(config.path.build + '/' + config.path.report.destination));
-
-});
-
-// ## Copy Fonts Task
-// copy Font dependency files to deploy directory
-gulp.task('copyFonts', () => {
-    return gulp.src(config.path.font.source)
-        //support for better error handling
-        .pipe(plumber())
-        .pipe(gulp.dest(config.path.build + config.path.release.destination + config.path.version + '/' +
-            config.path.font.destination));
-
-});
-
-// ## Minify Markup Task
-// minify and copy markup files to deploy directory
-gulp.task('minifyMarkup', () => {
-    return gulp.src(config.path.markup.destination)
-        //support for better error handling
-        .pipe(plumber())
-        //minify
-        .pipe(htmlmin({
-            collapseWhitespace: true,
-            minifyJS: true
-        }))
-        .pipe(gulp.dest(config.path.build));
-
-});
-
-// ## Copy Data Task
-// copy data dependency files to deploy directory
-gulp.task('copyData', () => {
-    return gulp.src(config.path.data.sourceGlob)
-        //support for better error handling
-        .pipe(plumber())
-        .pipe(gulp.dest(config.path.build + config.path.release.destination + config.path.version + '/' +
-            config.path.data.destination));
-
-});
-
-// ## Sitemap Task
-// generate sitemap.xml
-gulp.task('sitemap', () => {
-    return gulp.src(config.path.markup.destination)
-        .pipe(sitemap({
-            siteUrl: config.path.www
-        }))
-        .pipe(gulp.dest(config.path.build));
-
-});
-
-// ## Minify Style Task
-// minify and copy style files to deploy diretory
-gulp.task('minifyStyle', () => {
-    return gulp.src(config.path.style.source.css)
-        //support for better error handling
-        .pipe(plumber())
-        .pipe(sourcemaps.init())
-        .pipe(cssnano({safe: true}))
-        .pipe(sourcemaps.write('.'))
-        .pipe(gulp.dest(config.path.build + config.path.release.destination + config.path.version + '/' +
-            config.path.style.destination.release));
-
-});
-
-// ## Minify Script Task
-// minify and copy script files to deploy directory
-gulp.task('minifyScript', () => {
-    return gulp.src(config.path.script.release)
-        //support for better error handling
-        .pipe(plumber())
-        .pipe(sourcemaps.init())
-        //remove console.log and alert
-        .pipe(stripDebug())
-        //minify
-        .pipe(uglify())
-        //write sourcemaps
-        .pipe(sourcemaps.write('.'))
-        .pipe(gulp.dest(config.path.build + config.path.release.destination + config.path.version + '/' +
-            config.path.script.destination));
-
-});
-
-// ## Minify Image Task
-// minify and copy images to deploy directory
-gulp.task('minifyImage', () => {
-    return gulp.src(config.path.image.source)
-        //support for better error handling
-        .pipe(plumber())
-        //minify
-        .pipe(imagemin({
-            progressive: true,
-            multipass: true,
-            plugins: [
-                {cleanupAttrs: true},
-                {cleanupEnableBackground: true},
-                {cleanupIDs: true},
-                {cleanupNumericValues: true},
-                {collapseGroup: true},
-                {convertColors: true},
-                {convertPathData: true},
-                {convertShapeToPath: true},
-                {convertStyleToAttrs: true},
-                {convertTransform: true},
-                {mergePaths: true},
-                {moveElemsAttrsToGroup: true},
-                {moveGroupAttrsToElems: true},
-                {removeComments: true},
-                {removeDoctype: true},
-                {removeEditorsNSData: true},
-                {removeEmptyAttrs: true},
-                {removeEmptyContainers: true},
-                {removeEmptyText: true},
-                {removeHiddenElems: true},
-                {removeMetadata: true},
-                {removeNonInheritableGroupAttrs: true},
-                {removeRasterImages: true},
-                {removeTitle: true},
-                {removeUnknownsAndDefaults: true},
-                {removeUnusedNS: true},
-                {removeUselessStrokeAndFill: true},
-                {removeViewBox: true},
-                {removeXMLProcInst: true},
-                {sortAttrs: true},
-                {transformsWithOnePath: true}
-            ]
-        }))
-        .pipe(gulp.dest(config.path.build + config.path.release.destination + config.path.version + '/' +
-            config.path.image.destination));
-});
-
-// ## CSS Size Report Task
-// check to see how big the files being created are
-gulp.task('sizeReportCSS', () => {
-    return gulp.src(config.path.build + config.path.release.destination + config.path.version + '/' +
-        config.path.style.destination.release + '/*.css')
-        .pipe(sizereport({
-            gzip: true,
-            '*': {
-                'maxGzippedSize': 25000
-            }
-        }));
-});
-
-// ## JS Size Report Task
-// check to see how big the files being created are
-gulp.task('sizeReportJS', () => {
-    return gulp.src(config.path.build + config.path.release.destination + config.path.version + '/' +
-        config.path.script.destination + '/*.js')
-        .pipe(sizereport({
-            gzip: true,
-            '*': {
-                'maxGzippedSize': 200000
-            }
-        }));
-});
-
-// ## Markup Size Report Task
-// check to see how big the files being created are
-gulp.task('sizeReportImage', () => {
-    return gulp.src(config.path.build + config.path.release.destination + config.path.version + '/' +
-        config.path.image.destination + '/**')
-        .pipe(plumber())
-        .pipe(sizereport({
-            gzip: true,
-            '*': {
-                'maxSize': 1000000,
-                'maxGzippedSize': 1000000
-            }
-        }));
-});

package/gulp/tasks/documentation.js

@@ -1,25 +0,0 @@
-'use strict';
-
-// ## Load Modules
-
-const gulp = require('gulp');
-const jsdoc = require('gulp-jsdoc3');
-
-// ## Environment Config
-
-const config = require('../config');
-const jsdocConfig = require('../../jsdoc');
-
-// ## jsdoc Task
-// runs jsdoc
-gulp.task('jsdoc', (callback) => {
-    gulp.src(config.path.script.all, {read: false})
-        .pipe(jsdoc(jsdocConfig, callback));
-});
-
-// ## Documenation Task
-// documentation task runs unit testing coverage and also js documentation
-gulp.task('documentation', [
-    'jsdoc',
-    'unit'
-]);