@videinfra/static-website-builder 2.0.2 → 2.0.4

package/bin/builder.js

@@ -1,40 +1,40 @@
-#!/usr/bin/env node
-import path from 'path';
-import { fileURLToPath } from 'node:url';
-import minimist from 'minimist';
-import { fork } from 'child_process';
-import { createRequire } from 'node:module';
-
-const require = createRequire(import.meta.url);
-const allArgs = minimist(process.argv.slice(2));
-const additionalArgs = allArgs._;
-
-if (additionalArgs[0] === 'init') {
-    import('../init/index').then(({ default: init }) => {
-        init(additionalArgs[1]);
-    });
-} else {
-    const __dirname = path.dirname(fileURLToPath(import.meta.url));
-
-    const builderEntryDir = path.resolve(__dirname, '../gulpfile.js');
-    const gulpModulePath = path.dirname(require.resolve('gulp'));
-    const gulpBinaryFile = path.join(gulpModulePath, '/bin/gulp');
-
-    let args = ['--gulpfile', builderEntryDir];
-
-    if (additionalArgs.length) {
-        args = args.concat(additionalArgs);
-    }
-
-    if (allArgs.config) {
-        args = args.concat('--config', allArgs.config);
-    }
-    if (allArgs.tasks) {
-        args = args.concat('--tasks', '');
-    }
-
-    fork(gulpBinaryFile, args).on('exit', function (code) {
-        // Exit with error if child process exited with an error
-        process.exit(code);
-    });
-}
+#!/usr/bin/env node
+import path from 'path';
+import { fileURLToPath } from 'node:url';
+import minimist from 'minimist';
+import { fork } from 'child_process';
+import { createRequire } from 'node:module';
+
+const require = createRequire(import.meta.url);
+const allArgs = minimist(process.argv.slice(2));
+const additionalArgs = allArgs._;
+
+if (additionalArgs[0] === 'init') {
+    import('../init/index').then(({ default: init }) => {
+        init(additionalArgs[1]);
+    });
+} else {
+    const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+    const builderEntryDir = path.resolve(__dirname, '../gulpfile.js');
+    const gulpModulePath = path.dirname(require.resolve('gulp'));
+    const gulpBinaryFile = path.join(gulpModulePath, '/bin/gulp');
+
+    let args = ['--gulpfile', builderEntryDir];
+
+    if (additionalArgs.length) {
+        args = args.concat(additionalArgs);
+    }
+
+    if (allArgs.config) {
+        args = args.concat('--config', allArgs.config);
+    }
+    if (allArgs.tasks) {
+        args = args.concat('--tasks', '');
+    }
+
+    fork(gulpBinaryFile, args).on('exit', function (code) {
+        // Exit with error if child process exited with an error
+        process.exit(code);
+    });
+}

package/eslint.config.js

@@ -1,39 +1,39 @@
-import { defineConfig } from "eslint/config";
-
-export default defineConfig([
-	{
-        env: {
-            "browser": true,
-            "commonjs": true,
-            "es6": true,
-            "jquery": true
-        },
-        extends: "eslint:recommended",
-        parserOptions: {
-            "sourceType": "module"
-        },
-        rules: {
-            "linebreak-style": [
-                "error",
-                "unix"
-            ],
-            "quotes": [
-                "error",
-                "single"
-            ],
-            "semi": [
-                "error",
-                "always"
-            ],
-            "no-console": [
-                "warn", { "allow": ["warn", "error"] }
-            ],
-            "no-debugger": [
-                "warn"
-            ],
-            "no-unused-vars": [
-                "warn"
-            ]
-        }
-	},
-]);
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+	{
+        env: {
+            "browser": true,
+            "commonjs": true,
+            "es6": true,
+            "jquery": true
+        },
+        extends: "eslint:recommended",
+        parserOptions: {
+            "sourceType": "module"
+        },
+        rules: {
+            "linebreak-style": [
+                "error",
+                "unix"
+            ],
+            "quotes": [
+                "error",
+                "single"
+            ],
+            "semi": [
+                "error",
+                "always"
+            ],
+            "no-console": [
+                "warn", { "allow": ["warn", "error"] }
+            ],
+            "no-debugger": [
+                "warn"
+            ],
+            "no-unused-vars": [
+                "warn"
+            ]
+        }
+	},
+]);

package/gulpfile.js

