@videinfra/static-website-builder 1.4.3 → 1.5.2

package/CHANGELOG.md

@@ -4,6 +4,18 @@ 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.5.2] - 2022-06-17
+### Updated
+- In build mode prevent data from being read more than once
+
+## [1.5.1] - 2022-04-14
+### Fixed
+- Dependency update
+
+## [1.5.0] - 2022-04-13
+### Fixed
+- Read files in `data` folder recursively
+
 ## [1.4.3] - 2022-03-08
 ### Fixed
 - Fixed negative glob paths not working

package/init/index.js

@@ -6,7 +6,6 @@ const folderExists = require('../lib/init/folder-exists');
 const getFolderList = require('../lib/init/get-folder-list');
 const chalk = require('chalk');
 
-
 module.exports = function init (template = 'default') {
     let   templateName = template || 'default';
     let   copyFrom = path.getBuilderPath('init', templateName);

package/lib/camelize-file-name.js

@@ -0,0 +1,21 @@
+/**
+ * Camelize filename
+ *
+ * @param {string} str File name
+ * @returns {string} Camelized name
+ */
+module.exports = function camelizeFileName (str) {
+    return str
+         // Remove extension
+        .replace(/(.+?)\..*$/ig, '$1')
+        // Remove dot
+        .replace(/\./g, '')
+        // Replace non alpha-numeric characters
+        .replace(/[^a-z0-9]/ig, ' ')
+        // Uppercase words
+        .replace(/(?:^\w|[A-Z]|\b\w)/g, function(word, index) {
+             return index === 0 ? word.toLowerCase() : word.toUpperCase();
+        })
+        // Remove empty spaces
+        .replace(/\s+/g, '');
+}

package/lib/get-file-names.js

@@ -0,0 +1,23 @@
+const fs = require('fs');
+const path = require('path');
+
+/**
+ * Returns list of filenames in folder recursively
+ *
+ * @param {string} folder Folder path
+ * @param {string} [subFolder=''] Subfolder path
+ * @returns {array} List of filenames, relative to folder
+ */
+module.exports = function getFileNamesSync (folder, subFolder = '') {
+    let fileNames = []
+
+    fs.readdirSync(folder, { withFileTypes: true }).forEach(file => {
+        if (file.isDirectory()) {
+            fileNames = fileNames.concat(getFileNamesSync(path.join(folder, file.name), path.join(subFolder, file.name)));
+        } else {
+            fileNames.push(path.join(subFolder, file.name))
+        }
+    });
+
+    return fileNames;
+}

package/lib/log-error.js

@@ -1,4 +1,4 @@
-var chalk = require('chalk');
+const chalk = require('chalk');
 
 module.exports = function (error) {
     if (error.plugin) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@videinfra/static-website-builder",
-  "version": "1.4.3",
+  "version": "1.5.2",
   "description": "Customizable static site project builder",
   "license": "MIT",
   "engines": {
@@ -24,16 +24,16 @@
     "test": "gulp build --silent --config=init/test/config/config.js && jest"
   },
   "dependencies": {
-    "@babel/core": "^7.12.3",
-    "@babel/preset-env": "^7.12.1",
-    "autoprefixer": "^9.6.1",
-    "babel-loader": "^8.2.1",
-    "browser-sync": "^2.26.13",
+    "@babel/core": "^7.17.9",
+    "@babel/preset-env": "^7.16.11",
+    "autoprefixer": "^9.8.8",
+    "babel-loader": "^8.2.4",
+    "browser-sync": "^2.27.9",
     "chalk": "4.0.0",
-    "chokidar": "^3.5.1",
-    "cross-env": "^7.0.2",
-    "cssnano": "^4.1.10",
-    "del": "^5.1.0",
+    "chokidar": "^3.5.3",
+    "cross-env": "^7.0.3",
+    "cssnano": "^4.1.11",
+    "del": "^6.0.0",
     "gulp": "^4.0.2",
     "gulp-cached": "^1.1.1",
     "gulp-data": "^1.3.1",
@@ -43,18 +43,18 @@
     "gulp-ignore": "^3.0.0",
     "gulp-plumber": "^1.2.1",
     "gulp-postcss": "^8.0.0",
-    "gulp-sass": "^4.1.0",
+    "gulp-sass": "^4.1.1",
     "gulp-sizereport": "^1.2.1",
     "gulp-sourcemaps": "^3.0.0",
-    "gulp-svgmin": "^3.0.0",
-    "gulp-svgstore": "^7.0.1",
+    "gulp-svgmin": "^4.1.0",
+    "gulp-svgstore": "^9.0.0",
     "gulp-twig": "^1.2.0",
-    "minimist": "^1.2.5",
-    "nano-memoize": "^1.2.1",
-    "webpack": "^4.44.2",
+    "minimist": "^1.2.6",
+    "nano-memoize": "^1.3.0",
+    "webpack": "^4.46.0",
     "webpack-stream": "^5.2.1"
   },
   "devDependencies": {
-    "jest": "^26.6.3"
+    "jest": "^27.5.1"
   }
 }

package/tasks/data/get-data.js

@@ -1,4 +1,3 @@
-const fs = require('fs');
 const path = require('path');
 const reduce = require('lodash/reduce');
 const micromatch = require('micromatch'); // gulp dependency
@@ -7,28 +6,11 @@ const merge = require('../../lib/merge');
 const getPaths = require('../../lib/get-path');
 const getConfig = require('../../lib/get-config');
 const logError = require('../../lib/log-error');
+const getFileNamesSync = require('../../lib/get-file-names');
+const camelizeFileName = require('../../lib/camelize-file-name');
 
-/**
- * Camelize filename
- *
- * @param {string} str File name
- * @returns {string} Camelized name
- */
-function camelizeFileName (str) {
-    return str
-         // Remove extension
-        .replace(/\.[^.]+$/ig, '')
-        // Replace non alpha-numeric characters
-        .replace(/[^a-z0-9]/ig, ' ')
-        // Uppercase words
-        .replace(/(?:^\w|[A-Z]|\b\w)/g, function(word, index) {
-             return index === 0 ? word.toLowerCase() : word.toUpperCase();
-        })
-        // Remove empty spaces
-        .replace(/\s+/g, '');
-}
 
-module.exports = function getData () {
+function getData () {
     const folders = getPaths.getSourcePaths('data');
     const extensions = getConfig.getTaskConfig('data', 'extensions');
     const loaders = getConfig.getTaskConfig('data', 'loaders');
@@ -36,7 +18,7 @@ module.exports = function getData () {
     const group = getConfig.getTaskConfig('data', 'groupByFileName');
 
     const data = reduce(folders, (data, folder) => {
-        fs.readdirSync(folder).forEach(fileName => {
+        getFileNamesSync(folder).forEach(fileName => {
             // Ignore files matching 'ignore' list
             if (ignore.length && micromatch.isMatch(fileName, ignore)) {
                 return;
@@ -81,3 +63,25 @@ module.exports = function getData () {
 
     return data;
 }
+
+
+let cache = null;
+
+module.exports = function (options) {
+    const build = options && !!options.build;
+
+    return function () {
+        if (build) {
+            // Cache during full build
+            if (!cache) {
+                cache = getData();
+            }
+
+            return cache;
+        } else {
+            // Don't cache during watch build
+            cache = null;
+            return getData();
+        }
+    }
+}

package/tasks/html/task.js

@@ -53,36 +53,39 @@ const getEngine = memoize(function () {
     return engine ? engine() : (() => {});
 });
 
+function html (options) {
+    const build = options && !!options.build;
 
-function html () {
-    return gulp.src(getGlobPaths())
-        .pipe(taskStart())
+    return function html () {
+        return gulp.src(getGlobPaths())
+            .pipe(taskStart())
 
-        // Faster incremental builds, skip files which didn't changed or their dependencies didn't changed
-        .pipe(gulpif(!!getConfig.getTaskConfig('html', 'dependents'), cached('html')))
-        .pipe(gulpif(!!getConfig.getTaskConfig('html', 'dependents'), dependents(getConfig.getTaskConfig('dependents'))))
+            // Faster incremental builds, skip files which didn't changed or their dependencies didn't changed
+            .pipe(gulpif(!!getConfig.getTaskConfig('html', 'dependents'), cached('html')))
+            .pipe(gulpif(!!getConfig.getTaskConfig('html', 'dependents'), dependents(getConfig.getTaskConfig('dependents'))))
 
-        // Prevent file from being rendered if it's in the ignore list
-        .pipe(ignore.exclude(getGlobIgnorePaths(), {}))
+            // Prevent file from being rendered if it's in the ignore list
+            .pipe(ignore.exclude(getGlobIgnorePaths(), {}))
 
-        // Preprocess using TWIG
-        .pipe(gulpif(!!getConfig.getTaskConfig('html', 'engine'), data(getData)))
-        .pipe(gulpif(!!getConfig.getTaskConfig('html', 'engine'), getEngine()))
+            // Preprocess using TWIG
+            .pipe(gulpif(!!getConfig.getTaskConfig('html', 'engine'), data(getData({ build: build }))))
+            .pipe(gulpif(!!getConfig.getTaskConfig('html', 'engine'), getEngine()))
 
-        // Minify
-        .pipe(gulpif(!!getConfig.getTaskConfig('html', 'htmlmin'), htmlmin(getConfig.getTaskConfig('html', 'htmlmin'))))
+            // Minify
+            .pipe(gulpif(!!getConfig.getTaskConfig('html', 'htmlmin'), htmlmin(getConfig.getTaskConfig('html', 'htmlmin'))))
 
-        .pipe(taskBeforeDest())
-        .pipe(gulp.dest(getPaths.getDestPath('html')))
+            .pipe(taskBeforeDest())
+            .pipe(gulp.dest(getPaths.getDestPath('html')))
 
-        // Reload on change
-        .pipe(taskEnd());
+            // Reload on change
+            .pipe(taskEnd());
+    };
 }
 
 function htmlWatch () {
-    return taskWatch(getWatchGlobPaths(), html);
+    return taskWatch(getWatchGlobPaths(), html({ build: false }));
 }
 
 
-exports.build = html;
+exports.build = html({ build: true });
 exports.watch = htmlWatch;

package/tests/camelize-file-name.test.js

@@ -0,0 +1,11 @@
+const camelizeFileName = require('../lib/camelize-file-name');
+
+test('Camelize file name', () => {
+    expect(camelizeFileName('test-file-name')).toBe('testFileName');
+    expect(camelizeFileName('testFileName')).toBe('testFileName');
+    expect(camelizeFileName('testFile_name')).toBe('testFileName');
+    expect(camelizeFileName('test-file-name.jpg')).toBe('testFileName');
+    expect(camelizeFileName('testFileName.jpg')).toBe('testFileName');
+    expect(camelizeFileName('test-āēūīķļ-name.jpg.png')).toBe('testName');
+    expect(camelizeFileName('.gitignore')).toBe('gitignore');
+});