@videinfra/static-website-builder 1.9.1 → 1.10.1

package/CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.10.1] - 2024-02-13
+### Fixed
+- TWIG config
+
+## [1.10.0] - 2024-02-13
+### Updated
+- Changed TWIG to use async mode by default, added option
+- Enabled TWIG cache for improved production builds
+
 ## [1.9.1] - 2023-11-01
 ### Fixed
 - Fixed public path for dynamic imports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@videinfra/static-website-builder",
-  "version": "1.9.1",
+  "version": "1.10.1",
   "description": "Customizable static site project builder",
   "license": "MIT",
   "engines": {
@@ -50,11 +50,12 @@
     "gulp-sourcemaps": "^3.0.0",
     "gulp-svgmin": "^4.1.0",
     "gulp-svgstore": "^9.0.0",
-    "gulp-twig": "^1.2.0",
+    "map-stream": "^0.1.0",
     "minimist": "^1.2.8",
     "nano-memoize": "1.3.0",
     "node-sass": "^7.0.3",
     "sass": "^1.65.1",
+    "twig": "^1.10.5",
     "webpack": "^4.46.0",
     "webpack-stream": "^5.2.1"
   },

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

@@ -1,4 +1,4 @@
-const twig = require('gulp-twig');
+const twig = require('../../vendor/gulp-twig/index');
 const getConfig = require('./../../lib/get-config');
 const getPaths = require('./../../lib/get-path');
 const flattenDeep = require('lodash/flattenDeep');

package/plugins/twig.js