@@ -1,63 +1,63 @@
-import { getConfigAsync } from './lib/get-config.js';
-import generateGulpTasks from './lib/generate-gulp-tasks.js';
-
-// Set mode globally it can be used by tasks
-let hasProductionArg = false;
-
-for (let i = 0; i < process.argv.length; i++) {
-    const argValue = process.argv[i];
-    // If build task is 'build' or '...-build' then set production mode
-    if (argValue === 'build' || argValue.match(/^[a-z0-9-]+-build$/)) {
-        hasProductionArg = true;
-    }
-}
-
-global.production = global.production || hasProductionArg || process.env.NODE_ENV === 'production';
-global.development = !global.production;
-
-// Config file
-let builderConfigFile = process.env.BUILDER_CONFIG_FILE || 'config/config.js';
-
-if (process.argv.indexOf('--config') !== -1) {
-    builderConfigFile = process.argv[process.argv.indexOf('--config') + 1];
-} else {
-    for (let i = 0; i < process.argv.length; i++) {
-        if (process.argv[i].indexOf('--config=') !== -1) {
-            builderConfigFile = process.argv[i].substr(9);
-        }
-    }
-}
-
-// Load all config files and generate gulp tasks
-const gulpTasks = generateGulpTasks(await getConfigAsync(builderConfigFile));
-
-// Expose main tasks
-export const build = gulpTasks.build;
-export const watch = gulpTasks.watch;
-
-// Expose separate tasks
-export const clean = gulpTasks['clean-beforeBuild'];
-
-export const fonts = gulpTasks['fonts-build'];
-export const fontsWatch = gulpTasks['fonts-watch'];
-
-export const html = gulpTasks['html-build'];
-export const htmlWatch = gulpTasks['html-watch'];
-
-export const icons = gulpTasks['icons-build'];
-export const iconsWatch = gulpTasks['icons-watch'];
-
-export const images = gulpTasks['images-build'];
-export const imagesWatch = gulpTasks['images-watch'];
-
-export const sitemap = gulpTasks['sitemap-afterBuild'];
-export const sitemapWatch = gulpTasks['sitemap-watch'];
-
-export const staticFiles = gulpTasks['staticFiles-build'];
-export const staticFilesWatch = gulpTasks['staticFiles-watch'];
-
-export const stylesheets = gulpTasks['stylesheets-build'];
-export const stylesheetsWatch = gulpTasks['stylesheets-watch'];
-
-export const javascripts = gulpTasks['javascripts-build'];
-export const javascriptsWatch = gulpTasks['javascripts-watch'];
+import { getConfigAsync } from './lib/get-config.js';
+import generateGulpTasks from './lib/generate-gulp-tasks.js';
+
+// Set mode globally it can be used by tasks
+let hasProductionArg = false;
+
+for (let i = 0; i < process.argv.length; i++) {
+    const argValue = process.argv[i];
+    // If build task is 'build' or '...-build' then set production mode
+    if (argValue === 'build' || argValue.match(/^[a-z0-9-]+-build$/)) {
+        hasProductionArg = true;
+    }
+}
+
+global.production = global.production || hasProductionArg || process.env.NODE_ENV === 'production';
+global.development = !global.production;
+
+// Config file
+let builderConfigFile = process.env.BUILDER_CONFIG_FILE || 'config/config.js';
+
+if (process.argv.indexOf('--config') !== -1) {
+    builderConfigFile = process.argv[process.argv.indexOf('--config') + 1];
+} else {
+    for (let i = 0; i < process.argv.length; i++) {
+        if (process.argv[i].indexOf('--config=') !== -1) {
+            builderConfigFile = process.argv[i].substr(9);
+        }
+    }
+}
+
+// Load all config files and generate gulp tasks
+const gulpTasks = generateGulpTasks(await getConfigAsync(builderConfigFile));
+
+// Expose main tasks
+export const build = gulpTasks.build;
+export const watch = gulpTasks.watch;
+
+// Expose separate tasks
+export const clean = gulpTasks['clean-beforeBuild'];
+
+export const fonts = gulpTasks['fonts-build'];
+export const fontsWatch = gulpTasks['fonts-watch'];
+
+export const html = gulpTasks['html-build'];
+export const htmlWatch = gulpTasks['html-watch'];
+
+export const icons = gulpTasks['icons-build'];
+export const iconsWatch = gulpTasks['icons-watch'];
+
+export const images = gulpTasks['images-build'];
+export const imagesWatch = gulpTasks['images-watch'];
+
+export const sitemap = gulpTasks['sitemap-afterBuild'];
+export const sitemapWatch = gulpTasks['sitemap-watch'];
+
+export const staticFiles = gulpTasks['staticFiles-build'];
+export const staticFilesWatch = gulpTasks['staticFiles-watch'];
+
+export const stylesheets = gulpTasks['stylesheets-build'];
+export const stylesheetsWatch = gulpTasks['stylesheets-watch'];
+
+export const javascripts = gulpTasks['javascripts-build'];
+export const javascriptsWatch = gulpTasks['javascripts-watch'];

