@cley_faye/boilerplate 3.3.1 → 3.4.1

package/README.md

@@ -79,7 +79,7 @@ example):
 const {
   reactApp,
   reactAppDynamicTasks,
-} = require("@cley_faye/boilerplate/grunt");
+} = require("@cley_faye/boilerplate/grunt.js");
 
 module.exports = grunt => {
   const baseGruntConfig = {};
@@ -181,7 +181,7 @@ The example from before can become:
 const {
   reactApp,
   reactAppOptionsHelper,
-} = require("@cley_faye/boilerplate/grunt");
+} = require("@cley_faye/boilerplate/grunt.js");
 
 module.exports = grunt => {
   const baseGruntConfig = {};
@@ -239,7 +239,7 @@ It provide basic type checking and inline help display for arguments passed to G
 Usage:
 
 ```JavaScript
-const {getOpts, OptType} = require("@cley_faye/boilerplate/grunt");
+const {getOpts, OptType} = require("@cley_faye/boilerplate/grunt.js");
 module.exports = grunt => {
   const opts = getOpts(
     grunt,
@@ -289,7 +289,7 @@ Quick sample:
 
 ```JavaScript
 import express from "express";
-import {createPipeline} from "@cley_faye/boilerplate/lib/express";
+import {createPipeline} from "@cley_faye/boilerplate/lib/express.js";
 
 const app = express();
 app.use(createPipeline({
@@ -371,7 +371,7 @@ root of the service, or an object with the following properties:
 #### Configuring the template engine
 
 ```JavaScript
-import {setViewEngine} from "@cley_faye/boilerplate/lib/express";
+import {setViewEngine} from "@cley_faye/boilerplate/lib/express.js";
 
 const app = express();
 setViewEngine(app, "pug", "webres/views", {});
@@ -385,9 +385,9 @@ Once the express application is defined, it need to be started to serve files an
 A helper is provided to do so, using the `appStart()` function.
 
 ```JavaScript
-import consoleLogger from "@cley_faye/boilerplate/lib/winston";
-import app from "./app";
-import {appStart} from "@cley_faye/boilerplate/lib/express";
+import {consoleLogger} from "@cley_faye/boilerplate/lib/winston.js";
+import app from "./app.js";
+import {appStart} from "@cley_faye/boilerplate/lib/express.js";
 
 appStart({
   app,
@@ -410,7 +410,7 @@ The function returns a promise that resolve with the actual port used for listen
 The server is automatically registered using the `autoclose` part to stop when a SIGINT signal is
 received.
 It is also possible to trigger a stop by calling the `closeServer()` function on
-`@cley_faye/boilerplate/lib/express/autoclose`.
+`@cley_faye/boilerplate/lib/express/autoclose.js`.
 This feature only supports one server at a time.
 
 Console logging
@@ -418,7 +418,7 @@ Console logging
 For convenience, a winston logger using console as output is provided:
 
 ```JavaScript
-import consoleLogger from "@cley_faye/boilerplate/lib/winston";
+import {consoleLogger} from "@cley_faye/boilerplate/lib/winston.js";
 
 consoleLogger.info("Log line");
 ```
@@ -436,3 +436,11 @@ configuration to `true`.
 
 For Express app, there is no particular things to take care, except that if you use a facility like
 `nodemon` you have to watch the TypeScript output instead of the actual source files.
+
+REPL
+----
+This library provides a function to start a simple REPL instance (using node's built-in repl module)
+to provide access to JavaScript features.
+
+Basic usage includes predefined behavior for providing a database object and a list of services.
+The export is in `lib/repl.js`.

package/grunt.js

@@ -1,3 +1,3 @@
 // This file is kept as an "old" require/modules file to make it easier to use
 // with Gruntfile
-module.exports = require("./lib/grunt");
+module.exports = require("./lib/grunt.js");

package/lib/express/pipelinebuilder.d.ts

@@ -1,7 +1,7 @@
 import express from "express";
 import { OptionsJson, OptionsUrlencoded, OptionsText, Options as OptionsRaw } from "body-parser";
-import { LoggerOptions, ErrorLoggerOptions } from "./logger.js";
 import winston from "winston";
+import { LoggerOptions, ErrorLoggerOptions } from "./logger.js";
 export declare type LogFunction = (...args: Array<string | number | Record<string, unknown>>) => void;
 export interface MiddlewareOptions {
     urlencoded?: boolean | OptionsUrlencoded;

package/lib/express.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="express-serve-static-core" />
 /// <reference types="node" />
-import { PipelineSettings, LogFunction } from "./express/pipelinebuilder.js";
+import { Server } from "net";
 import express from "express";
 import winston from "winston";
-import { Server } from "net";
+import { PipelineSettings, LogFunction } from "./express/pipelinebuilder.js";
 /** Create the full processing pipeline for an Express server
  *
  * This function creates a pipeline this way:

package/lib/grunt/reactapp/copy.d.ts

@@ -1,6 +1,6 @@
-import { GruntConfig } from "./util.js";
 import { BaseOptions } from "../util.js";
 import { HandlerFunctionResult } from "../reactapp.js";
+import { GruntConfig } from "./util.js";
 export interface CopyOptions extends BaseOptions {
     options?: Record<string, unknown>;
     excludedExtensions?: Array<string>;

package/lib/grunt/reactapp/image.d.ts

@@ -1,6 +1,6 @@
-import { GruntConfig } from "./util.js";
 import { BaseOptions } from "../util.js";
 import { HandlerFunctionResult } from "../reactapp.js";
+import { GruntConfig } from "./util.js";
 export interface ImageOptions extends BaseOptions {
     options?: Record<string, unknown>;
     sourcePath?: string;

package/lib/grunt/reactapp/pug.d.ts

@@ -1,6 +1,6 @@
-import { GruntConfig } from "./util.js";
 import { BaseOptions } from "../util.js";
 import { HandlerFunctionResult } from "../reactapp.js";
+import { GruntConfig } from "./util.js";
 export declare type DynamicDataFunc = () => Promise<Record<string, unknown>>;
 export interface PugOptions extends BaseOptions {
     options?: Record<string, unknown>;

package/lib/grunt/reactapp/sass.d.ts

@@ -1,6 +1,6 @@
-import { GruntConfig } from "./util.js";
 import { BaseOptions } from "../util.js";
 import { HandlerFunctionResult } from "../reactapp.js";
+import { GruntConfig } from "./util.js";
 interface SassOptionsOptions {
     implementation?: Record<string, unknown>;
 }

package/lib/grunt/reactapp/webpack.d.ts

@@ -1,6 +1,6 @@
-import { GruntConfig } from "./util.js";
 import { BaseOptions } from "../util.js";
 import { HandlerFunctionResult } from "../reactapp.js";
+import { GruntConfig } from "./util.js";
 export interface WebpackLoadersOptions {
     development?: boolean;
     defines?: Record<string, string>;

package/lib/grunt/reactapp/webpack.js

@@ -31,9 +31,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handle = exports.webpackLoadersDefault = void 0;
 const path_1 = require("path");
-const util_js_1 = require("./util.js");
 const eslint_webpack_plugin_1 = __importDefault(require("eslint-webpack-plugin"));
 const resolve_typescript_plugin_1 = __importDefault(require("resolve-typescript-plugin"));
+const util_js_1 = require("./util.js");
 const defaultCoreJS = 3;
 const eslintPlugin = () => new eslint_webpack_plugin_1.default({ cache: true });
 const defaultLoadersDefine = (options) => [
@@ -241,7 +241,7 @@ const handle = (gruntConfig, targetName, webpackOptions) => {
             babel: { plugins: webpackOptions.babelPlugins },
             typescript: webpackOptions.typescript,
         });
-    const resolve = computeWebpackResolve(webpackOptions);
+    const webpackResolve = computeWebpackResolve(webpackOptions);
     const webpackConfig = {
         mode: webpackOptions.mode,
         devtool: webpackOptions.mode === "development" ? "eval-source-map" : false,
@@ -253,7 +253,7 @@ const handle = (gruntConfig, targetName, webpackOptions) => {
             eslintPlugin(),
             ...webpackOptions.plugins ?? [],
         ],
-        resolve,
+        resolve: webpackResolve,
     };
     // Special case: I'm not sure I can move options in the task-specific part of
     // the configuration, so I add it at the toplevel of the "webpack" task.

package/lib/repl.d.ts

@@ -0,0 +1,27 @@
+/** Function called when the REPL is closed */
+export declare type ReplCloseFunc = () => void;
+/** Mimic the required elements from a db object */
+interface DBLikeObject {
+    /** db object can have a reference to an initialized sequelize instance */
+    sequelize?: {
+        /** Sequelize instance should have a close() method */
+        close?: () => void;
+    };
+}
+interface ReplArgs {
+    /** Display a service name in the prompt */
+    serviceName: string;
+    /**
+     * A DB object. If it exposes a db.sequelize.close() function, it will be called when the REPL is
+     * closed.
+     */
+    db?: DBLikeObject;
+    srv?: Record<string, unknown>;
+    /** Extra properties to attach to the REPL context */
+    extraContext?: Record<string, unknown>;
+    onClose?: ReplCloseFunc;
+    historyFile?: string;
+}
+/** Start the REPL prompt */
+export declare const startRepl: ({ serviceName, db, srv, extraContext, onClose, historyFile, }: ReplArgs) => void;
+export {};

package/lib/repl.js

@@ -0,0 +1,68 @@
+/**
+ * @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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startRepl = void 0;
+const repl_1 = __importDefault(require("repl"));
+const setupContext = (r, db, srv, extraContext) => {
+    const doContextSetup = () => {
+        Object.assign(r.context, {
+            ...extraContext,
+            db,
+            srv,
+        });
+    };
+    doContextSetup();
+    r.on("reset", doContextSetup);
+};
+/** Configure action when the REPL is closed */
+const setupClose = (r, db, onClose) => {
+    if (!db && !onClose)
+        return;
+    r.on("exit", () => {
+        if (db?.sequelize?.close) {
+            db.sequelize.close();
+        }
+        if (onClose) {
+            onClose();
+        }
+    });
+};
+/** Start the REPL prompt */
+const startRepl = ({ serviceName = "", db, srv, extraContext, onClose, historyFile = ".node_repl_history", }) => {
+    const r = repl_1.default.start({
+        prompt: `${serviceName}> `,
+        breakEvalOnSigint: true,
+    });
+    setupContext(r, db, srv, extraContext);
+    setupClose(r, db, onClose);
+    r.setupHistory(historyFile, () => { });
+};
+exports.startRepl = startRepl;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cley_faye/boilerplate",
-  "version": "3.3.1",
+  "version": "3.4.1",
   "description": "Boilerplate code generator for generic projects",
   "repository": {
     "type": "git",
@@ -17,15 +17,16 @@
   },
   "homepage": "https://github.com/CleyFaye/boilerplate#readme",
   "devDependencies": {
-    "@keeex/eslint-config": "^1.5.9",
+    "@keeex/eslint-config": "^1.7.0",
     "@types/express": "^4.17.11",
     "@types/grunt": "^0.4.25",
     "@types/http-errors": "^1.8.0",
     "@types/node": "^16.0.0",
     "@typescript-eslint/eslint-plugin": "^5.3.1",
     "@typescript-eslint/parser": "^5.3.1",
-    "eslint": "^7.20.0",
-    "eslint-plugin-promise": "^5.1.1",
+    "eslint": "^8.7.0",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-promise": "^6.0.0",
     "eslint-webpack-plugin": "^3.0.1",
     "express-winston": "^4.0.5",
     "grunt": "^1.4.1",
@@ -33,6 +34,7 @@
     "grunt-contrib-clean": "^2.0.0",
     "grunt-run": "^0.8.1",
     "load-grunt-tasks": "^5.1.0",
+    "logform": "^2.3.2",
     "typescript": "^4.1.5",
     "winston": "^3.3.3"
   },