@henderea/static-site-builder 1.9.6 → 1.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@henderea/static-site-builder",
-  "version": "1.9.6",
+  "version": "1.10.0",
   "description": "A static site builder",
   "main": "index.js",
   "repository": "henderea/static-site-builder.git",
@@ -19,43 +19,56 @@
   "bin": {
     "static-site-builder": "bin/static-site-builder.js"
   },
+  "scripts": {
+    "lint": "eslint bin config scripts utils",
+    "lint:fix": "eslint --fix bin config scripts utils"
+  },
+  "type": "module",
   "dependencies": {
-    "@babel/core": "^7.12.13",
+    "@babel/core": "^7.16.5",
     "babel-core": "^6.26.3",
-    "babel-loader": "^8.2.2",
-    "case-sensitive-paths-webpack-plugin": "^2.3.0",
-    "chalk": "^4.1.0",
-    "copy-webpack-plugin": "^7.0.0",
+    "babel-loader": "^8.2.3",
+    "case-sensitive-paths-webpack-plugin": "^2.4.0",
+    "chalk": "^5.0.0",
+    "copy-webpack-plugin": "^10.2.0",
     "cross-spawn": "^7.0.3",
-    "css-loader": "^5.0.1",
-    "dotenv": "^8.2.0",
+    "css-loader": "^6.5.1",
+    "dotenv": "^10.0.0",
     "dotenv-expand": "^5.1.0",
-    "ejs": "^3.1.5",
-    "eslint": "^7.19.0",
+    "ejs": "^3.1.6",
+    "eslint": "^8.5.0",
     "file-loader": "^6.2.0",
-    "filesize": "^6.1.0",
+    "filesize": "^8.0.6",
     "find-pkg": "^2.0.0",
-    "globby": "^11.0.2",
-    "gzip-size": "^6.0.0",
-    "handlebars": "^4.7.6",
-    "html-webpack-plugin": "^5.0.0",
-    "lodash": "^4.17.20",
-    "mini-css-extract-plugin": "^1.3.5",
+    "globby": "^12.0.2",
+    "gzip-size": "^7.0.0",
+    "handlebars": "^4.7.7",
+    "html-webpack-plugin": "^5.5.0",
+    "lodash": "^4.17.21",
+    "mini-css-extract-plugin": "^2.4.5",
     "moment": "^2.29.1",
     "moment-locales-webpack-plugin": "^1.2.0",
-    "node-sass": "^5.0.0",
-    "postcss-loader": "^5.0.0",
-    "postcss-preset-env": "^6.7.0",
+    "node-sass": "^7.0.0",
+    "postcss-loader": "^6.2.1",
+    "postcss-preset-env": "^7.0.2",
     "recursive-readdir": "^2.2.2",
-    "sass-loader": "^11.0.0",
-    "strip-ansi": "^6.0.0",
-    "style-loader": "^2.0.0",
-    "thread-loader": "^3.0.1",
-    "ts-loader": "^8.0.15",
-    "tsconfig-paths-webpack-plugin": "^3.3.0",
-    "typescript": "^4.1.3",
-    "webpack": "^5.21.1",
-    "webpack-manifest-plugin": "^3.0.0",
-    "workbox-webpack-plugin": "^6.1.0"
+    "sass-loader": "^12.4.0",
+    "strip-ansi": "^7.0.1",
+    "style-loader": "^3.3.1",
+    "thread-loader": "^3.0.4",
+    "ts-loader": "^9.2.6",
+    "tsconfig-paths-webpack-plugin": "^3.5.2",
+    "typescript": "^4.5.4",
+    "webpack": "^5.65.0",
+    "webpack-manifest-plugin": "^4.0.2",
+    "workbox-webpack-plugin": "^6.4.2"
+  },
+  "devDependencies": {
+    "@babel/eslint-parser": "^7.16.5",
+    "eslint-config-henderea": "1.0.9",
+    "eslint-plugin-import": "^2.25.3"
+  },
+  "eslintConfig": {
+    "extends": "henderea"
   }
 }