package/init/default/config/config.js

@@ -1,44 +1,44 @@
-/*
- * Task configuration
- * All options will be merged with defaults, but not replaces whole configuration object
- *
- * Default configuration can be seen here https://github.com/videinfra/static-website-builder/tree/master/tasks
- * in each tasks config.js file
- */
-
-import * as sassPlugin from '@videinfra/static-website-builder/plugins/sass';
-import * as twigPlugin from '@videinfra/static-website-builder/plugins/twig';
-
-export const clean = {};
-export const staticFiles = {};
-export const html = {};
-export const data = {};
-export const fonts = {};
-export const icons = {};
-export const images = {};
-export const javascripts = {};
-export const stylesheets = {};
-export const browserSync = {};
-export const sizereport = {};
-
-export const plugins = [
-    // Enables SASS engine and .sass and .scss file compilation
-    sassPlugin,
-
-    // Enables TwigJS engine .twig file compilation
-    twigPlugin,
-];
-
-
-/*
- * Path configuration
- * All options will be merged with defaults, but not replaces whole configuration object
- *
- * Default configuration can be seen here https://github.com/videinfra/static-website-builder/tree/master/tasks
- * in each tasks config.js file
- */
-
-export const paths = {
-    src: './src',
-    dest: './public',
-};
+/*
+ * Task configuration
+ * All options will be merged with defaults, but not replaces whole configuration object
+ *
+ * Default configuration can be seen here https://github.com/videinfra/static-website-builder/tree/master/tasks
+ * in each tasks config.js file
+ */
+
+import * as sassPlugin from '@videinfra/static-website-builder/plugins/sass';
+import * as twigPlugin from '@videinfra/static-website-builder/plugins/twig';
+
+export const clean = {};
+export const staticFiles = {};
+export const html = {};
+export const data = {};
+export const fonts = {};
+export const icons = {};
+export const images = {};
+export const javascripts = {};
+export const stylesheets = {};
+export const browserSync = {};
+export const sizereport = {};
+
+export const plugins = [
+    // Enables SASS engine and .sass and .scss file compilation
+    sassPlugin,
+
+    // Enables TwigJS engine .twig file compilation
+    twigPlugin,
+];
+
+
+/*
+ * Path configuration
+ * All options will be merged with defaults, but not replaces whole configuration object
+ *
+ * Default configuration can be seen here https://github.com/videinfra/static-website-builder/tree/master/tasks
+ * in each tasks config.js file
+ */
+
+export const paths = {
+    src: './src',
+    dest: './public',
+};

package/init/default/src/html/data/global.js

@@ -1,9 +1,9 @@
-/**
- * Content exported from this file is avaiable in the templates as variables
- *
- * @example
- *     <div>{{ name }}</div>
- */
-export default {
-    'name': 'World',
-};
+/**
+ * Content exported from this file is avaiable in the templates as variables
+ *
+ * @example
+ *     <div>{{ name }}</div>
+ */
+export default {
+    'name': 'World',
+};

package/init/default/src/javascripts/_entries.js

@@ -1,14 +1,14 @@
-/*
-* All files listed in here are created / compiled and additionally
-* shared.js is automatically created, which contains all common JS (chunks / modules imported from more than 1 entry files).
-*/
-export default {
-    'main': [
-        './common',
-        './main'
-    ],
-    'dark': [
-        './common',
-        './dark'
-    ]
-};
+/*
+* All files listed in here are created / compiled and additionally
+* shared.js is automatically created, which contains all common JS (chunks / modules imported from more than 1 entry files).
+*/
+export default {
+    'main': [
+        './common',
+        './main'
+    ],
+    'dark': [
+        './common',
+        './dark'
+    ]
+};

package/init/index.js

