stop14-themesystem-legacy 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Bill Kennedy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -0,0 +1,63 @@
+{
+ "name": "stop14-themesystem-legacy",
+ "version": "1.0.0",
+ "description": "A scaffolding and build system for theme development across platforms. Legacy version",
+ "author": {
+  "name": "Bill Kennedy",
+  "url": "https://stop14.ca"
+ },
+ "license": "MIT",
+ "repository": {
+  "type": "git",
+  "url": "https://github.com/stop14/stop14-themesystem-legacy"
+ },
+ "keywords": [
+  "drupal",
+  "omeka",
+  "stop14",  
+  "theme"
+ ],
+ "devDependencies": {
+  "acorn": "^7.4.1",
+  "autoprefixer": "^9.7.1",
+  "babel-preset-minify": "^0.5.1",
+  "browser-sync": "^2.27.4",
+  "cssnano": "^4.1.11",
+  "del": "^3.0.0",
+  "gulp": "^4.0.2",
+  "gulp-concat": "^2.6.1",
+  "gulp-eslint": "^6.0.0",
+  "gulp-flatmap": "^1.0.2",
+  "gulp-header": "^2.0.5",
+  "gulp-imagemin": "^6.2.0",
+  "gulp-jshint": "^2.1.0",
+  "gulp-modernizr": "^3.4.0",
+  "gulp-optimize-js": "^1.1.0",
+  "gulp-postcss": "^8.0.0",
+  "gulp-rename": "^1.4.0",
+  "gulp-sourcemaps": "^2.6.5",
+  "gulp-svgmin": "^2.1.0",
+  "gulp-terser": "^1.4.1",
+  "gulp-uglify": "^3.0.2",
+  "jshint": "^2.13.0",
+  "jshint-stylish": "^2.2.1",
+  "lazypipe": "^1.0.1",
+  "pump": "^3.0.0"
+ },
+ "dependencies": {
+  "dart-sass": "^1.25.0",
+  "ev-emitter": "^1.1.1",
+  "gulp-dart-sass": "^1.0.2",
+  "imagesloaded": "^4.1.4",
+  "in-view": "^0.6.1",
+  "jquery": "^3.6.0",
+  "jquery-colorbox": "^1.6.4",
+  "jquery-reflow-table": "^1.0.3",
+  "object-path": "^0.11.5",
+  "slick-carousel": "^1.8.1"
+ },
+ "browserslist": [
+  "> 5%",
+  "> 2% in US"
+ ]
+}

package/scaffolding/default/README.md

@@ -0,0 +1,19 @@
+# Stop14 Theme System Legacy
+
+#NOTE
+This theme includes build files (final CSS, Javascript, and Image files) for portability. Any changes to the theme should be done through the source files, which requires node.js, npm, and Gulp be installed.
+  
+
+#REQUIREMENTS FOR THEME DEVELOPERS
+* node.js 10+
+* npm 6+
+* gulp 4 (installed globally, though package is included)
+
+#INSTALLATION FOR THEME DEVELOPERS
+* Run npm install to load vendor packages
+
+#USAGE FOR THEME DEVELOPERS
+* gulp build:  Builds entire asset folder (sass, scripts, etc.)
+* gulp watch:  Watches for changes in source directory and builds automatically
+* gulp js: Builds scripts only
+* gulp sass: Builds SASS files only

package/scaffolding/default/gulpfile.js

