@videinfra/static-website-builder 2.0.2 → 2.0.4

package/package.json

@@ -1,68 +1,68 @@
-{
-  "name": "@videinfra/static-website-builder",
-  "version": "2.0.2",
-  "description": "Customizable static site project builder",
-  "license": "MIT",
-  "engines": {
-    "node": ">=20.0.0"
-  },
-  "bugs": {
-    "url": "https://github.com/videinfra/static-website-builder/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/videinfra/static-website-builder.git"
-  },
-  "bin": {
-    "builder": "bin/builder.js"
-  },
-  "main": "gulpfile.js/index.js",
-  "author": "Vide Infra",
-  "type": "module",
-  "scripts": {
-    "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 && 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",
-    "@rollup/plugin-replace": "^6.0.3",
-    "autoprefixer": "^10.4.23",
-    "browser-sync": "^3.0.4",
-    "chalk": "4.1.2",
-    "chokidar": "^5.0.0",
-    "cross-env": "^10.1.0",
-    "cssnano": "^7.1.2",
-    "del": "^6.0.0",
-    "dotenv": "^17.2.3",
-    "gulp": "^5.0.1",
-    "gulp-cached": "^1.1.1",
-    "gulp-data": "^1.3.1",
-    "gulp-dependents": "^1.2.5",
-    "gulp-htmlmin": "^5.0.1",
-    "gulp-if": "^3.0.0",
-    "gulp-ignore": "^3.0.0",
-    "gulp-plumber": "^1.2.1",
-    "gulp-postcss": "^10.0.0",
-    "gulp-sass": "^5.1.0",
-    "gulp-sitemap": "^8.0.0",
-    "gulp-sizereport": "^1.2.1",
-    "gulp-sourcemaps": "^2.6.5",
-    "gulp-svgmin": "^4.1.0",
-    "gulp-svgstore": "^9.0.0",
-    "lodash.clone": "^4.3.2",
-    "lodash.some": "^4.2.2",
-    "map-stream": "^0.1.0",
-    "minimist": "^1.2.8",
-    "nano-memoize": "3.0.16",
-    "rolldown": "^1.0.0-rc.1",
-    "sass": "^1.97.3",
-    "through": "^2.3.8",
-    "twig": "^1.17.1"
-  },
-  "devDependencies": {
-    "jest": "^30.2.0"
-  }
-}
+{
+  "name": "@videinfra/static-website-builder",
+  "version": "2.0.4",
+  "description": "Customizable static site project builder",
+  "license": "MIT",
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "bugs": {
+    "url": "https://github.com/videinfra/static-website-builder/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/videinfra/static-website-builder.git"
+  },
+  "bin": {
+    "builder": "bin/builder.js"
+  },
+  "main": "gulpfile.js/index.js",
+  "author": "Vide Infra",
+  "type": "module",
+  "scripts": {
+    "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 && node --disable-warning=ExperimentalWarning --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",
+    "@rollup/plugin-replace": "^6.0.3",
+    "autoprefixer": "^10.4.23",
+    "browser-sync": "^3.0.4",
+    "chalk": "4.1.2",
+    "chokidar": "^5.0.0",
+    "cross-env": "^10.1.0",
+    "cssnano": "^7.1.2",
+    "del": "^6.0.0",
+    "dotenv": "^17.2.3",
+    "gulp": "^5.0.1",
+    "gulp-cached": "^1.1.1",
+    "gulp-data": "^1.3.1",
+    "gulp-dependents": "^1.2.5",
+    "gulp-htmlmin": "^5.0.1",
+    "gulp-if": "^3.0.0",
+    "gulp-ignore": "^3.0.0",
+    "gulp-plumber": "^1.2.1",
+    "gulp-postcss": "^10.0.0",
+    "gulp-sass": "^5.1.0",
+    "gulp-sitemap": "^8.0.0",
+    "gulp-sizereport": "^1.2.1",
+    "gulp-sourcemaps": "^2.6.5",
+    "gulp-svgmin": "^4.1.0",
+    "gulp-svgstore": "^9.0.0",
+    "lodash.clone": "^4.3.2",
+    "lodash.some": "^4.2.2",
+    "map-stream": "^0.1.0",
+    "minimist": "^1.2.8",
+    "nano-memoize": "3.0.16",
+    "rolldown": "^1.0.0-rc.1",
+    "sass": "^1.97.3",
+    "through": "^2.3.8",
+    "twig": "^1.17.1"
+  },
+  "devDependencies": {
+    "jest": "^30.2.0"
+  }
+}