@@ -1,63 +1,63 @@
-import { getBuilderPath, getProjectPath } from '../lib/get-path.js';
-import copyFolder from '../lib/init/copy-folder.js';
-import readPackage from '../lib/init/read-package.js';
-import mergePackage from '../lib/init/merge-package.js';
-import folderExists from '../lib/init/folder-exists.js';
-import getFolderList from '../lib/init/get-folder-list.js';
-
-import chalk from 'chalk';
-import { exec } from 'child_process';
-
-export default function init(template = 'default') {
-    let templateName = template || 'default';
-    let copyFrom = getBuilderPath('init', templateName);
-    const copyTo = getProjectPath();
-
-    if (template === 'test' || !folderExists(copyFrom)) {
-        console.log(chalk.red(`Template "${templateName}" doesn't exist`));
-
-        getFolderList(getBuilderPath('init')).then((templates) => {
-            console.log('Available templates:');
-            console.log(chalk.cyan(`    ${templates.join('\n    ')}`));
-        });
-        return;
-    }
-
-    console.log(chalk.magenta(`Generating project files using template "${templateName}"`));
-
-    // Copy files
-    const filesCopied = copyFolder(copyFrom, copyTo);
-
-    // Merge template package.json into projects package.json
-    const packageMerged = readPackage(getBuilderPath('init', templateName, 'package.json'), {}).then((packageJSON) => {
-        return mergePackage(getProjectPath('package.json'), packageJSON)
-            .then(() => {
-                if (packageJSON.dependencies || packageJSON.devDependencies) {
-                    console.log(chalk.magenta('Installing npm dependencies'));
-
-                    return new Promise((resolve, _reject) => {
-                        exec('npm install', function (_error, _stdout, _stderr) {
-                            resolve();
-                        });
-                    });
-                }
-            })
-            .catch((_err) => {
-                // Skip errors
-                return Promise.resolve();
-            });
-    });
-
-    Promise.all([filesCopied, packageMerged]).then(
-        () => {
-            console.log(chalk.green('All done\n'));
-
-            console.log('To start the dev server:\n' + chalk.cyan('    npm run start'));
-
-            console.log('To build the project:\n' + chalk.cyan('    npm run build'));
-        },
-        (err) => {
-            throw err;
-        },
-    );
-}
+import { getBuilderPath, getProjectPath } from '../lib/get-path.js';
+import copyFolder from '../lib/init/copy-folder.js';
+import readPackage from '../lib/init/read-package.js';
+import mergePackage from '../lib/init/merge-package.js';
+import folderExists from '../lib/init/folder-exists.js';
+import getFolderList from '../lib/init/get-folder-list.js';
+
+import chalk from 'chalk';
+import { exec } from 'child_process';
+
+export default function init(template = 'default') {
+    let templateName = template || 'default';
+    let copyFrom = getBuilderPath('init', templateName);
+    const copyTo = getProjectPath();
+
+    if (template === 'test' || !folderExists(copyFrom)) {
+        console.log(chalk.red(`Template "${templateName}" doesn't exist`));
+
+        getFolderList(getBuilderPath('init')).then((templates) => {
+            console.log('Available templates:');
+            console.log(chalk.cyan(`    ${templates.join('\n    ')}`));
+        });
+        return;
+    }
+
+    console.log(chalk.magenta(`Generating project files using template "${templateName}"`));
+
+    // Copy files
+    const filesCopied = copyFolder(copyFrom, copyTo);
+
+    // Merge template package.json into projects package.json
+    const packageMerged = readPackage(getBuilderPath('init', templateName, 'package.json'), {}).then((packageJSON) => {
+        return mergePackage(getProjectPath('package.json'), packageJSON)
+            .then(() => {
+                if (packageJSON.dependencies || packageJSON.devDependencies) {
+                    console.log(chalk.magenta('Installing npm dependencies'));
+
+                    return new Promise((resolve, _reject) => {
+                        exec('npm install', function (_error, _stdout, _stderr) {
+                            resolve();
+                        });
+                    });
+                }
+            })
+            .catch((_err) => {
+                // Skip errors
+                return Promise.resolve();
+            });
+    });
+
+    Promise.all([filesCopied, packageMerged]).then(
+        () => {
+            console.log(chalk.green('All done\n'));
+
+            console.log('To start the dev server:\n' + chalk.cyan('    npm run start'));
+
+            console.log('To build the project:\n' + chalk.cyan('    npm run build'));
+        },
+        (err) => {
+            throw err;
+        },
+    );
+}

package/init/test/.env

@@ -1,6 +1,6 @@
-HOST=https://test-global.tld
-FOO=foo-global
-TYPE_BOOL_TRUE=true
-TYPE_BOOL_FALSE=false
-TYPE_NUMBER=123.456
-TYPE_EMPTY=
+HOST=https://test-global.tld
+FOO=foo-global
+TYPE_BOOL_TRUE=true
+TYPE_BOOL_FALSE=false
+TYPE_NUMBER=123.456
+TYPE_EMPTY=

package/init/test/.env.local

@@ -1,2 +1,3 @@
-HOST=https://test-local.tld
-BAR=bar-local
+HOST=https://test-local.tld
+BAR=bar-local
+ASSETS_VERSION=12345678