@cley_faye/boilerplate 3.16.1 → 3.17.1

package/README.md

@@ -486,6 +486,10 @@ Available config options are:
 - `staticRootDirectories`: optional, name of directories (in the above root directory) to serve as
   static files. Defaults to `["js", "css", "img"]`.
 
+A convenience command is available as "serve_spa" to be called from the command line.
+It is possible to pass it some parameters; run it with `--help` for more informations.
+To use this tool, `minimist` must be installed in addition to express dependencies.
+
 Console logging
 ---------------
 For convenience, a winston logger using console as output is provided:

package/bin/serve_spa.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+// eslint-disable-next-line import/no-unresolved
+import("../lib/bin/serve_spa.js");

package/lib/bin/serve_spa.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/bin/serve_spa.js

@@ -0,0 +1,113 @@
+/**
+ * @license
+ * @preserve
+ * MIT License
+ *
+ * Copyright (c) 2021 Gabriel Paul "Cley Faye" Risterucci
+ *
+ * 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.
+ *
+ */
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path = __importStar(require("node:path"));
+const express_1 = __importDefault(require("express"));
+const minimist_1 = __importDefault(require("minimist"));
+const singlepageapp_js_1 = require("../express/middlewares/singlepageapp.js");
+const express_js_1 = require("../express.js");
+const winston_js_1 = require("../winston.js");
+const ARGV_START_OFFSET = 2;
+const { port, root, index, help, static: staticDirs } = (0, minimist_1.default)(process.argv.slice(ARGV_START_OFFSET));
+const DEFAULT_PORT = 3000;
+const DEFAULT_PATH = path.join("dist", "webapp");
+const DEFAULT_INDEX = "index.html";
+const DEFAULT_STATIC = ["js", "css", "img"];
+if (help) {
+    winston_js_1.consoleLogger.info(`
+Usage:
+
+serve_spa \\
+  [--port=${DEFAULT_PORT}] \\
+  [--root=${DEFAULT_PATH}] \\
+  [--index=${DEFAULT_INDEX}] \\
+  [--static=js…] \\
+  [--help]
+
+The --static argument can be repeated to add more directories to it.
+It defaults to ${JSON.stringify(DEFAULT_STATIC)}.
+`.trim());
+    // eslint-disable-next-line no-process-exit
+    process.exit(0);
+}
+const getPort = () => port ?? DEFAULT_PORT;
+const getStatic = () => {
+    if (!staticDirs)
+        return;
+    return Array.isArray(staticDirs) ? staticDirs : [staticDirs];
+};
+const app = (0, express_1.default)();
+app.use((0, express_js_1.createPipeline)({
+    routes: (0, singlepageapp_js_1.singlePageApp)({
+        rootDir: root ?? "dist/webapp",
+        htmlFile: index,
+        staticRootDirectories: getStatic(),
+    }),
+    options: {
+        defaultErrorHandler: true,
+        log: {
+            route: true,
+            error: true,
+            logger: winston_js_1.consoleLogger,
+        },
+    },
+}));
+(0, express_js_1.appStart)({
+    app,
+    port: getPort(),
+    logger: winston_js_1.consoleLogger,
+}).then(({ port: activePort }) => {
+    winston_js_1.consoleLogger.info(`SPA served on port ${activePort}`);
+})
+    .catch(winston_js_1.consoleLogger.error);

package/lib/express/middlewares/singlepageapp.js

@@ -80,7 +80,10 @@ const singlePageApp = (config) => {
         for (const candidates of staticDirs)
             if (req.url.startsWith(candidates))
                 return next();
-        res.sendFile(htmlFile, { root: rootDir }, (err) => next(err));
+        res.sendFile(htmlFile, { root: rootDir }, (err) => {
+            if (err)
+                return next(err);
+        });
     };
     const staticRoute = express_1.default.static(rootDir);
     return [appRoute, staticRoute];

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "@cley_faye/boilerplate",
-  "version": "3.16.1",
+  "version": "3.17.1",
   "description": "Boilerplate code generator for generic projects",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/CleyFaye/boilerplate.git"
   },
+  "bin": {
+    "serve_spa": "bin/serve_spa.js"
+  },
   "scripts": {
     "prepack": "npm run grunt -- clean build",
     "check": "tsc --noEmit && eslint .",
@@ -22,14 +25,15 @@
     "@types/express": "^4.17.17",
     "@types/grunt": "^0.4.27",
     "@types/http-errors": "^2.0.1",
-    "@types/node": "^18.14.2",
-    "@typescript-eslint/eslint-plugin": "^5.53.0",
-    "@typescript-eslint/parser": "^5.53.0",
-    "eslint": "^8.35.0",
+    "@types/minimist": "^1.2.2",
+    "@types/node": "^18.15.7",
+    "@typescript-eslint/eslint-plugin": "^5.56.0",
+    "@typescript-eslint/parser": "^5.56.0",
+    "eslint": "^8.36.0",
     "eslint-plugin-deprecation": "^1.3.3",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-promise": "^6.1.1",
-    "eslint-webpack-plugin": "^3.2.0",
+    "eslint-webpack-plugin": "^4.0.0",
     "express-winston": "^4.2.0",
     "grunt": "^1.6.1",
     "grunt-banner": "^0.6.0",
@@ -38,7 +42,7 @@
     "load-grunt-tasks": "^5.1.0",
     "logform": "^2.5.1",
     "typescript": "^4.9.5",
-    "webpack": "^5.75.0",
+    "webpack": "^5.76.3",
     "winston": "^3.8.2"
   },
   "peerDependencies": {
@@ -49,7 +53,7 @@
     "babel-loader": "9.x",
     "babel-plugin-transform-define": "2.x",
     "core-js": "3.x",
-    "eslint-webpack-plugin": "^3.0.1",
+    "eslint-webpack-plugin": "^4.0.0",
     "express": "4.x",
     "express-winston": "4.x",
     "grunt": "1.x",
@@ -58,6 +62,7 @@
     "grunt-contrib-watch": "1.x",
     "grunt-sass": "3.x",
     "grunt-webpack": "5.x",
+    "minimist": "^1.2.8",
     "sass": "1.x",
     "ts-loader": "^9.4.1",
     "winston": "3.x"
@@ -111,6 +116,9 @@
     "grunt-webpack": {
       "optional": true
     },
+    "minimist": {
+      "optional": true
+    },
     "sass": {
       "optional": true
     },