@videinfra/static-website-builder 2.0.4 → 2.0.6

package/README.md

@@ -1,102 +1,102 @@
-[npm-url]: https://npmjs.org/package/@videinfra/static-website-builder
-[npm-image]: http://img.shields.io/npm/v/@videinfra/static-website-builder.svg
-[travis-url]: https://travis-ci.org/videinfra/static-website-builder
-[travis-image]: https://travis-ci.org/videinfra/static-website-builder.svg?branch=master
-
-[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url]
-
-`static-website-builder` is a customizable static site project builder powered by Gulp, Rolldown, SASS, PostCSS, TwigJS, BrowserSync
-
-## Requirements
-
-- Node.js >= 20.0.0
-
-## Features
-
-- Gulp: built using gulp
-- Built-in Server: Local development server with hot reloading
-- Templates: HTML templates with minification
-- TWIG: Optional TwigJS template engine with optional plugins for additional functions and filters
-- Stylesheets: Autoprefixing and minification with PostCSS support 
-- SASS: Optional SASS / SCSS compilation
-- Javascript/Typescript: Transpilation, bundling and minification with rolldown
-- SVG icons: Sprite generation from individual SVG files
-
-
-* Paths: Source and destinations paths are configurable
-* Features: All features can be configured or disabled
-* Plugins: create additional plugins / gulp tasks
-
-## Quick start
-
-```
-npm init
-npm install @videinfra/static-website-builder --save
-npx builder init
-```
-
-Start development server
-```
-npm run start
-```
-
-Build production files
-```
-npm run start
-```
-
-Note: these commands are added to the project during `npm init`.
-
-## Commands
-
-### Development server
-
-```npx run builder watch```
-
-### Generate production ready files
-
-```npx run builder build```
-
-### List all available tasks
-
-```npx run builder --tasks```
-
-## Project templates
-
-As used in quick start, project templates are used to generate boilerplate / starter files and add commands to the project:
-
-- [`default`](https://github.com/videinfra/static-website-builder/tree/master/init/default) - simple template with normalize.scss
-
-
-## Plugins
-
-Built-in plugins:
-- `sass` - adds `.sass` and `.scss` file rendering using SASS
-- `twig` - adds `.twig` file rendering using TwigJS
-- `twig/symfony-filters` - adds `humanize` filter as found in Symfony
-- `twig/symfony-functions` - adds `asset` function as found in Symfony
-- `twig/lodash-filters` - adds `omit`, `pick`, `filter`, `reject` and `find` filters as in lodash
-
-Plugins can be enabled by adding them to the `config/config.js`, eg.
-
-```js
-export const plugins = [
-    // Enables SASS engine and .sass and .scss file compilation
-    require('@videinfra/static-website-builder/plugins/sass'),
-
-    // Enables TwigJS engine .twig file compilation
-    require('@videinfra/static-website-builder/plugins/twig'),
-    require('@videinfra/static-website-builder/plugins/twig/symfony-filters'),
-    require('@videinfra/static-website-builder/plugins/twig/symfony-functions'),
-    require('@videinfra/static-website-builder/plugins/twig/lodash-filters'),
-];
-```
-
-## Wiki
-
-See [our wiki](https://github.com/videinfra/static-website-builder/wiki) for additional information.
-
-[npm-url]: https://npmjs.org/package/@videinfra/static-website-builder
-[npm-image]: http://img.shields.io/npm/v/@videinfra/static-website-builder.svg
-[travis-url]: https://travis-ci.org/videinfra/static-website-builder
-[travis-image]: https://travis-ci.org/videinfra/static-website-builder.svg?branch=master
+[npm-url]: https://npmjs.org/package/@videinfra/static-website-builder
+[npm-image]: http://img.shields.io/npm/v/@videinfra/static-website-builder.svg
+[travis-url]: https://travis-ci.org/videinfra/static-website-builder
+[travis-image]: https://travis-ci.org/videinfra/static-website-builder.svg?branch=master
+
+[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url]
+
+`static-website-builder` is a customizable static site project builder powered by Gulp, Rolldown, SASS, PostCSS, TwigJS, BrowserSync
+
+## Requirements
+
+- Node.js >= 20.0.0
+
+## Features
+
+- Gulp: built using gulp
+- Built-in Server: Local development server with hot reloading
+- Templates: HTML templates with minification
+- TWIG: Optional TwigJS template engine with optional plugins for additional functions and filters
+- Stylesheets: Autoprefixing and minification with PostCSS support 
+- SASS: Optional SASS / SCSS compilation
+- Javascript/Typescript: Transpilation, bundling and minification with rolldown
+- SVG icons: Sprite generation from individual SVG files
+
+
+* Paths: Source and destinations paths are configurable
+* Features: All features can be configured or disabled
+* Plugins: create additional plugins / gulp tasks
+
+## Quick start
+
+```
+npm init
+npm install @videinfra/static-website-builder --save
+npx builder init
+```
+
+Start development server
+```
+npm run start
+```
+
+Build production files
+```
+npm run start
+```
+
+Note: these commands are added to the project during `npm init`.
+
+## Commands
+
+### Development server
+
+```npx run builder watch```
+
+### Generate production ready files
+
+```npx run builder build```
+
+### List all available tasks
+
+```npx run builder --tasks```
+
+## Project templates
+
+As used in quick start, project templates are used to generate boilerplate / starter files and add commands to the project:
+
+- [`default`](https://github.com/videinfra/static-website-builder/tree/master/init/default) - simple template with normalize.scss
+
+
+## Plugins
+
+Built-in plugins:
+- `sass` - adds `.sass` and `.scss` file rendering using SASS
+- `twig` - adds `.twig` file rendering using TwigJS
+- `twig/symfony-filters` - adds `humanize` filter as found in Symfony
+- `twig/symfony-functions` - adds `asset` function as found in Symfony
+- `twig/lodash-filters` - adds `omit`, `pick`, `filter`, `reject` and `find` filters as in lodash
+
+Plugins can be enabled by adding them to the `config/config.js`, eg.
+
+```js
+export const plugins = [
+    // Enables SASS engine and .sass and .scss file compilation
+    require('@videinfra/static-website-builder/plugins/sass'),
+
+    // Enables TwigJS engine .twig file compilation
+    require('@videinfra/static-website-builder/plugins/twig'),
+    require('@videinfra/static-website-builder/plugins/twig/symfony-filters'),
+    require('@videinfra/static-website-builder/plugins/twig/symfony-functions'),
+    require('@videinfra/static-website-builder/plugins/twig/lodash-filters'),
+];
+```
+
+## Wiki
+
+See [our wiki](https://github.com/videinfra/static-website-builder/wiki) for additional information.
+
+[npm-url]: https://npmjs.org/package/@videinfra/static-website-builder
+[npm-image]: http://img.shields.io/npm/v/@videinfra/static-website-builder.svg
+[travis-url]: https://travis-ci.org/videinfra/static-website-builder
+[travis-image]: https://travis-ci.org/videinfra/static-website-builder.svg?branch=master

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'
+    ]
+};