package/plugins/example/preprocess-config.js

@@ -1,17 +1,17 @@
-/**
- * Modify configuration
- *
- * @param {object} config Example configuration
- * @param {object} fullConfig Full configuration
- * @returns {object} Transformed example configuration
- */
-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([
-        '_*',
-        '**/_*'
-    ]);
-
-    return config;
-}
+/**
+ * Modify configuration
+ *
+ * @param {object} config Example configuration
+ * @param {object} fullConfig Full configuration
+ * @returns {object} Transformed example configuration
+ */
+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([
+        '_*',
+        '**/_*'
+    ]);
+
+    return config;
+}

package/plugins/example/task.js

@@ -1,55 +1,55 @@
-import gulp  from 'gulp';
-import { nanomemoize }  from 'nano-memoize';
-
-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';
-
-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 = getTaskConfig('example', 'extensions');
-    const ignore = getTaskConfig('example', 'ignore');
-
-    // Combine source paths and extensions
-    return globs.generate(
-        globs.paths(sourcePaths).filesWithExtensions(extensions), // Files to watch
-        globs.paths(sourcePaths).paths(ignore).ignore(),          // Exclude files and folders from being processed
-    );
-};
-const getGlobPaths = nanomemoize.nanomemoize(function () {
-    return getWatchGlobPaths(false);
-});
-
-
-function example () {
-    return gulp.src(getGlobPaths(), { since: gulp.lastRun(example) })
-        // Start of task, handles errors
-        .pipe(taskStart())
-
-        // Do something....
-
-        // Output into destination folder for 'example'
-        .pipe(taskBeforeDest())
-        .pipe(gulp.dest(getPaths.getDestPath('example')))
-
-        // End task, handles reloading on file change
-        .pipe(taskEnd());
-}
-
-function exampleWatch () {
-    return taskWatch(getWatchGlobPaths(true), example);
-}
-
-
-// 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
-export const build = example;
-export const watch = exampleWatch;
+import gulp  from 'gulp';
+import { nanomemoize }  from 'nano-memoize';
+
+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';
+
+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 = getTaskConfig('example', 'extensions');
+    const ignore = getTaskConfig('example', 'ignore');
+
+    // Combine source paths and extensions
+    return globs.generate(
+        globs.paths(sourcePaths).filesWithExtensions(extensions), // Files to watch
+        globs.paths(sourcePaths).paths(ignore).ignore(),          // Exclude files and folders from being processed
+    );
+};
+const getGlobPaths = nanomemoize.nanomemoize(function () {
+    return getWatchGlobPaths(false);
+});
+
+
+function example () {
+    return gulp.src(getGlobPaths(), { since: gulp.lastRun(example) })
+        // Start of task, handles errors
+        .pipe(taskStart())
+
+        // Do something....
+
+        // Output into destination folder for 'example'
+        .pipe(taskBeforeDest())
+        .pipe(gulp.dest(getPaths.getDestPath('example')))
+
+        // End task, handles reloading on file change
+        .pipe(taskEnd());
+}
+
+function exampleWatch () {
+    return taskWatch(getWatchGlobPaths(true), example);
+}
+
+
+// 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
+export const build = example;
+export const watch = exampleWatch;

package/plugins/example.js

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

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