@@ -0,0 +1,526 @@
+/**
+ * Settings
+ * Turn on/off build features
+ */
+
+var settings = {
+  clean: true,
+  scripts: true,
+  modernizr: true,
+  styles: true,
+  img: false, // use if images are not separated into subdirectories by file type. otherwise use below.
+  svgs: true,
+  pngs: true,
+  jpgs: true,
+  fonts: true,
+  copy: true,
+  reload: false
+};
+
+
+/**
+ * Paths to project folders
+ */
+
+var source_dir = './source';
+var build_dir = './assets';
+
+var paths = {
+  input: source_dir,
+  output: build_dir,
+  scripts: {
+    input: source_dir + '/js',
+    output: build_dir + '/js/',
+    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: [source_dir + '/sass/a_components',source_dir + '/sass/b_profiles',source_dir + '/sass/c_local',source_dir + '/sass/a_components/00_general',source_dir + '/sass/a_components/10_colours_and_patterns', source_dir + '/sass/a_components/20_layout',source_dir + '/sass/a_components/30_typography',source_dir + '/sass/a_components/40_ui',source_dir + '/sass/a_components/50_animation',source_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: './'
+};
+
+
+/**
+ * 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'];
+
+
+/**
+ * Template for banner to add to file headers
+ */
+
+var banner = {
+  full:
+    '/*!\n' +
+    ' * <%= package.name %> v<%= package.version %>\n' +
+    ' * <%= package.description %>\n' +
+    ' * (c) ' + new Date().getFullYear() + ' <%= package.author.name %>\n' +
+    ' * <%= package.license %> License\n' +
+    ' * <%= package.repository.url %>\n' +
+    ' */\n\n',
+  min:
+    '/*!' +
+    ' <%= package.name %> v<%= package.version %>' +
+    ' | (c) ' + new Date().getFullYear() + ' <%= package.author.name %>' +
+    ' | <%= package.license %> License' +
+    ' | <%= package.repository.url %>' +
+    ' */\n'
+};
+
+
+/**
+ * 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');
+
+// 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
+ */
+
+var cssPlugins = [
+  autoprefixer({cascade: true, remove: true}),
+  cssnano({discardComments: { removeAll: true}})
+];
+
+
+
+/**
+ * Gulp Tasks
+ */
+
+// Remove pre-existing content from output folders
+var cleanDist = function (done) {
+
+  // Make sure this feature is activated before running
+  if (!settings.clean) return done();
+
+  // Clean the build folder
+  del.sync([
+    paths.output
+  ]);
+
+  // Signal completion
+  return done();
+};
+
+// Repeated JavaScript tasks
+var jsTasks = 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 buildScripts = function (done) {
+
+  // Make sure this feature is activated before running
+  if (!settings.scripts) return done();
+
+  // Run tasks on script files
+  return src(paths.scripts.input)
+    .pipe(flatmap(function(stream, file) {
+
+      // If the file is a directory
+      if (file.isDirectory()) {
+
+        // Setup a suffix variable
+        var suffix = '';
+
+        // Setup a filename.
+
+        var filename = paths.scripts.cfilename === false ? file.relative : paths.scripts.cfilename;
+
+
+        // Grab all files and concatenate them
+
+        src(file.path + '/*.js')
+          .pipe(sourcemaps.init()) // TO DO: Sourcemaps not working as expected.
+          .pipe(concat(filename + suffix + '.js'))
+          .pipe(jsTasks())
+          .pipe(sourcemaps.write('./'));
+
+        return stream;
+
+      }
+
+      // Otherwise, process the file
+      return stream.pipe(jsTasks());
+
+    }));
+
+};
+
+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));
+}
+
+// Lint scripts
+var lintScripts = function (done) {
+
+  // Make sure this feature is activated before running
+  if (!settings.scripts) return done();
+
+  // Lint scripts
+  return src(paths.scripts.input)
+    .pipe(eslint({
+      "configFile": './.eslintrc',
+      "env": {
+        "node": false,
+        "es6": true,
+        "browser": true
+      }
+    }))
+    .pipe(eslint.format());
+};
+
+var buildModernizr = function(done) {
+
+  if (!settings.modernizr) return done();
+
+  return src(paths.scripts.input + '/*.js')
+    .pipe(modernizr(require('./modernizr-config.json')))
+    .pipe(dest(paths.scripts.output))
+    .pipe(rename({suffix: '.min'}))
+    .pipe(uglify())
+    .pipe(dest(paths.scripts.output));
+}
+
+// Process, lint, and cssnano Sass files
+var buildStyles = function (done) {
+
+  // Make sure this feature is activated before running
+  if (!settings.styles) return done();
+
+  // Run tasks on all Sass files
+  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
+    }))
+    .pipe(header(banner.full, { package : package }))
+    .pipe(dest(paths.styles.output))
+    .pipe(rename({suffix: '.min'}))
+    .pipe(postcss(cssPlugins))
+    .pipe(header(banner.min, { package : package }))
+    .pipe(sourcemaps.write('./'))
+    .pipe(dest(paths.styles.output));
+
+};
+
+
+var buildVendorStyles = function(done) {
+
+  if (!settings.scripts) return done();
+  return src(vendor_styles)
+    .pipe(flatmap(function(stream, file) {
+
+
+        // Setup a filename.
+
+        var filename = paths.styles.vfilename === false ? file.relative : paths.styles.vfilename;
+
+        // Grab all files and concatenate them
+
+        src(file.path)
+          .pipe(sourcemaps.init())
+          .pipe(header(banner.full, { package : package }))
+          .pipe(rename({basename: filename}))
+          .pipe(dest(paths.styles.output))
+          .pipe(rename({basename: filename, suffix: '.min'}))
+          .pipe(postcss(cssPlugins))
+          .pipe(header(banner.min, { package : package }))
+          .pipe(sourcemaps.write('./'))
+          .pipe(dest(paths.styles.output));
+        return stream;
+    }));
+}
+
+
+
+
+// Copy Image files
+var buildImages = function (done) {
+
+  // Make sure this feature is activated before running
+  if (!settings.img) return done();
+
+  // Optimize SVG files
+  return src(paths.img.input)
+    .pipe(dest(paths.img.output));
+};
+
+
+// Optimize SVG files
+var buildSVGs = function (done) {
+
+  // Make sure this feature is activated before running
+  if (!settings.svgs) return done();
+
+  // Optimize SVG files
+  return src(paths.svgs.input)
+    .pipe(svgmin())
+    .pipe(dest(paths.svgs.output));
+
+};
+
+// Copy PNG files
+var buildPNGs = function (done) {
+
+  // Make sure this feature is activated before running
+  if (!settings.pngs) return done();
+
+  // Optimize SVG files
+  return src(paths.pngs.input)
+    .pipe(imagemin())
+    .pipe(dest(paths.pngs.output));
+};
+
+// Copy JPG files
+var buildJPGs = function (done) {
+
+  // Make sure this feature is activated before running
+  if (!settings.jpgs) return done();
+
+  // Optimize SVG files
+  return src(paths.jpgs.input)
+    .pipe(dest(paths.jpgs.output));
+};
+
+// Copy Font Files
+var buildFonts = function (done) {
+
+  // Make sure this feature is activated before running
+  if (!settings.fonts) return done();
+
+  // Optimize SVG files
+  return src(paths.fonts.input)
+    .pipe(dest(paths.fonts.output));
+};
+
+
+
+// Copy theme-specific static files into output folder
+var copyFiles = function (done) {
+
+  // Make sure this feature is activated before running
+  if (!settings.copy) return done();
+
+  // Copy static files
+  return src(paths.copy.input)
+    .pipe(dest(paths.copy.output));
+
+};
+
+// Watch for changes to the source directory
+var startServer = function (done) {
+
+  // Make sure this feature is activated before running
+  if (!settings.reload) return done();
+
+  // Initialize BrowserSync
+  browserSync.init({
+    server: {
+      baseDir: paths.reload
+    }
+  });
+
+  // Signal completion
+  done();
+
+};
+
+// Reload the browser when files change
+var reloadBrowser = function (done) {
+  if (!settings.reload) return done();
+  browserSync.reload();
+  done();
+};
+
+// Watch for changes
+var watchSrc = function (done) {
+  watch(paths.input, series(exports.default, reloadBrowser));
+  done();
+};
+
+// Watch for changes
+var watchJs = function (done) {
+  watch(paths.input, series(exports.js, reloadBrowser));
+  done();
+};
+
+// Watch for changes
+var watchSass = function (done) {
+  watch(paths.input, series(exports.sass, reloadBrowser));
+  done();
+};
+
+
+// Watch for changes
+var watchMin = function (done) {
+  watch(paths.input, series(exports.sass, exports.js, reloadBrowser));
+  done();
+};
+
+
+
+
+
+/**
+ * Export Tasks
+ */
+
+// Default task
+// gulp
+exports.default = series(
+  cleanDist,
+  parallel(
+    lintScripts,
+    buildScripts,
+    buildVendorScripts,
+    buildStyles,
+    buildVendorStyles,
+    buildImages,
+    buildSVGs,
+    buildPNGs,
+    buildJPGs,
+    buildFonts,
+    copyFiles
+  ),
+  buildModernizr
+);
+
+exports.build = exports.default;
+
+exports.sass = series(
+  buildStyles
+);
+
+exports.js = series(
+  lintScripts,
+  buildScripts,
+  buildVendorScripts,
+  buildModernizr
+);
+
+exports.images = series(
+  buildImages,
+  buildSVGs,
+  buildPNGs,
+  buildJPGs
+);
+
+exports.fonts = series(
+  buildFonts
+);
+
+// Watch and reload
+// gulp watch
+exports.watch = series(
+  exports.default,
+  startServer,
+  watchSrc
+);
+
+// Build styles and scripts without time consuming image processing
+// gulp watchmin
+exports.watchmin = series(
+  exports.sass,
+  exports.js,
+  startServer,
+  watchMin
+);
+
+// Watch and reload scripts only
+// gulp jswatch
+exports.jswatch = series(
+  exports.js,
+  startServer,
+  watchJs
+);
+
+// Watch and reload styles only
+// gulp sasswatch
+exports.sasswatch = series(
+  exports.sass,
+  startServer,
+  watchSass
+);
+
+exports.clean = series(
+  cleanDist
+);