stop14-themesystem-legacy 2.0.9 → 2.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
  "name": "stop14-themesystem-legacy",
- "version": "2.0.9",
+ "version": "2.1.0",
  "description": "A scaffolding and build system for theme development across platforms. Legacy version",
  "author": {
   "name": "Bill Kennedy",

package/scaffolding/drupal/gulpfile.js

@@ -1,9 +1,67 @@
+/**
+ * Gulp Packages
+ */
+
+/*
+ * Key Commands.
+ * Alternative config file
+ * gulp build --config ./alt-config/configfile.yml
+ *
+ * Alternative source folder
+ * gulp build --source ./alt-source-folder
+ *
+ * Alternative source image folder
+ * gulp build --sourceimgs ./alt-img-folder
+ *
+ * Alternative asset (destination) folder
+ * gulp build --dest ./asset-sitename
+ *
+ * Alternative source and dest
+ * gulp build --source ./source-sitename -dest ./asset-sitename
+ */
+
+// General
+var {gulp, src, dest, watch, series, parallel, task} = require('gulp');
+var del = require('del');
+var flatmap = require('gulp-flatmap');
+var lazypipe = require('lazypipe');
+var rename = require('gulp-rename');
+var header = require('gulp-header');
+var package = require('./package.json');
+var exec = require('gulp-exec');
+var fs = require('fs');
+var path = require('path');
+var argv = require('yargs').argv; // Must be version 16, as 17 is ES-only.
+
+// Scripts
+var eslint = require('gulp-eslint');
+var concat = require('gulp-concat');
+var uglify = require('gulp-terser');
+var modernizr = require('gulp-modernizr');
+
+// Styles
+var sass = require('gulp-dart-sass');
+var sourcemaps = require("gulp-sourcemaps");
+var postcss = require('gulp-postcss');
+var autoprefixer = require('autoprefixer');
+var cssnano = require('cssnano');
+
+// PNG
+
+var imagemin = require('gulp-imagemin');
+imagemin.optipng({optimizationLevel: 7});
+
+// SVGs
+var svgmin = require('gulp-svgmin');
+
+// BrowserSync
+var browserSync = require('browser-sync');
+
 /**
  * Settings
  * Turn on/off build features
  */
 
-
 var settings = {
   clean: true,
   coreScripts: true,
@@ -20,65 +78,81 @@ var settings = {
 };
 
 
+
 /**
  * Paths to project folders
  */
 
-var package_dir = "./node_modules/stop14-themesystem-legacy/source";
-var source_dir = './source';
-var build_dir = './assets';
-
-var paths = {
-  input: source_dir,
-  output: build_dir,
-  scripts: {
-    core: package_dir + '/js',
-    input: source_dir + '/js',
-    output: build_dir + '/js/',
-    coreFilename: 'core',
-    cfilename: 'default', // Output file name for concatenated scripts. Set to false to use output folder name
-    vfilename: 'vendor' // Output file name for vendor scripts
-  },
-  styles: {
-    input: source_dir + '/sass/**/*.{scss,sass}',
-    output: build_dir + '/css',
-    vfilename: 'vendor', // Output file name for vendor styles
-    sassIncludePaths: [package_dir + '/sass/a_components',package_dir + '/sass/b_profiles',source_dir + '/sass',package_dir + '/sass/a_components/00_general',package_dir + '/sass/a_components/10_colours_and_patterns', package_dir + '/sass/a_components/20_layout',package_dir + '/sass/a_components/30_typography',package_dir + '/sass/a_components/40_ui',package_dir + '/sass/a_components/50_animation',package_dir + '/sass/a_components/60_site_elements','node_modules']
-  },
-  img: {
-    input: source_dir + '/img/**/*',
-    output: build_dir + '/img'
-  },
-  svgs: {
-    input: source_dir + '/img/svg/**/*.svg',
-    output: build_dir + '/img/svg/',
-  },
-  pngs: {
-    input: source_dir + '/img/png/**/*.png',
-    output: build_dir + '/img/png/',
-  },
-  jpgs: {
-    input: source_dir + '/img/jpg/**/*.jpg',
-    output: build_dir + '/img/jpg/',
-  },
-  fonts: {
-    input: source_dir + '/fonts/**/*',
-    output: build_dir + '/fonts',
-  },
-  copy: {
-    input: source_dir + '/copy/**/*',
-    output: build_dir
-  },
-  reload: './'
-};
-
 
+var package_dir = "./node_modules/stop14-themesystem-legacy/source";
+var asset_basename = 'assets';
+var alt_config_filename = typeof argv.config !== "undefined" ? argv.config : null;
+var source_dir = typeof argv.source !== "undefined" ? argv.source : './source';
+var build_dir = typeof argv.dest !== "undefined" ? argv.dest : './' + asset_basename;
+var source_image_dir = typeof argv.sourceimgs !== "undefined" ? './' + argv.sourceimgs : null;
+var alt_config_dir = './alt-config';
+const ymlFilePattern = /([^.]*).yml/i;
+
+
+console.log(argv.sourceimgs);
+
+var paths = getPaths(source_dir,build_dir);
+
+
+function getPaths(source_dir,build_dir) {
+  return {
+     input: source_dir,
+     output:  build_dir,
+     scripts: {
+       core: package_dir + '/js',
+       input: source_dir + '/js',
+       output: build_dir + '/js/',
+       coreFilename: 'core',
+       cfilename: 'default', // Output file name for concatenated scripts. Set to false to use output folder name
+       vfilename: 'vendor' // Output file name for vendor scripts
+     },
+     styles: {
+       config: '_00_main_configuration.yml', // Main SASS config file
+       tempconfig: '_00_temp_configuration.yml', // Location of temporary styles
+       altconfig: alt_config_filename, // Alternative config file for generating alternative asset sets
+       input: source_dir + '/sass/**/*.{scss,sass}',
+       output: build_dir + '/css',
+       vfilename: 'vendor', // Output file name for vendor styles
+       sassIncludePaths: [package_dir + '/sass/a_components',package_dir + '/sass/b_profiles',source_dir + '/sass',package_dir + '/sass/a_components/00_general',package_dir + '/sass/a_components/10_colours_and_patterns', package_dir + '/sass/a_components/20_layout',package_dir + '/sass/a_components/30_typography',package_dir + '/sass/a_components/40_ui',package_dir + '/sass/a_components/50_animation',package_dir + '/sass/a_components/60_site_elements','node_modules']
+     },
+     img: {
+       input: source_image_dir ? source_image_dir + '/**/*' : source_dir + '/img/**/*',
+       output: build_dir + '/img'
+     },
+     svgs: {
+       input: source_image_dir ? source_image_dir + '/svg/**/*.svg' : source_dir + '/img/svg/**/*.svg',
+       output: build_dir + '/img/svg/',
+     },
+     pngs: {
+       input: source_image_dir ? source_image_dir + '/png/**/*.png' : source_dir + '/img/png/**/*.png',
+       output: build_dir + '/img/png/',
+     },
+     jpgs: {
+       input: source_image_dir ? source_image_dir + '/jpg/**/*.jpg' : source_dir + '/img/jpg/**/*.jpg',
+       output: build_dir + '/img/jpg/',
+     },
+     fonts: {
+       input: source_dir + '/fonts/**/*',
+       output: build_dir + '/fonts',
+     },
+     copy: {
+       input: source_dir + '/copy/**/*',
+       output: build_dir
+     },
+     reload: './'
+   };
+}
 /**
  * Copy third-party scripts and styles.
  */
 
-var vendor_scripts = ['node_modules/ev-emitter/ev-emitter.js','node_modules/imagesloaded/imagesloaded.js','node_modules/jquery-reflow-table/dist/js/reflow-table.js','node_modules/in-view/dist/in-view.min.js','node_modules/select2/dist/js/select2.min.js'];
-var vendor_styles = ['node_modules/jquery-reflow-table/dist/css/reflow-table.css','node_modules/select2/dist/css/select2.min.css'];
+var vendor_scripts = ['node_modules/superfish/dist/js/hoverIntent.js','node_modules/superfish/dist/js/superfish.js','node_modules/ev-emitter/ev-emitter.js','node_modules/imagesloaded/imagesloaded.js','node_modules/jquery-reflow-table/dist/js/reflow-table.js','node_modules/in-view/dist/in-view.min.js','node_modules/select2/dist/js/select2.min.js', 'node_modules/masonry-layout/dist/masonry.pkgd.js'];
+var vendor_styles = ['node_modules/superfish/dist/css/superfish.css','node_modules/jquery-reflow-table/dist/css/reflow-table.css','node_modules/select2/dist/css/select2.min.css'];
 
 
 /**
@@ -135,45 +209,6 @@ if (typeof package === "undefined") {
   };
 }
 
-
-/**
- * Gulp Packages
- */
-
-// General
-var {gulp, src, dest, watch, series, parallel} = require('gulp');
-var del = require('del');
-var flatmap = require('gulp-flatmap');
-var lazypipe = require('lazypipe');
-var rename = require('gulp-rename');
-var header = require('gulp-header');
-var package = require('./package.json');
-var exec = require('gulp-exec');
-
-// Scripts
-var eslint = require('gulp-eslint');
-var concat = require('gulp-concat');
-var uglify = require('gulp-terser');
-var modernizr = require('gulp-modernizr');
-
-// Styles
-var sass = require('gulp-dart-sass');
-var sourcemaps = require("gulp-sourcemaps");
-var postcss = require('gulp-postcss');
-var autoprefixer = require('autoprefixer');
-var cssnano = require('cssnano');
-
-// PNG
-
-var imagemin = require('gulp-imagemin');
-imagemin.optipng({optimizationLevel: 7});
-
-// SVGs
-var svgmin = require('gulp-svgmin');
-
-// BrowserSync
-var browserSync = require('browser-sync');
-
 /**
  *  Define CSS Plugins
  */
@@ -194,6 +229,7 @@ var cleanDist = function (done) {
 
   // Make sure this feature is activated before running
   if (!settings.clean) return done();
+  console.log("Cleaning: " + paths.output);
 
   // Clean the build folder
   del.sync([
@@ -205,13 +241,22 @@ var cleanDist = function (done) {
 };
 
 // Repeated JavaScript tasks
-var jsTasks = lazypipe()
+var jsTasks = defineJsTasks();
+
+
+function getOutputPath() {
+  return paths.scripts.output;
+}
+
+function defineJsTasks() {
+ return lazypipe()
   .pipe(header, banner.full, {package: package})
   .pipe(dest, paths.scripts.output)
   .pipe(rename, {suffix: '.min'})
   .pipe(uglify)
   .pipe(header, banner.min, {package: package})
   .pipe(dest, paths.scripts.output);
+}
 
 // Lint, cssnano, and concatenate scripts
 var buildCoreScripts = function (done) {
@@ -219,6 +264,9 @@ var buildCoreScripts = function (done) {
   // Make sure this feature is activated before running
   if (!settings.coreScripts) return done();
 
+  // Redefine jsTasks because output directory may have changed.
+  jsTasks = defineJsTasks()
+
   // Run tasks on script files
   return src(paths.scripts.core)
     .pipe(flatmap(function(stream, file) {
@@ -259,6 +307,9 @@ var buildScripts = function (done) {
   // Make sure this feature is activated before running
   if (!settings.scripts) return done();
 
+  // Redefine jsTasks because output directory may have changed.
+  jsTasks = defineJsTasks()
+
   // Run tasks on script files
   return src(paths.scripts.input)
     .pipe(flatmap(function(stream, file) {
@@ -297,12 +348,12 @@ var buildVendorScripts = function(done) {
   if (!settings.scripts) return done();
 
   return src(vendor_scripts)
-    .pipe(concat(paths.scripts.vfilename + '.js'))
-    .pipe(header(banner.full, {package: package}))
-    .pipe(dest(paths.scripts.output))
-    .pipe(rename({suffix: '.min'}))
-    .pipe(uglify())
-    .pipe(dest(paths.scripts.output));
+        .pipe(concat(paths.scripts.vfilename + '.js'))
+        .pipe(header(banner.full, {package: package}))
+        .pipe(dest(paths.scripts.output))
+        .pipe(rename({suffix: '.min'}))
+        .pipe(uglify())
+        .pipe(dest(paths.scripts.output));
 }
 
 // Lint scripts
@@ -349,7 +400,8 @@ var buildSassConfig = function(done) {
   };
 
   return src(paths.styles.input)
-    .pipe(exec(file => `parse-yaml _00_main_configuration.yml`),options)
+    .pipe(exec(file => `parse-yaml ${paths.styles.config}`),options)
+    .pipe(exec(file => `parse-yaml ${paths.styles.tempconfig}`),options)
     .pipe(exec.reporter(reportOptions));
 }
 
@@ -359,14 +411,15 @@ var buildStyles = function (done) {
   // Make sure this feature is activated before running
   if (!settings.styles) return done();
 
-  // Run tasks on all Sass files
+  // Run tasks on all Sass filesbuild
 
   return src(paths.styles.input)
     .pipe(sourcemaps.init())
     .pipe(sass({
       outputStyle: 'compressed',
       includePaths: paths.styles.sassIncludePaths, // Allows @import declarations deeper in the tree to target top-level directories. Useful for loading in components and profiles.
-      srcComments: false
+      srcComments: false,
+      silenceDeprecations: ['legacy-js-api', 'import', 'global-builtin','mixed-decls'], // The IDs of deprecations you want to silence
     }))
     .pipe(header(banner.full, { package : package }))
     .pipe(dest(paths.styles.output))
@@ -404,6 +457,8 @@ var buildImages = function (done) {
   // Make sure this feature is activated before running
   if (!settings.img) return done();
 
+  console.log("images");
+  console.log(paths.img.output);
   // Optimize SVG files
   return src(paths.img.input)
     .pipe(dest(paths.img.output));
@@ -430,7 +485,7 @@ var buildPNGs = function (done) {
   if (!settings.pngs) return done();
 
   // Optimize PNG files
-  return src(paths.pngs.input, {encoding: false})
+  return src(paths.pngs.input)
     .pipe(imagemin())
     .pipe(dest(paths.pngs.output));
 };
@@ -446,6 +501,7 @@ var buildJPGs = function (done) {
     .pipe(dest(paths.jpgs.output));
 };
 
+
 // Copy Font Files
 var buildFonts = function (done) {
 
@@ -525,39 +581,115 @@ var watchMin = function (done) {
   done();
 };
 
+/*
+function getAlternativeConfigFiles() {
+  if (fs.existsSync(alt_config_dir)) {
+    const files = fs.readdirSync(alt_config_dir);
+
+    // Ensure that config files have yml extension.
+    // This prevents processing of stray files, like the Mac file system’s hidden .DS_Store files
+    return filteredFiles = files.filter(filename => {
+      return ymlFilePattern.test(filename)
+    });
+    } else {
+    return [];
+    }
+}*/
 
+var testSourceDirectory = function(done) {
+  if (!fs.existsSync(paths.input)) {
+    console.error("Source directory " + paths.input + " does not exist.");
+  }
 
+  done();
 
+}
 
-/**
- * Export Tasks
- */
+var resetTempConfigFile = function(done) {
+    const tempFilePath = './' + paths.styles.tempconfig;
+    // Reset temp file to blank file
+    const fd = fs.openSync(tempFilePath, 'w');
+    fs.closeSync(fd);
 
-// Default task
-// gulp
-exports.default = series(
-  cleanDist,
-  buildSassConfig,
-  parallel(
+    // This file is created by the parse-yaml script run elsewhere, and needs to be cleaned up after
+    // the build process is complete. Perhaps this should be more configurable.
+    const sc = fs.openSync('./source/sass/00_configuration/_00_temp_configuration.sass','w');
+    fs.closeSync(sc);
+
+    done();
+}
+
+// Build alternative asset directories based on the presence of yml files in the alt-config folder.
+var configAltAssets = function(done) {
+
+  if (alt_config_filename === null) {
+    done();
+    return;
+  }
+
+  if (!ymlFilePattern.test(alt_config_filename)) {
+    console.error('Alternative config file ' + alt_config_filename + ' is missing a yml extension. Is it a YAML file?')
+  }
+
+  const altname = alt_config_filename.match(ymlFilePattern)[1]; // to do – test against non matching strings.
+  const altpath = alt_config_dir + '/' + alt_config_filename;
+  const tempFilePath = './' + paths.styles.tempconfig;
+
+  if (!fs.existsSync(altpath) ) {
+    console.error("Configuration file " + altpath + " does not exist.");
+    done();
+    return;
+  }
+
+  // Match build directory to config filename
+  console.log ("Config alt assets passed checks");
+
+  const new_build_dir = './' + asset_basename + '-' + altname;
+  paths = getPaths(source_dir,new_build_dir);
+
+  // Copy config file to common location for later compilation.
+  fs.copyFileSync(altpath,tempFilePath);
+  done();
+}
+
+function buildAll(done) {
+  series(
+    testSourceDirectory,
+    configAltAssets,
+    cleanDist,
+    buildSassConfig,
+    buildStyles,
     lintScripts,
     buildCoreScripts,
     buildScripts,
     buildVendorScripts,
-    buildStyles,
     buildVendorStyles,
     buildImages,
     buildSVGs,
     buildPNGs,
     buildJPGs,
     buildFonts,
-    copyFiles
-  ),
-  buildModernizr
+    copyFiles,
+    resetTempConfigFile,
+    buildModernizr)(done);
+}
+
+/**
+ * Export Tasks
+ */
+
+// Default task
+// gulp
+exports.default = series(
+  buildAll
 );
 
-exports.build = exports.default;
+exports.build = series(
+  buildAll
+);
 
 exports.sass = series(
+  configAltAssets,
   buildSassConfig,
   buildStyles
 );