@videinfra/static-website-builder 2.0.0-beta.2 → 2.0.0-beta.3

package/lib/init/read-package.js

@@ -1,6 +1,6 @@
-const fsPromise = require('fs').promises;
+import fsPromise from 'fs/promises';
 
-module.exports = function mergePackage (fileName, defaultValue = null) {
+export default function mergePackage (fileName, defaultValue = null) {
     return fsPromise.readFile(fileName, {'encoding': 'utf8'}).then((data) => {
         try {
             return JSON.parse(data);

package/lib/log-error.js

@@ -1,6 +1,6 @@
-const chalk = require('chalk');
+import chalk  from 'chalk';
 
-module.exports = function (error, failOnError = false) {
+export default function (error, failOnError = false) {
     const message = String(error.messageFormatted || error.message);
     const messageTrimmed = message.length > 4096 ? message.slice(0, 512) + '...' : message;
 
@@ -8,7 +8,7 @@ module.exports = function (error, failOnError = false) {
 
     if (failOnError) {
         throw error;
-    } else if (typeof this.emit === 'function') {
+    } else if (this && typeof this.emit === 'function') {
         // Emit the end event, to properly end the task
         this.emit('end');
     }

package/lib/merge.js

@@ -1,5 +1,5 @@
-const isArray = require('lodash/isArray');
-const mergeWith = require('lodash/mergeWith');
+import isArray  from 'lodash/isArray.js';
+import mergeWith  from 'lodash/mergeWith.js';
 
 function customizer (objValue, srcValue, key) {
     if (objValue !== srcValue && isArray(objValue) && isArray(srcValue)) {
@@ -15,7 +15,7 @@ function customizer (objValue, srcValue, key) {
  * @param {object|array} ...sources List of sources which to merge into object
  * @returns {object|array} Merged object
  */
-module.exports = function merge (object, ...sources) {
+export default function merge (object, ...sources) {
     for (let i = 0; i < sources.length; i++) {
         if (sources[i] && typeof sources[i] === 'object') {
             object = mergeWith(object, sources[i], customizer);

package/lib/run-preprocess.js

@@ -1,4 +1,4 @@
-const isPlainObject = require('lodash/isPlainObject');
+import isPlainObject  from 'lodash/isPlainObject.js';
 
 /**
  * Call all preprocess functions, preprocess validates and transforms configuration
@@ -6,7 +6,7 @@ const isPlainObject = require('lodash/isPlainObject');
  * @param {object} taskConfig Task config
  * @returns {object} Preprocessed task config
  */
-module.exports = function runPreprocess (taskConfig) {
+export default function runPreprocess (taskConfig) {
     if (taskConfig.preprocess) {
         for (let taskName in taskConfig.preprocess) {
             // Make sure task is not disabled

package/lib/task-order.js

@@ -1,24 +1,18 @@
-const BEFORE_BUILD = 'beforeBuild';
-const BUILD        = 'build';
-const AFTER_BUILD  = 'afterBuild';
+export const BEFORE_BUILD = 'beforeBuild';
+export const BUILD        = 'build';
+export const AFTER_BUILD  = 'afterBuild';
 
-const BEFORE_WATCH = 'beforeWatch';
-const WATCH        = 'watch';
+export const BEFORE_WATCH = 'beforeWatch';
+export const WATCH        = 'watch';
 
-exports.BEFORE_BUILD = BEFORE_BUILD;
-exports.BUILD = BUILD;
-exports.AFTER_BUILD = AFTER_BUILD;
-exports.BEFORE_WATCH = BEFORE_WATCH;
-exports.WATCH = WATCH;
-
-exports.DEFAULT_TASKS = [
+export const DEFAULT_TASKS = [
     BEFORE_BUILD,
     BUILD,
     BEFORE_WATCH,
     WATCH,
 ];
 
-exports.BUILD_TASKS = [
+export const BUILD_TASKS = [
     BEFORE_BUILD,
     BUILD,
     AFTER_BUILD,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@videinfra/static-website-builder",
-  "version": "2.0.0-beta.2",
+  "version": "2.0.0-beta.3",
   "description": "Customizable static site project builder",
   "license": "MIT",
   "engines": {
@@ -18,11 +18,13 @@
   },
   "main": "gulpfile.js/index.js",
   "author": "Vide Infra",
+  "type": "module",
   "scripts": {
-    "start": "cross-env BUILDER_MODE=development gulp",
+    "start": "cross-env BUILDER_MODE=development gulp watch",
     "build": "cross-env BUILDER_MODE=production gulp build",
-    "test": "gulp build --silent --config=init/test/config/config.js && jest",
-    "test-watch": "gulp --config=init/test/config/config.js"
+    "test": "gulp build --silent --config=init/test/config/config.js && node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "test-watch": "gulp watch --config=init/test/config/config.js",
+    "test-builder": "node bin/builder.js build --config=init/test/config/config.js"
   },
   "dependencies": {
     "@csstools/postcss-nested-calc": "^5.0.0",

package/plugins/example/preprocess-config.js

@@ -5,7 +5,7 @@
  * @param {object} fullConfig Full configuration
  * @returns {object} Transformed example configuration
  */
-module.exports = function preprocessExampleConfig (config = {}, fullConfig) {
+export default function preprocessExampleConfig (config = {}, fullConfig) {
     // Do something with config, eg. add files starting with underscore to the ignore list.
     // Ignore will be a list of globs, relative to the example source path, see task.js
     config.ignore = config.ignore.concat([

package/plugins/example/task.js

@@ -1,21 +1,21 @@
-const gulp = require('gulp');
-const { nanomemoize } = require('nano-memoize');
+import gulp  from 'gulp';
+import { nanomemoize }  from 'nano-memoize';
 
-const globs = require('@videinfra/example-website-builder/lib/globs-helper');
-const getConfig = require('@videinfra/example-website-builder/lib/get-config');
-const getPaths = require('@videinfra/example-website-builder/lib/get-path');
+import globs  from '@videinfra/example-website-builder/lib/globs-helper.js';
+import { getTaskConfig } from '@videinfra/example-website-builder/lib/get-config.js';
+import getPaths  from '@videinfra/example-website-builder/lib/get-path.js';
 
-const taskStart = require('@videinfra/example-website-builder/lib/gulp/task-start');
-const taskEnd = require('@videinfra/example-website-builder/lib/gulp/task-end');
-const taskWatch = require('../../lib/gulp/task-watch');
+import taskStart  from '@videinfra/example-website-builder/lib/gulp/task-start.js';
+import taskEnd  from '@videinfra/example-website-builder/lib/gulp/task-end.js';
+import taskWatch  from '@videinfra/example-website-builder/lib/gulp/task-watch.js';
 
 
 // Paths and files which gulp will watch and run on
 // Using memoize to cache the result, for performance
 const getWatchGlobPaths = function (forChokidar = false) {
     const sourcePaths = getPaths.getSourcePaths('example');
-    const extensions = getConfig.getTaskConfig('example', 'extensions');
-    const ignore = getConfig.getTaskConfig('example', 'ignore');
+    const extensions = getTaskConfig('example', 'extensions');
+    const ignore = getTaskConfig('example', 'ignore');
 
     // Combine source paths and extensions
     return globs.generate(
@@ -23,7 +23,7 @@ const getWatchGlobPaths = function (forChokidar = false) {
         globs.paths(sourcePaths).paths(ignore).ignore(),          // Exclude files and folders from being processed
     );
 };
-const getGlobPaths = nanomemoize(function () {
+const getGlobPaths = nanomemoize.nanomemoize(function () {
     return getWatchGlobPaths(false);
 });
 
@@ -51,5 +51,5 @@ function exampleWatch () {
 // Available tasks are: beforeWatch, watch, beforeBuild, build, afterBuild
 // Execution order for development is: beforeBuild -> build-> beforeWatch -> watch
 // Execution order for production is: beforeBuild -> build-> afterBuild
-exports.build = example;
-exports.watch = exampleWatch;
+export const build = example;
+export const watch = exampleWatch;

package/plugins/example.js

@@ -1,8 +1,10 @@
 /**
  * Configuration for the example plugin
  */
+import * as examplePreprocessConfig from './example/preprocess-config.js';
+import * as exampleTask from './example/task.js';
 
-exports.example = {
+export const example = {
     // Glob list of files, which to ignore
     // see https://gulpjs.com/docs/en/getting-started/explaining-globs/
     ignore: [],
@@ -12,23 +14,23 @@ exports.example = {
 };
 
 // Function which can validate and modify configuration
-exports.preprocess = {
+export const preprocess = {
     example: [
-        require('./example/preprocess-config'),
+        examplePreprocessConfig,
     ]
 };
 
 // Gulp task
-exports.tasks = {
+export const tasks = {
     example: [
-        require('./example/task'),
+        exampleTask,
     ]
 };
 
 /**
  * Paths relative to the global src and dest folders
  */
-exports.paths = {
+export const paths = {
     example: {
         'src': 'example',
         'dest': 'assets/example',

package/plugins/sass-engine/preprocess-config.js

@@ -1,11 +1,10 @@
-const paths = require('./../../lib/get-path');
-const getConfig = require('./../../lib/get-config');
-const getPaths = require('./../../lib/get-path');
-const merge = require('./../../lib/merge');
-const getEnvData = require('./../../tasks/env/get-env');
-const assign = require('lodash/assign');
-const gulpSass = require('../../vendor/gulp-sass/index');
-
+import { getSourcePaths, getProjectPath } from './../../lib/get-path.js';
+import { getTaskConfig } from './../../lib/get-config.js';
+import merge from './../../lib/merge.js';
+import getEnvData from './../../tasks/env/get-env.js';
+import gulpSass from '../../vendor/gulp-sass/index.js';
+import assign from 'lodash/assign.js';
+import * as sass from 'sass';
 
 /**
  * Modify configuration
@@ -14,17 +13,17 @@ const gulpSass = require('../../vendor/gulp-sass/index');
  * @param {object} fullConfig Full configuration
  * @returns {object} Transformed stylesheet configuration
  */
-module.exports = function processSASSConfig (config, fullConfig) {
+export default function processSASSConfig(config, fullConfig) {
     if (config && config.sass) {
         if (config.sass.includePaths) {
             // Map include paths to the project folder
-            config.sass.includePaths = config.sass.includePaths.map((path) => paths.getProjectPath(path));
+            config.sass.includePaths = config.sass.includePaths.map((path) => getProjectPath(path));
         } else {
             config.sass.includePaths = [];
         }
 
         // Add stylesheet source path
-        const stylesheetSourcePath = getPaths.getSourcePaths('stylesheets')
+        const stylesheetSourcePath = getSourcePaths('stylesheets');
 
         stylesheetSourcePath.forEach((path) => {
             if (!config.sass.includePaths.includes(path)) {
@@ -33,26 +32,23 @@ module.exports = function processSASSConfig (config, fullConfig) {
         });
 
         // Engine is a function which returns a gulp pipe function
-        config.engine = function getSASSEngine () {
-            const sass = gulpSass(require('sass'));
-            const sassConfig = getConfig.getTaskConfig('stylesheets', 'sass');
+        config.engine = function getSASSEngine() {
+            const sassEngine = gulpSass(sass);
+            const sassConfig = getTaskConfig('stylesheets', 'sass');
 
             if (config.legacy) {
                 sassConfig.silenceDeprecations = (sassConfig.silenceDeprecations || []).concat(['import', 'global-builtin', 'slash-div', 'color-functions']);
             }
 
             sassConfig.data = merge(getEnvData().sass, sassConfig.data || {});
-            return sass(sassConfig, /* sync */ true).on('error', sass.logError);
+            return sassEngine(sassConfig, /* sync */ true).on('error', sassEngine.logError);
         };
 
         // Main 'dependents' config is shared between all tasks
         if (config.dependents) {
-
             for (let extension in config.dependents) {
                 config.dependents[extension].basePaths = config.dependents[extension].basePaths || [];
-                config.dependents[extension].basePaths = config.dependents[extension].basePaths.concat(
-                    getPaths.getSourcePaths('stylesheets')
-                );
+                config.dependents[extension].basePaths = config.dependents[extension].basePaths.concat(getSourcePaths('stylesheets'));
             }
 
             fullConfig.dependents = assign(fullConfig.dependents || {}, config.dependents);

package/plugins/sass.js

@@ -1,7 +1,9 @@
+import * as preprocessSassConfig from './sass-engine/preprocess-config.js';
+
 /**
  * SASS plugin attaches itself to the stylesheets task
  */
-exports.stylesheets = {
+export const stylesheets = {
     // Add sass to the extensions
     extensions: ['scss', 'sass'],
 
@@ -32,8 +34,8 @@ exports.stylesheets = {
     },
 };
 
-exports.preprocess = {
+export const preprocess = {
     stylesheets: [
-        require('./sass-engine/preprocess-config'),
+        preprocessSassConfig,
     ]
 };

package/plugins/twig/lodash-filters/filters.js

@@ -1,11 +1,11 @@
-module.exports = [];
+const exports = [];
 
 /**
  * Filter with lodash 'omit' functionality
  * !!!CAUTION!!! There is no filter in TWIG with this functionality!
  */
 
-module.exports.push({
+exports.push({
     name: 'omit',
     func: function (data, args) {
         const output = {};
@@ -26,7 +26,7 @@ module.exports.push({
  * !!!CAUTION!!! There is no filter in TWIG with this functionality!
  */
 
-module.exports.push({
+exports.push({
     name: 'pick',
     func: function (data, args) {
         const output = {};
@@ -47,10 +47,10 @@ module.exports.push({
  * !!!CAUTION!!! There is no filter in TWIG with this functionality!
  */
 
-const filter = require('lodash/filter');
-const omit = require('lodash/omit');
+import filter  from 'lodash/filter.js';
+import omit  from 'lodash/omit.js';
 
-module.exports.push({
+exports.push({
     name: 'filter',
     func: function (data, args) {
         const predicate = omit(args[0], ['_keys']);
@@ -63,9 +63,9 @@ module.exports.push({
  * !!!CAUTION!!! There is no reject in TWIG with this functionality!
  */
 
-const reject = require('lodash/reject');
+import reject  from 'lodash/reject.js';
 
-module.exports.push({
+exports.push({
     name: 'reject',
     func: function (data, args) {
         const predicate = omit(args[0], ['_keys']);
@@ -78,12 +78,14 @@ module.exports.push({
  * !!!CAUTION!!! There is no filter in TWIG with this functionality!
  */
 
-const find = require('lodash/find');
+import find  from 'lodash/find.js';
 
-module.exports.push({
+exports.push({
     name: 'find',
     func: function (data, args) {
         const predicate = omit(args[0], ['_keys']);
         return find(data, predicate);
     }
 });
+
+export default exports;

package/plugins/twig/lodash-filters.js

@@ -1,8 +1,8 @@
-exports.preprocess = {
+import filters from './lodash-filters/filters.js';
+
+export const preprocess = {
     html: [
         function lodashFiltersPlugin (config) {
-            const filters = require('./lodash-filters/filters');
-
             // Add filters to TWIG configurtion
             config.twig = config.twig || {};
             config.twig.filters = config.twig.filters || [];

package/plugins/twig/symfony-filters/filters.js

@@ -1,4 +1,7 @@
-module.exports = [];
+import { getTaskConfig }  from '../../../lib/get-config.js';
+import preposition_nbsp  from './preposition_nbsp.js';
+
+const exports = [];
 
 /**
  * CDN filter
@@ -8,15 +11,14 @@ module.exports = [];
  *   {{ '/images/px.gif' | cdn }}
  */
 
-const config = require('../../../lib/get-config');
 const cdnsResourceMap = {};
 let   cdnIndex = -1;
 
-module.exports.push({
+exports.push({
     name: 'cdnify',
     func: function (path) {
         const normalizedPath = (path || path === 0 ? String(path) : '');
-        const cdnsConfig = config.getTaskConfig('html', 'cdns');
+        const cdnsConfig = getTaskConfig('html', 'cdns');
 
         if (cdnsResourceMap[normalizedPath]) return cdnsResourceMap[normalizedPath]; // cache so that same resource always use same cdn
         if (!cdnsConfig || !cdnsConfig.length) return normalizedPath;
@@ -39,10 +41,10 @@ module.exports.push({
 
 const version = Math.random().toString(36).replace(/[^a-z]+/g, '').substr(0, 5);
 
-module.exports.push({
+exports.push({
     name: 'version',
     func: function (path) {
-        if (!config.getTaskConfig('html', 'version')) return path;
+        if (!getTaskConfig('html', 'version')) return path;
 
         const normalizedPath = (path || path === 0 ? String(path) : '');
         const parts    = normalizedPath.match(/^([^?#]*)(\?[^#]*)?(#.*)?$/i);
@@ -64,7 +66,7 @@ module.exports.push({
  *   Output: hello world
  */
 
-module.exports.push({
+exports.push({
     name: 'humanize',
     func: function (text) {
         text = String(text);
@@ -87,12 +89,11 @@ module.exports.push({
  *   Output: hello at world
  */
 
-const preposition_nbsp = require('./preposition_nbsp');
-
-module.exports.push({
+exports.push({
     name: 'preposition_nbsp',
     func: function (text) {
         return preposition_nbsp(text);
     }
 });
 
+export default exports;

package/plugins/twig/symfony-filters/preposition_nbsp.js

@@ -74,4 +74,4 @@ function prepositionNbsp(text) {
     }).join('');
 }
 
-module.exports = prepositionNbsp;
+export default prepositionNbsp;

package/plugins/twig/symfony-filters.js

@@ -1,14 +1,14 @@
-exports.preprocess = {
-    html: [
-        function symfonyFiltersPlugin  (config) {
-            const filters = require('./symfony-filters/filters');
+import filters from './symfony-filters/filters.js';
 
+export const preprocess = {
+    html: [
+        function symfonyFiltersPlugin(config) {
             // Add filters to TWIG configurtion
             config.twig = config.twig || {};
             config.twig.filters = config.twig.filters || [];
             config.twig.filters = config.twig.filters.concat(filters);
 
             return config;
-        }
-    ]
+        },
+    ],
 };

package/plugins/twig/symfony-functions/functions.js

@@ -1,4 +1,4 @@
-const filters = require('../symfony-filters/filters.js');
+import filters  from '../symfony-filters/filters.js';
 
 function applyFilter (filter) {
     const args = [];
@@ -20,7 +20,7 @@ function applyFilter (filter) {
 /**
  * Symphony asset() TWIG function
  */
-module.exports = [
+export default [
     {
         name: 'asset',
         func: function (path) {

package/plugins/twig/symfony-functions.js

@@ -1,14 +1,14 @@
-exports.preprocess = {
-    html: [
-        function symfonyFunctionsPlugin (config) {
-            const functions = require('./symfony-functions/functions');
+import functions from './symfony-functions/functions.js';
 
+export const preprocess = {
+    html: [
+        function symfonyFunctionsPlugin(config) {
             // Add functions to TWIG configurtion
             config.twig = config.twig || {};
             config.twig.functions = config.twig.functions || [];
             config.twig.functions = config.twig.functions.concat(functions);
 
             return config;
-        }
-    ]
+        },
+    ],
 };

package/plugins/twig-engine/preprocess-config.js

@@ -1,8 +1,8 @@
-const twig = require('../../vendor/gulp-twig/index');
-const getConfig = require('./../../lib/get-config');
-const getPaths = require('./../../lib/get-path');
-const flattenDeep = require('lodash/flattenDeep');
-const assign = require('lodash/assign');
+import twig  from '../../vendor/gulp-twig/index.js';
+import { getTaskConfig } from './../../lib/get-config.js';
+import { getSourcePaths }  from './../../lib/get-path.js';
+import flattenDeep  from 'lodash/flattenDeep.js';
+import assign  from 'lodash/assign.js';
 
 
 /**
@@ -12,13 +12,13 @@ const assign = require('lodash/assign');
  * @param {object} fullConfig Full configuration
  * @returns {object} Transformed HTML configuration
  */
-module.exports = function preprocessHTMLConfig (config = {}, fullConfig) {
+export default function preprocessHTMLConfig (config = {}, fullConfig) {
     if (config.twig) {
-        config.twig.base = getPaths.getSourcePaths('html');
+        config.twig.base = getSourcePaths('html');
 
         // Engine is a function which returns a gulp pipe function
         config.engine = function getTwigEngine () {
-            return twig(getConfig.getTaskConfig('html', 'twig'));
+            return twig(getTaskConfig('html', 'twig'));
         };
 
         if (config.twig.functions) {

package/plugins/twig.js

@@ -1,7 +1,12 @@
+import * as preprocessTwigConfig from './twig-engine/preprocess-config.js';
+// import * as symfonyFunctions from './twig/symfony-functions.js';
+// import * as symfonyFilters from './twig/symfony-filters.js';
+// import * as lodashFilters from './twig/lodash-filters.js';
+
 /**
  * TWIG plugin attaches itself to the HTML task
  */
-exports.html = {
+export const html = {
     // Add twig to the extensions
     extensions: ['twig'],
 
@@ -39,13 +44,13 @@ exports.html = {
 
         // Custom functions
         functions: [
-            // require('../../plugins/twig/symfony-functions.js'),
+            // symfonyFunctions,
         ],
 
         // Custom filters
         filters: [
-            // require('../../plugins/twig/lodash-filters.js'),
-            // require('../../plugins/twig/symfony-functions.js'),
+            // lodashFilters,
+            // symfonyFilters,
         ],
 
         // Production only settings, overwrites default settings
@@ -62,8 +67,8 @@ exports.html = {
     version: false,
 };
 
-exports.preprocess = {
+export const preprocess = {
     html: [
-        require('./twig-engine/preprocess-config'),
+        preprocessTwigConfig,
     ]
 };

package/tasks/browser-sync/config.js

@@ -1,7 +1,10 @@
+import * as preprocessBrowserSyncConfig from './preprocess-config.js';
+import * as taskBrowserSync from './task.js';
+
 /**
  * Browsersync DEV server settings
  */
-exports.browserSync = {
+export const browserSync = {
     // Production only settings, overwrites default settings
     production: false,
 
@@ -11,15 +14,15 @@ exports.browserSync = {
     },
 };
 
-exports.preprocess = {
+export const preprocess = {
     browserSync: [
-        require('./preprocess-config'),
+        preprocessBrowserSyncConfig,
     ]
 };
 
-exports.tasks = {
+export const tasks = {
     browserSync: [
-        require('./task'),
+        taskBrowserSync,
     ]
 };
 
@@ -27,7 +30,7 @@ exports.tasks = {
 /**
  * Paths relative to the global src and dest folders
  */
-exports.paths = {
+export const paths = {
     browserSync: {
         // Server root directory, relative to the project
         // If not set then global dest folder