@@ -1,59 +1,59 @@
-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
- *
- * @param {object} config Stylesheet configuration
- * @param {object} fullConfig Full configuration
- * @returns {object} Transformed stylesheet configuration
- */
-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) => getProjectPath(path));
-        } else {
-            config.sass.includePaths = [];
-        }
-
-        // Add stylesheet source path
-        const stylesheetSourcePath = getSourcePaths('stylesheets');
-
-        stylesheetSourcePath.forEach((path) => {
-            if (!config.sass.includePaths.includes(path)) {
-                config.sass.includePaths.push(path);
-            }
-        });
-
-        // Engine is a function which returns a gulp pipe function
-        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 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(getSourcePaths('stylesheets'));
-            }
-
-            fullConfig.dependents = assign(fullConfig.dependents || {}, config.dependents);
-        }
-    }
-
-    return config;
-}
+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
+ *
+ * @param {object} config Stylesheet configuration
+ * @param {object} fullConfig Full configuration
+ * @returns {object} Transformed stylesheet configuration
+ */
+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) => getProjectPath(path));
+        } else {
+            config.sass.includePaths = [];
+        }
+
+        // Add stylesheet source path
+        const stylesheetSourcePath = getSourcePaths('stylesheets');
+
+        stylesheetSourcePath.forEach((path) => {
+            if (!config.sass.includePaths.includes(path)) {
+                config.sass.includePaths.push(path);
+            }
+        });
+
+        // Engine is a function which returns a gulp pipe function
+        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 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(getSourcePaths('stylesheets'));
+            }
+
+            fullConfig.dependents = assign(fullConfig.dependents || {}, config.dependents);
+        }
+    }
+
+    return config;
+}

package/plugins/sass.js

@@ -1,41 +1,41 @@
-import * as preprocessSassConfig from './sass-engine/preprocess-config.js';
-
-/**
- * SASS plugin attaches itself to the stylesheets task
- */
-export const stylesheets = {
-    // Add sass to the extensions
-    extensions: ['scss', 'sass'],
-
-    // Silence deprecations for `sass`
-    legacy: true,
-
-    // SASS options
-    // see https://sass-lang.com/documentation/js-api/interfaces/options/
-    sass: {
-        includePaths: ['./node_modules'],
-        silenceDeprecations: ['legacy-js-api'],
-    },
-
-    // Dependents plugin for faster builds
-    dependents: {
-        '.scss': {
-            parserSteps:
-            [
-                // The language semantics allow import statements with a comma-separated list of file paths.
-                // Therefore, we first extract the whole statement, and then extract each of the paths from that.
-                /(?:^|;|{|}|\*\/)\s*@(import|use|forward)\s+((?:"[^"]+"|'[^']+'|url\((?:"[^"]+"|'[^']+'|[^)]+)\))(?:\s*,\s*(?:"[^"]+"|'[^']+'|url\((?:"[^"]+"|'[^']+'|[^)]+)\)))*)(?=[^;]*;)/gm,
-                /"([^"]+)"|'([^']+)'|url\((?:"([^"]+)"|'([^']+)'|([^)]+))\)/gm
-            ],
-            prefixes: ['', '_'],
-            postfixes: ['.scss', '.sass'],
-            basePaths: []
-        },
-    },
-};
-
-export const preprocess = {
-    stylesheets: [
-        preprocessSassConfig,
-    ]
-};
+import * as preprocessSassConfig from './sass-engine/preprocess-config.js';
+
+/**
+ * SASS plugin attaches itself to the stylesheets task
+ */
+export const stylesheets = {
+    // Add sass to the extensions
+    extensions: ['scss', 'sass'],
+
+    // Silence deprecations for `sass`
+    legacy: true,
+
+    // SASS options
+    // see https://sass-lang.com/documentation/js-api/interfaces/options/
+    sass: {
+        includePaths: ['./node_modules'],
+        silenceDeprecations: ['legacy-js-api'],
+    },
+
+    // Dependents plugin for faster builds
+    dependents: {
+        '.scss': {
+            parserSteps:
+            [
+                // The language semantics allow import statements with a comma-separated list of file paths.
+                // Therefore, we first extract the whole statement, and then extract each of the paths from that.
+                /(?:^|;|{|}|\*\/)\s*@(import|use|forward)\s+((?:"[^"]+"|'[^']+'|url\((?:"[^"]+"|'[^']+'|[^)]+)\))(?:\s*,\s*(?:"[^"]+"|'[^']+'|url\((?:"[^"]+"|'[^']+'|[^)]+)\)))*)(?=[^;]*;)/gm,
+                /"([^"]+)"|'([^']+)'|url\((?:"([^"]+)"|'([^']+)'|([^)]+))\)/gm
+            ],
+            prefixes: ['', '_'],
+            postfixes: ['.scss', '.sass'],
+            basePaths: []
+        },
+    },
+};
+
+export const preprocess = {
+    stylesheets: [
+        preprocessSassConfig,
+    ]
+};