@@ -27,6 +27,12 @@ exports.html = {
     },
 
     twig: {
+        // Async rendering
+        async: true,
+
+        // Disabled cache by default, it's enabled for production build only
+        cache: false,
+
         // Custom functions
         functions: [
             // require('../../plugins/twig/symfony-functions.js'),
@@ -36,7 +42,13 @@ exports.html = {
         filters: [
             // require('../../plugins/twig/lodash-filters.js'),
             // require('../../plugins/twig/symfony-functions.js'),
-        ]
+        ],
+
+        // Production only settings, overwrites default settings
+        production: {
+            // Enable cache for improved performance during production build
+            cache: true,
+        },
     },
 
     // List of CDNs when using symphony filters / funtions

package/vendor/gulp-twig/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Simon de Turck <simon@zimmen.com> www.zimmen.com
+
+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/vendor/gulp-twig/README.md

@@ -0,0 +1,167 @@
+[![Build Status](https://travis-ci.org/zimmen/gulp-twig.png?branch=master)](https://travis-ci.org/zimmen/gulp-twig)
+
+<table>
+<tr>
+<td>Package</td><td>gulp-twig</td>
+</tr>
+<tr>
+<td>Description</td>
+<td>Twig plugin for gulp.js, The streaming build system</td>
+</tr>
+<tr>
+<td>Node Version</td>
+<td>>= 4</td>
+</tr>
+<tr>
+<td>Gulp Version</td>
+<td>3.x</td>
+</tr>
+</table>
+
+
+Compile [Twig.js](https://github.com/justjohn/twig.js) templates with Gulp. Build upon [Twig.js](https://github.com/justjohn/twig.js) , the JS port of the Twig templating language by John Roepke.
+
+You can use this plugin with [gulp-data](https://www.npmjs.com/package/gulp-data).
+
+## Usage
+
+### Install
+
+```bash
+npm install gulp-twig --save
+```
+### Example
+
+```html
+{# index.twig #}
+{% extends "layout.twig" %}
+
+{% block page %}
+    <header>
+        <h1>Gulp and Twig.js</h1>
+    </header>
+    <p>
+        This page is generated by Twig.js using the gulp-twig gulp plugin.
+    </p>
+    <ul>
+        {% for value in benefits %}
+            <li>{{ value }}</li>
+        {% endfor %}
+    </ul>
+{% endblock %}
+```
+
+```html
+{# layout.twig #}
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8"/>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"/>
+    <meta name="description" content="A demo of how to use gulp-twig"/>
+    <meta name="author" content="Simon de Turck"/>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+
+    <title>{{ title }}</title>
+
+</head>
+<body>
+<section>
+    {% block page %}{% endblock %}
+</section>
+</body>
+</html>
+```
+
+```javascript
+var gulp = require('gulp');
+
+gulp.task('compile', function () {
+    'use strict';
+    var twig = require('gulp-twig');
+    return gulp.src('./index.twig')
+        .pipe(twig({
+            data: {
+                title: 'Gulp and Twig',
+                benefits: [
+                    'Fast',
+                    'Flexible',
+                    'Secure'
+                ]
+            }
+        }))
+        .pipe(gulp.dest('./'));
+});
+
+gulp.task('default', ['compile']);
+```
+
+### Options:
+**data**: [object| *The data that is exposed in the twig files. Or use gulp-data to pipe files directly into gulp-twig*
+
+**base**: [string] *sets the views base folder. Extends can be loaded relative to this path*
+
+**errorLogToConsole**: [true|false] *logs errors to console (defaults to false)*
+
+**onError**: [function] *handle error yourself*
+
+**cache**: [true|false] *enables the Twig cache. (defaults to false)*
+
+**debug**: [true|false] *enables debug info logging (defaults to false)*
+
+**trace**: [true|false] *enables tracing info logging (defaults to false)*
+
+**extend**: [function (Twig)] *extends Twig with new tags types. The Twig attribute is Twig.js's internal object. [Read more here](https://github.com/justjohn/twig.js/wiki/Extending-twig.js-With-Custom-Tags)*
+
+**extname**: [string|true|false] *output file extension including the '.' like path.extname(filename). Use `true` to keep source extname and a "falsy" value to drop the file extension*
+
+**useFileContents**: [true|false] *use file contents instead of file path (defaults to false) [Read more here](https://github.com/zimmen/gulp-twig/issues/30)*
+
+**functions**: [array] *extends Twig with given function objects. (default to undefined)*
+```javascript
+[
+    {
+        name: "nameOfFunction",
+        func: function (args) {
+            return "the function";
+        }
+    }
+]
+```
+
+**filters**: [array] *extends Twig with given filter objects. (default to undefined)*
+```javascript
+[
+    {
+        name: "nameOfFilter",
+        func: function (args) {
+            return "the filter";
+        }
+    }
+]
+```
+### LICENSE
+
+(MIT License)
+
+Copyright (c) 2015 Simon de Turck <simon@zimmen.com> www.zimmen.com
+
+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/vendor/gulp-twig/index.js

@@ -0,0 +1,130 @@
+// 2024-02-13, Kaspars Zuks: added "options.async" support
+var map = require('map-stream');
+var rext = require('replace-ext');
+var log = require('fancy-log');
+var PluginError = require('plugin-error');
+
+const PLUGIN_NAME = 'gulp-twig';
+
+module.exports = function (options) {
+    'use strict';
+    options = Object.assign({}, {
+      changeExt: true,
+      extname: '.html',
+      useFileContents: false,
+      async: true,
+    }, options || {});
+
+    function modifyContents(file, cb) {
+        var data = file.data || Object.assign({}, options.data);
+
+        if (file.isNull()) {
+            return cb(null, file);
+        }
+
+        if (file.isStream()) {
+            return cb(new PluginError(PLUGIN_NAME, 'Streaming not supported!'));
+        }
+
+        data._file   = file;
+        if(options.changeExt === false || options.extname === true){
+            data._target = {
+                 path: file.path,
+                 relative: file.relative
+             }
+        }else{
+            data._target = {
+                path: rext(file.path, options.extname || ''),
+                relative: rext(file.relative, options.extname || '')
+            }
+        }
+
+        var Twig = require('twig'),
+            twig = Twig.twig,
+            twigOpts = {
+                path: file.path,
+                async: false
+            },
+            template;
+
+        if (options.debug !== undefined) {
+            twigOpts.debug = options.debug;
+        }
+        if (options.trace !== undefined) {
+            twigOpts.trace = options.trace;
+        }
+        if (options.base !== undefined) {
+            twigOpts.base = options.base;
+        }
+        if (options.namespaces !== undefined) {
+            twigOpts.namespaces = options.namespaces;
+        }
+        if (options.cache !== true) {
+            Twig.cache(false);
+        }
+
+        if (options.functions) {
+            options.functions.forEach(function (func) {
+                Twig.extendFunction(func.name, func.func);
+            });
+        }
+
+        if (options.filters) {
+            options.filters.forEach(function (filter) {
+                Twig.extendFilter(filter.name, filter.func);
+            });
+        }
+
+        if(options.extend) {
+            Twig.extend(options.extend);
+            delete options.extend;
+        }
+
+        if (options.useFileContents) {
+          var fileContents = file.contents.toString();
+          twigOpts.data = fileContents
+        }
+
+        template = twig(twigOpts);
+
+        if (options.async) {
+            template.renderAsync(data)
+                .then(function (output) {
+                    file.contents = new Buffer(output);
+                    file.path = data._target.path;
+                    cb(null, file);
+                })
+                .catch(function (e) {
+                    if (options.errorLogToConsole) {
+                        log(PLUGIN_NAME + ' ' + e);
+                        cb();
+                    } else if (typeof options.onError === 'function') {
+                        options.onError(e);
+                        cb();
+                    } else {
+                        cb(new PluginError(PLUGIN_NAME, e));
+                    }
+                });
+        } else {
+            try {
+                file.contents = new Buffer(template.render(data));
+            }catch(e){
+                if (options.errorLogToConsole) {
+                    log(PLUGIN_NAME + ' ' + e);
+                    return cb();
+                }
+
+                if (typeof options.onError === 'function') {
+                    options.onError(e);
+                    return cb();
+                }
+                return cb(new PluginError(PLUGIN_NAME, e));
+            }
+
+            file.path = data._target.path;
+            cb(null, file);
+        }
+    }
+
+    return map(modifyContents);
+};

package/vendor/gulp-twig/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "gulp-twig",
+  "description": "Twig.js plugin for gulp.js (gulpjs.com)",
+  "version": "1.2.0",
+  "homepage": "http://github.com/zimmen/gulp-twig",
+  "repository": {
+    "type": "git",
+    "url": "http://github.com/zimmen/gulp-twig.git"
+  },
+  "author": "Simon de Turck <simon@zimmen.com> (http://www.zimmen.com)",
+  "main": "./index.js",
+  "dependencies": {
+    "fancy-log": "^1.3.2",
+    "map-stream": "^0.1.0",
+    "plugin-error": "^0.1.2",
+    "replace-ext": "^1.0.0",
+    "twig": "^1.10.5"
+  },
+  "devDependencies": {
+    "mocha": "*",
+    "should": "*",
+    "vinyl": "^2.1.0"
+  },
+  "scripts": {
+    "test": "mocha -R spec"
+  },
+  "engines": {
+    "node": ">=4.0"
+  },
+  "keywords": [
+    "twig",
+    "twig.js",
+    "gulp",
+    "gulpplugin",
+    "gulp-plugin"
+  ],
+  "licenses": [
+    {
+      "type": "MIT",
+      "url": "http://github.com/zimmen/gulp-twig/raw/master/LICENSE"
+    }
+  ]
+}