package/scripts/build.js

@@ -7,22 +7,22 @@ process.env.NODE_ENV = 'production';
 // Makes the script crash on unhandled rejections instead of silently
 // ignoring them. In the future, promise rejections that are not handled will
 // terminate the Node.js process with a non-zero exit code.
-process.on('unhandledRejection', err => {
-    throw err;
+process.on('unhandledRejection', (err) => {
+  throw err;
 });
 
-require('../config/env');
+import '../config/env.js';
 
-const path = require('path');
-const chalk = require('chalk');
-const fs = require('fs-extra');
-const webpack = require('webpack');
-const config = require('../config/webpack.config.prod');
-const paths = require('../config/paths');
-const checkRequiredFiles = require('../utils/checkRequiredFiles');
-const formatWebpackMessages = require('../utils/formatWebpackMessages');
-const FileSizeReporter = require('../utils/FileSizeReporter');
-const printBuildError = require('../utils/printBuildError');
+// import path from 'path';
+import chalk from 'chalk';
+import fs from 'fs-extra';
+import webpack from 'webpack';
+import config from '../config/webpack.config.prod.js';
+import * as paths from '../config/paths.js';
+import checkRequiredFiles from '../utils/checkRequiredFiles.js';
+import formatWebpackMessages from '../utils/formatWebpackMessages.js';
+import * as FileSizeReporter from '../utils/FileSizeReporter.js';
+import printBuildError from '../utils/printBuildError.js';
 
 const measureFileSizesBeforeBuild =
     FileSizeReporter.measureFileSizesBeforeBuild;
@@ -32,97 +32,97 @@ const WARN_AFTER_BUNDLE_GZIP_SIZE = 512 * 1024;
 const WARN_AFTER_CHUNK_GZIP_SIZE = 1024 * 1024;
 
 if(!checkRequiredFiles([paths.appTemplate, paths.appIndex])) {
-    process.exit(1);
+  process.exit(1);
 }
 
 measureFileSizesBeforeBuild(paths.appDist)
-    .then(previousFileSizes => {
-        // Remove all content but keep the directory so that
-        // if you're in it, you don't end up in Trash
-        fs.emptyDirSync(paths.appDist);
-        // Start the webpack build
-        return build(previousFileSizes);
-    })
-    .then(
-        ({ stats, previousFileSizes, warnings }) => {
-            if(warnings.length) {
-                console.log(chalk.yellow('Compiled with warnings.\n'));
-                console.log(warnings.join('\n\n'));
-                console.log(
-                    '\nSearch for the ' +
+  .then((previousFileSizes) => {
+    // Remove all content but keep the directory so that
+    // if you're in it, you don't end up in Trash
+    fs.emptyDirSync(paths.appDist);
+    // Start the webpack build
+    return build(previousFileSizes);
+  })
+  .then(
+    ({ stats, previousFileSizes, warnings }) => {
+      if(warnings.length) {
+        console.log(chalk.yellow('Compiled with warnings.\n'));
+        console.log(warnings.join('\n\n'));
+        console.log(
+          '\nSearch for the ' +
                     chalk.underline(chalk.yellow('keywords')) +
                     ' to learn more about each warning.'
-                );
-                console.log(
-                    'To ignore, add ' +
+        );
+        console.log(
+          'To ignore, add ' +
                     chalk.cyan('// eslint-disable-next-line') +
                     ' to the line before.\n'
-                );
-            } else {
-                console.log(chalk.green('Compiled successfully.\n'));
-            }
+        );
+      } else {
+        console.log(chalk.green('Compiled successfully.\n'));
+      }
 
-            console.log('File sizes after gzip:\n');
-            printFileSizesAfterBuild(
-                stats,
-                previousFileSizes,
-                paths.appDist,
-                WARN_AFTER_BUNDLE_GZIP_SIZE,
-                WARN_AFTER_CHUNK_GZIP_SIZE
-            );
-            console.log();
-        },
-        err => {
-            console.log(chalk.red('Failed to compile.\n'));
-            printBuildError(err);
-            process.exit(1);
-        }
-    )
-    .catch(err => {
-        if(err && err.message) {
-            console.log(err.message);
-        }
-        process.exit(1);
-    });
+      console.log('File sizes after gzip:\n');
+      printFileSizesAfterBuild(
+        stats,
+        previousFileSizes,
+        paths.appDist,
+        WARN_AFTER_BUNDLE_GZIP_SIZE,
+        WARN_AFTER_CHUNK_GZIP_SIZE
+      );
+      console.log();
+    },
+    (err) => {
+      console.log(chalk.red('Failed to compile.\n'));
+      printBuildError(err);
+      process.exit(1);
+    }
+  )
+  .catch((err) => {
+    if(err && err.message) {
+      console.log(err.message);
+    }
+    process.exit(1);
+  });
 
 // Create the production build and print the deployment instructions.
 function build(previousFileSizes) {
-    console.log('Creating an optimized production build...');
+  console.log('Creating an optimized production build...');
 
-    let compiler = webpack(config);
-    return new Promise((resolve, reject) => {
-        compiler.run((err, stats) => {
-            if(err) {
-                return reject(err);
-            }
-            const messages = formatWebpackMessages(stats.toJson({}, true));
-            if(messages.errors.length) {
-                // Only keep the first error. Others are often indicative
-                // of the same problem, but confuse the reader with noise.
-                if(messages.errors.length > 1) {
-                    messages.errors.length = 1;
-                }
-                return reject(new Error(messages.errors.join('\n\n')));
-            }
-            if(
-                process.env.CI &&
+  let compiler = webpack(config);
+  return new Promise((resolve, reject) => {
+    compiler.run((err, stats) => {
+      if(err) {
+        return reject(err);
+      }
+      const messages = formatWebpackMessages(stats.toJson({}, true));
+      if(messages.errors.length) {
+        // Only keep the first error. Others are often indicative
+        // of the same problem, but confuse the reader with noise.
+        if(messages.errors.length > 1) {
+          messages.errors.length = 1;
+        }
+        return reject(new Error(messages.errors.join('\n\n')));
+      }
+      if(
+        process.env.CI &&
                 (typeof process.env.CI !== 'string' ||
                     process.env.CI.toLowerCase() !== 'false') &&
                 messages.warnings.length
-            ) {
-                console.log(
-                    chalk.yellow(
-                        '\nTreating warnings as errors because process.env.CI = true.\n' +
+      ) {
+        console.log(
+          chalk.yellow(
+            '\nTreating warnings as errors because process.env.CI = true.\n' +
                         'Most CI servers set it automatically.\n'
-                    )
-                );
-                return reject(new Error(messages.warnings.join('\n\n')));
-            }
-            return resolve({
-                stats,
-                previousFileSizes,
-                warnings: messages.warnings,
-            });
-        });
+          )
+        );
+        return reject(new Error(messages.warnings.join('\n\n')));
+      }
+      return resolve({
+        stats,
+        previousFileSizes,
+        warnings: messages.warnings,
+      });
     });
-}
+  });
+}

package/scripts/watch.js

@@ -7,22 +7,22 @@ process.env.NODE_ENV = 'development';
 // Makes the script crash on unhandled rejections instead of silently
 // ignoring them. In the future, promise rejections that are not handled will
 // terminate the Node.js process with a non-zero exit code.
-process.on('unhandledRejection', err => {
-    throw err;
+process.on('unhandledRejection', (err) => {
+  throw err;
 });
 
-require('../config/env');
+import '../config/env.js';
 
-const path = require('path');
-const chalk = require('chalk');
-const fs = require('fs-extra');
-const webpack = require('webpack');
-const config = require('../config/webpack.config.dev');
-const paths = require('../config/paths');
-const checkRequiredFiles = require('../utils/checkRequiredFiles');
-const formatWebpackMessages = require('../utils/formatWebpackMessages');
-const FileSizeReporter = require('../utils/FileSizeReporter');
-const printBuildError = require('../utils/printBuildError');
+// import path from 'path';
+import chalk from 'chalk';
+import fs from 'fs-extra';
+import webpack from 'webpack';
+import config from '../config/webpack.config.dev.js';
+import * as paths from '../config/paths.js';
+import checkRequiredFiles from '../utils/checkRequiredFiles.js';
+import formatWebpackMessages from '../utils/formatWebpackMessages.js';
+import * as FileSizeReporter from '../utils/FileSizeReporter.js';
+import printBuildError from '../utils/printBuildError.js';
 
 const measureFileSizesBeforeBuild =
     FileSizeReporter.measureFileSizesBeforeBuild;
@@ -32,89 +32,89 @@ const WARN_AFTER_BUNDLE_GZIP_SIZE = 512 * 1024;
 const WARN_AFTER_CHUNK_GZIP_SIZE = 1024 * 1024;
 
 if(!checkRequiredFiles([paths.appTemplate, paths.appIndex])) {
-    process.exit(1);
+  process.exit(1);
 }
 
 measureFileSizesBeforeBuild(paths.appBuild)
-    .then(previousFileSizes => {
-        // Remove all content but keep the directory so that
-        // if you're in it, you don't end up in Trash
-        fs.emptyDirSync(paths.appBuild);
-        // Start the webpack build
-        return build(previousFileSizes,
-            ({ stats, previousFileSizes, warnings }) => {
-                if(warnings.length) {
-                    console.log(chalk.yellow('Compiled with warnings.\n'));
-                    console.log(warnings.join('\n\n'));
-                    console.log(
-                        '\nSearch for the ' +
+  .then((previousFileSizes) => {
+    // Remove all content but keep the directory so that
+    // if you're in it, you don't end up in Trash
+    fs.emptyDirSync(paths.appBuild);
+    // Start the webpack build
+    return build(previousFileSizes,
+      ({ stats, previousFileSizes, warnings }) => {
+        if(warnings.length) {
+          console.log(chalk.yellow('Compiled with warnings.\n'));
+          console.log(warnings.join('\n\n'));
+          console.log(
+            '\nSearch for the ' +
                         chalk.underline(chalk.yellow('keywords')) +
                         ' to learn more about each warning.'
-                    );
-                    console.log(
-                        'To ignore, add ' +
+          );
+          console.log(
+            'To ignore, add ' +
                         chalk.cyan('// eslint-disable-next-line') +
                         ' to the line before.\n'
-                    );
-                } else {
-                    console.log(chalk.green('Compiled successfully.\n'));
-                }
-
-                console.log('File sizes after gzip:\n');
-                printFileSizesAfterBuild(
-                    stats,
-                    previousFileSizes,
-                    paths.appBuild,
-                    WARN_AFTER_BUNDLE_GZIP_SIZE,
-                    WARN_AFTER_CHUNK_GZIP_SIZE
-                );
-                console.log();
-            },
-            err => {
-                console.log(chalk.red('Failed to compile.\n'));
-                printBuildError(err);
-            });
-    })
-    .catch(err => {
-        if(err && err.message) {
-            console.log(err.message);
+          );
+        } else {
+          console.log(chalk.green('Compiled successfully.\n'));
         }
-    });
+
+        console.log('File sizes after gzip:\n');
+        printFileSizesAfterBuild(
+          stats,
+          previousFileSizes,
+          paths.appBuild,
+          WARN_AFTER_BUNDLE_GZIP_SIZE,
+          WARN_AFTER_CHUNK_GZIP_SIZE
+        );
+        console.log();
+      },
+      (err) => {
+        console.log(chalk.red('Failed to compile.\n'));
+        printBuildError(err);
+      });
+  })
+  .catch((err) => {
+    if(err && err.message) {
+      console.log(err.message);
+    }
+  });
 
 // Create the production build and print the deployment instructions.
 function build(previousFileSizes, resolve, reject) {
-    let compiler = webpack(config);
-    compiler.watch({}, (err, stats) => {
-        if(err) {
-            return reject(err);
-        }
-        const messages = formatWebpackMessages(stats.toJson({}, true));
-        if(messages.errors.length) {
-            // Only keep the first error. Others are often indicative
-            // of the same problem, but confuse the reader with noise.
-            if(messages.errors.length > 1) {
-                messages.errors.length = 1;
-            }
-            return reject(new Error(messages.errors.join('\n\n')));
-        }
-        if(
-            process.env.CI &&
+  let compiler = webpack(config);
+  compiler.watch({}, (err, stats) => {
+    if(err) {
+      return reject(err);
+    }
+    const messages = formatWebpackMessages(stats.toJson({}, true));
+    if(messages.errors.length) {
+      // Only keep the first error. Others are often indicative
+      // of the same problem, but confuse the reader with noise.
+      if(messages.errors.length > 1) {
+        messages.errors.length = 1;
+      }
+      return reject(new Error(messages.errors.join('\n\n')));
+    }
+    if(
+      process.env.CI &&
             (typeof process.env.CI !== 'string' ||
                 process.env.CI.toLowerCase() !== 'false') &&
             messages.warnings.length
-        ) {
-            console.log(
-                chalk.yellow(
-                    '\nTreating warnings as errors because process.env.CI = true.\n' +
+    ) {
+      console.log(
+        chalk.yellow(
+          '\nTreating warnings as errors because process.env.CI = true.\n' +
                     'Most CI servers set it automatically.\n'
-                )
-            );
-            return reject(new Error(messages.warnings.join('\n\n')));
-        }
-        return resolve({
-            stats,
-            previousFileSizes,
-            warnings: messages.warnings,
-        });
+        )
+      );
+      return reject(new Error(messages.warnings.join('\n\n')));
+    }
+    return resolve({
+      stats,
+      previousFileSizes,
+      warnings: messages.warnings,
     });
-}
+  });
+}

package/utils/FileSizeReporter.js

@@ -7,13 +7,13 @@
 
 'use strict';
 
-var fs = require('fs');
-var path = require('path');
-var chalk = require('chalk');
-var filesize = require('filesize');
-var recursive = require('recursive-readdir');
-var stripAnsi = require('strip-ansi');
-var gzipSize = require('gzip-size').sync;
+import fs from 'fs';
+import path from 'path';
+import chalk from 'chalk';
+import filesize from 'filesize';
+import recursive from 'recursive-readdir';
+import stripAnsi from 'strip-ansi';
+import { gzipSizeSync } from 'gzip-size';
 
 // Prints a detailed summary of build files.
 function printFileSizesAfterBuild(
@@ -26,13 +26,13 @@ function printFileSizesAfterBuild(
   var root = previousSizeMap.root;
   var sizes = previousSizeMap.sizes;
   var assets = (webpackStats.stats || [webpackStats])
-    .map(stats =>
+    .map((stats) =>
       stats
         .toJson()
-        .assets.filter(asset => /\.(js|css)$/.test(asset.name))
-        .map(asset => {
+        .assets.filter((asset) => /\.(js|css)$/.test(asset.name))
+        .map((asset) => {
           var fileContents = fs.readFileSync(path.join(root, asset.name));
-          var size = gzipSize(fileContents);
+          var size = gzipSizeSync(fileContents);
           var previousSize = sizes[removeFileNameHash(root, asset.name)];
           var difference = getDifferenceLabel(size, previousSize);
           return {
@@ -51,13 +51,13 @@ function printFileSizesAfterBuild(
   assets.sort((a, b) => b.size - a.size);
   var longestSizeLabelLength = Math.max.apply(
     null,
-    assets.map(a => stripAnsi(a.sizeLabel).length)
+    assets.map((a) => stripAnsi(a.sizeLabel).length)
   );
   var suggestBundleSplitting = false;
-  assets.forEach(asset => {
+  assets.forEach((asset) => {
     var sizeLabel = asset.sizeLabel;
     var sizeLength = stripAnsi(sizeLabel).length;
-    if (sizeLength < longestSizeLabelLength) {
+    if(sizeLength < longestSizeLabelLength) {
       var rightPadding = ' '.repeat(longestSizeLabelLength - sizeLength);
       sizeLabel += rightPadding;
     }
@@ -66,7 +66,7 @@ function printFileSizesAfterBuild(
       ? maxBundleGzipSize
       : maxChunkGzipSize;
     var isLarge = maxRecommendedSize && asset.size > maxRecommendedSize;
-    if (isLarge && path.extname(asset.name) === '.js') {
+    if(isLarge && path.extname(asset.name) === '.js') {
       suggestBundleSplitting = true;
     }
     console.log(
@@ -77,7 +77,7 @@ function printFileSizesAfterBuild(
         chalk.cyan(asset.name)
     );
   });
-  if (suggestBundleSplitting) {
+  if(suggestBundleSplitting) {
     console.log();
     console.log(
       chalk.yellow('The bundle size is significantly larger than recommended.')
@@ -111,11 +111,11 @@ function getDifferenceLabel(currentSize, previousSize) {
   var FIFTY_KILOBYTES = 1024 * 50;
   var difference = currentSize - previousSize;
   var fileSize = !Number.isNaN(difference) ? filesize(difference) : 0;
-  if (difference >= FIFTY_KILOBYTES) {
+  if(difference >= FIFTY_KILOBYTES) {
     return chalk.red('+' + fileSize);
-  } else if (difference < FIFTY_KILOBYTES && difference > 0) {
+  } else if(difference < FIFTY_KILOBYTES && difference > 0) {
     return chalk.yellow('+' + fileSize);
-  } else if (difference < 0) {
+  } else if(difference < 0) {
     return chalk.green(fileSize);
   } else {
     return '';
@@ -123,16 +123,16 @@ function getDifferenceLabel(currentSize, previousSize) {
 }
 
 function measureFileSizesBeforeBuild(buildFolder) {
-  return new Promise(resolve => {
+  return new Promise((resolve) => {
     recursive(buildFolder, (err, fileNames) => {
       var sizes;
-      if (!err && fileNames) {
+      if(!err && fileNames) {
         sizes = fileNames
-          .filter(fileName => /\.(js|css)$/.test(fileName))
+          .filter((fileName) => /\.(js|css)$/.test(fileName))
           .reduce((memo, fileName) => {
             var contents = fs.readFileSync(fileName);
             var key = removeFileNameHash(buildFolder, fileName);
-            memo[key] = gzipSize(contents);
+            memo[key] = gzipSizeSync(contents);
             return memo;
           }, {});
       }
@@ -144,7 +144,7 @@ function measureFileSizesBeforeBuild(buildFolder) {
   });
 }
 
-module.exports = {
-  measureFileSizesBeforeBuild: measureFileSizesBeforeBuild,
-  printFileSizesAfterBuild: printFileSizesAfterBuild,
-};
+export {
+  measureFileSizesBeforeBuild,
+  printFileSizesAfterBuild
+};

package/utils/checkRequiredFiles.js

@@ -7,14 +7,14 @@
 
 'use strict';
 
-var fs = require('fs');
-var path = require('path');
-var chalk = require('chalk');
+import fs from 'fs';
+import path from 'path';
+import chalk from 'chalk';
 
-function checkRequiredFiles(files) {
+export default function checkRequiredFiles(files) {
   var currentFilePath;
   try {
-    files.forEach(filePath => {
+    files.forEach((filePath) => {
       currentFilePath = filePath;
       fs.accessSync(filePath, fs.F_OK);
     });
@@ -28,5 +28,3 @@ function checkRequiredFiles(files) {
     return false;
   }
 }
-
-module.exports = checkRequiredFiles;