@cley_faye/boilerplate 3.2.1 → 3.4.1

package/README.md

@@ -19,6 +19,8 @@ required, and for what. It's up to the calling project to have the proper depend
 
 For webapp building:
 
+- resolve-typescript-plugin (due to the way webpack plugins are handled, this is mandatory for dev
+  install)
 - babel-loader
 - eslint-webpack-plugin
 - @babel/core
@@ -34,6 +36,7 @@ For webapp building:
 - sass
 - grunt-webpack
 - grunt
+- ts-loader (for supporting TypeScript import in webpack/babel)
 
 For express:
 
@@ -76,7 +79,7 @@ example):
 const {
   reactApp,
   reactAppDynamicTasks,
-} = require("@cley_faye/boilerplate/grunt");
+} = require("@cley_faye/boilerplate/grunt.js");
 
 module.exports = grunt => {
   const baseGruntConfig = {};
@@ -178,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 = {};
@@ -200,7 +203,7 @@ module.exports = grunt => {
     )
   );
   grunt.initConfig(baseGruntConfig);
-  grunt.register(
+  grunt.registerTask(
     "myWebApp",
     "Build the webapp",
     requiredTasks
@@ -236,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,
@@ -286,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({
@@ -368,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", {});
@@ -382,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,
@@ -407,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
@@ -415,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");
 ```
@@ -426,8 +429,18 @@ Typical use of TypeScript implies converting `.ts` file to `.js`.
 For a React app using webpack, there's two approach: either instruct webpack to accept `.ts` files
 (for example, using `ts-loader`) or have your entry point be a `.js` file that imports the generated
 output from TypeScript.
-Either way, watch mode will be capable of detecting change in the source material, as long as the
-TypeScript compiler is also running.
+If you reference the output of the TypeScript compiler, you can keep it updated using `npx tsc -w`.
+
+Using `ts-loader` can be done automatically by setting the `typescript` property in the webpack
+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/args.d.ts

@@ -66,6 +66,10 @@ export declare type OptionDefinition = OptionDefinitionString | OptionDefinition
  * Expected options from command line
  */
 export declare type ConfigDefinition = Record<string, OptionDefinition>;
+/**
+ * Display help to the user
+ */
+export declare const displayHelp: (configDef: ConfigDefinition) => void;
 /**
  * Construct the full config object from command line values.
  *

package/lib/grunt/args.js

@@ -26,7 +26,7 @@
  */
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOptionsFromGruntCLI = exports.OptType = void 0;
+exports.getOptionsFromGruntCLI = exports.displayHelp = exports.OptType = void 0;
 const util_js_1 = require("../util.js");
 // eslint-disable-next-line no-shadow
 var OptType;
@@ -125,6 +125,7 @@ const displayHelp = (configDef) => {
     outputHelp("Accepted command line arguments:");
     Object.keys(configDef).forEach(configKey => displayHelpForConfigKey(configKey, configDef[configKey]));
 };
+exports.displayHelp = displayHelp;
 /**
  * Construct the full config object from command line values.
  *
@@ -132,7 +133,7 @@ const displayHelp = (configDef) => {
  */
 const getOptionsFromGruntCLI = (optionProvider, configDef) => {
     if (getFromOptionProvider("help", optionProvider) === true) {
-        displayHelp(configDef);
+        (0, exports.displayHelp)(configDef);
         return null;
     }
     const result = {};

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>;
@@ -9,6 +9,7 @@ export interface WebpackLoadersOptions {
         targets?: string;
         plugins?: Array<Record<string, unknown>>;
     };
+    typescript?: boolean;
 }
 /** Build the default webpack loaders list.
  *
@@ -30,6 +31,9 @@ export interface WebpackLoadersOptions {
  *
  * @param [options.babel.plugins]
  * Plugins to add to babel
+ *
+ * @param [options.typescript]
+ * Add support for importing .ts and .tsx files
  */
 export declare const webpackLoadersDefault: (options: WebpackLoadersOptions) => Array<Record<string, unknown>>;
 export interface WebpackOptions extends BaseOptions {
@@ -45,7 +49,8 @@ export interface WebpackOptions extends BaseOptions {
     plugins?: Array<Record<string, unknown>>;
     babelPlugins?: Array<Record<string, unknown>>;
     defines?: Record<string, string>;
-    resolve?: unknown;
+    resolve?: Record<string, unknown>;
+    typescript?: boolean;
 }
 /** Add a webpack task for the reactApp recipe
  *
@@ -99,6 +104,9 @@ export interface WebpackOptions extends BaseOptions {
  * Build mode. "development", "production" or "none".
  * Defaults to "development"
  *
+ * @param [webpackOptions.typescript]
+ * Allow loading typescript source for webpack/babel.
+ *
  * @return
  * List of tasks added.
  * This function add "webpack:<targetName>".

package/lib/grunt/reactapp/webpack.js

@@ -31,8 +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) => [
@@ -78,27 +79,43 @@ const defaultLoadersReact = (options) => [
  *
  * @param [options.babel.plugins]
  * Plugins to add to babel
+ *
+ * @param [options.typescript]
+ * Add support for importing .ts and .tsx files
  */
-const webpackLoadersDefault = (options) => [
-    {
-        test: /.js$/u,
-        exclude: /node_modules/u,
-        use: {
-            loader: "babel-loader",
-            options: {
-                cacheDirectory: true,
-                presets: [
-                    defaultLoadersPresetEnv(options),
-                    defaultLoadersReact(options),
-                ],
-                plugins: [
-                    defaultLoadersDefine(options),
-                    ...(options.babel?.plugins ?? []),
-                ],
+const webpackLoadersDefault = (options) => {
+    const allFilesCheck = options.typescript
+        ? /.(?:js|ts|tsx)$/u
+        : /.js$/u;
+    const res = [
+        {
+            test: allFilesCheck,
+            exclude: /node_modules/u,
+            use: {
+                loader: "babel-loader",
+                options: {
+                    cacheDirectory: true,
+                    presets: [
+                        defaultLoadersPresetEnv(options),
+                        defaultLoadersReact(options),
+                    ],
+                    plugins: [
+                        defaultLoadersDefine(options),
+                        ...(options.babel?.plugins ?? []),
+                    ],
+                },
             },
         },
-    },
-];
+    ];
+    if (options.typescript) {
+        res.push({
+            test: /.(?:ts|tsx)$/u,
+            use: "ts-loader",
+            exclude: /node_modules/u,
+        });
+    }
+    return res;
+};
 exports.webpackLoadersDefault = webpackLoadersDefault;
 const computeWebpackOutput = (webpackOptions, targetName) => webpackOptions.output ?? {
     path: (0, path_1.resolve)("dist", targetName, "js"),
@@ -143,6 +160,16 @@ const registerTasks = (gruntConfig, targetName, webpackConfig) => {
         (0, util_js_1.insertTask)(gruntConfig, "webpack", targetName, webpackConfig),
     ];
 };
+const computeWebpackResolve = (webpackOptions) => {
+    const res = { ...webpackOptions.resolve };
+    if (webpackOptions.typescript) {
+        if (res.plugins === undefined) {
+            res.plugins = [];
+        }
+        res.plugins.push(new resolve_typescript_plugin_1.default());
+    }
+    return res;
+};
 /** Add a webpack task for the reactApp recipe
  *
  * @param gruntConfig
@@ -195,6 +222,9 @@ const registerTasks = (gruntConfig, targetName, webpackConfig) => {
  * Build mode. "development", "production" or "none".
  * Defaults to "development"
  *
+ * @param [webpackOptions.typescript]
+ * Allow loading typescript source for webpack/babel.
+ *
  * @return
  * List of tasks added.
  * This function add "webpack:<targetName>".
@@ -209,7 +239,9 @@ const handle = (gruntConfig, targetName, webpackOptions) => {
             development: webpackOptions.mode === "development",
             defines: webpackOptions.defines,
             babel: { plugins: webpackOptions.babelPlugins },
+            typescript: webpackOptions.typescript,
         });
+    const webpackResolve = computeWebpackResolve(webpackOptions);
     const webpackConfig = {
         mode: webpackOptions.mode,
         devtool: webpackOptions.mode === "development" ? "eval-source-map" : false,
@@ -221,7 +253,7 @@ const handle = (gruntConfig, targetName, webpackOptions) => {
             eslintPlugin(),
             ...webpackOptions.plugins ?? [],
         ],
-        resolve: webpackOptions.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/grunt/reactapp.js

@@ -103,9 +103,6 @@ const createWatchTasks = (gruntConfig, mergedResults, watchMode) => {
     if (watchMode === false) {
         return;
     }
-    if (mergedResults.watchTasks.length > 0) {
-        (0, util_js_2.insertTask)(gruntConfig, "watch", "options", getWatcherOptions(watchMode));
-    }
     mergedResults.watchTasks.forEach(watchTask => {
         (0, util_js_2.insertTask)(gruntConfig, "watch", getWatchTaskName(watchTask), {
             options: getWatcherOptions(watchMode),

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.2.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"
   },
@@ -53,7 +55,9 @@
     "grunt-contrib-watch": "1.x",
     "grunt-sass": "3.x",
     "grunt-webpack": "5.x",
+    "resolve-typescript-plugin": "^1.1.1",
     "sass": "1.x",
+    "ts-loader": "^9.2.6",
     "winston": "3.x"
   },
   "peerDependenciesMeta": {