@cley_faye/boilerplate 3.21.2 → 4.0.1

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

@@ -1,6 +1,6 @@
-import { BaseOptions } from "../util.js";
-import { HandlerFunctionResult } from "../reactapp.js";
-import { GruntConfig } from "./util.js";
+import { type HandlerFunctionResult } from "../reactapp.js";
+import { type BaseOptions } from "../util.js";
+import * as util from "./util.js";
 interface SassOptionsOptions {
     implementation?: Record<string, unknown>;
 }
@@ -12,35 +12,14 @@ export interface SassOptions extends BaseOptions {
 }
 /** Add an sass processing task to the Grunt configuration
  *
- * @param gruntConfig
- * Grunt configuration to add the task to
+ * @param gruntConfig - Grunt configuration to add the task to
  *
- * @param targetName
- * Name of the target for the image minification task.
+ * @param targetName - Name of the target for the image minification task.
  *
- * @param sassOptions
- * Options for the sass task configuration.
+ * @param sassOptions - Options for the sass task configuration.
  *
- * @param sassOptions.options
- * Options to pass to grunt-sass.
- *
- * @param [sassOptions.options.implementation]
- * Implementation to use. Defaults to require("sass").
- *
- * @param [sassOptions.sourcePath]
- * Path where the pug templates can be found. Subdirectories will be searched.
- * Default to "webres/<targetName>"
- *
- * @param [sassOptions.outputPath]
- * Path to put the output files into. The source directory tree will be
- * preserved.
- * Defaults to "dist/<targetName>"
- *
- * @param [sassOptions.fileSuffix]
- * Output files suffix. Defaults to ".css"
- *
- * @return
+ * @returns
  * List of tasks added to the grunt configuration
  */
-export declare const handle: (gruntConfig: GruntConfig, targetName: string, sassOptions: SassOptions) => HandlerFunctionResult;
+export declare const handle: (gruntConfig: util.GruntConfig, targetName: string, sassOptions: SassOptions) => HandlerFunctionResult;
 export {};

package/lib/grunt/reactapp/sass.js

@@ -25,80 +25,85 @@
  *
  */
 "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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handle = void 0;
 const path_1 = require("path");
-const util_js_1 = require("./util.js");
+const util = __importStar(require("./util.js"));
 /** File extensions handled by this task */
-const handledExtensions = [
-    ".scss",
-    ".sass",
-];
+const handledExtensions = [".scss", ".sass"];
 /** Add an sass processing task to the Grunt configuration
  *
- * @param gruntConfig
- * Grunt configuration to add the task to
- *
- * @param targetName
- * Name of the target for the image minification task.
- *
- * @param sassOptions
- * Options for the sass task configuration.
- *
- * @param sassOptions.options
- * Options to pass to grunt-sass.
- *
- * @param [sassOptions.options.implementation]
- * Implementation to use. Defaults to require("sass").
+ * @param gruntConfig - Grunt configuration to add the task to
  *
- * @param [sassOptions.sourcePath]
- * Path where the pug templates can be found. Subdirectories will be searched.
- * Default to "webres/<targetName>"
+ * @param targetName - Name of the target for the image minification task.
  *
- * @param [sassOptions.outputPath]
- * Path to put the output files into. The source directory tree will be
- * preserved.
- * Defaults to "dist/<targetName>"
+ * @param sassOptions - Options for the sass task configuration.
  *
- * @param [sassOptions.fileSuffix]
- * Output files suffix. Defaults to ".css"
- *
- * @return
+ * @returns
  * List of tasks added to the grunt configuration
  */
 const handle = (gruntConfig, targetName, sassOptions) => {
     const handledFiles = [
-        ...handledExtensions.map(ext => `**/*${ext}`),
-        ...handledExtensions.map(ext => `!**/_*${ext}`),
-        ...handledExtensions.map(ext => `!**/*.inc${ext}`),
+        ...handledExtensions.map((ext) => `**/*${ext}`),
+        ...handledExtensions.map((ext) => `!**/_*${ext}`),
+        ...handledExtensions.map((ext) => `!**/*.inc${ext}`),
     ];
     const sassTask = {
         options: { ...sassOptions.options },
         files: [
             {
-                expand: true,
                 cwd: sassOptions.sourcePath ?? (0, path_1.join)("webres", targetName),
-                src: handledFiles,
                 dest: sassOptions.outputPath ?? (0, path_1.join)("dist", targetName),
+                expand: true,
                 ext: sassOptions.fileSuffix ?? ".css",
+                src: handledFiles,
             },
         ],
     };
     if (sassTask.options.implementation === undefined) {
-        // eslint-disable-next-line @typescript-eslint/no-require-imports, global-require, @typescript-eslint/no-var-requires
+        // eslint-disable-next-line @typescript-eslint/no-require-imports
         sassTask.options.implementation = require("sass");
     }
-    const requiredTasks = [(0, util_js_1.insertTask)(gruntConfig, "sass", targetName, sassTask)];
+    const requiredTasks = [util.insertTask(gruntConfig, "sass", targetName, sassTask)];
     const watchTasks = [
         {
-            filesToWatch: [...handledExtensions.map(ext => `**/*${ext}`)],
+            filesToWatch: [...handledExtensions.map((ext) => `**/*${ext}`)],
             taskToRun: requiredTasks[0],
         },
     ];
-    return {
-        requiredTasks,
-        handledFiles,
-        watchTasks,
-    };
+    return { handledFiles, requiredTasks, watchTasks };
 };
 exports.handle = handle;

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

@@ -2,19 +2,15 @@ export type DynamicTaskFunc = () => Promise<void>;
 export type GruntConfig = Record<string, Record<string, Record<string, unknown> | (() => void) | undefined>>;
 /** Insert a new task in a grunt config object.
  *
- * @param gruntConfig
- * The grunt configuration, before sending it to initConfig()
+ * @param gruntConfig - The grunt configuration, before sending it to initConfig()
  *
- * @param taskType
- * The task type name (first level of grunt config object)
+ * @param taskType - The task type name (first level of grunt config object)
  *
- * @param taskName
- * The task name under a givne type (second level of grunt config object)
+ * @param taskName - The task name under a givne type (second level of grunt config object)
  *
- * @param taskDef
- * The task definition to insert
+ * @param taskDef - The task definition to insert
  *
- * @return
+ * @returns
  * The task full name to reference in registerTask()
  */
 export declare const insertTask: (gruntConfig: GruntConfig, taskType: string, taskName: string, taskDef: Record<string, unknown>) => string;

package/lib/grunt/reactapp/util.js

@@ -29,25 +29,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.insertDynamicTask = exports.dynamicKey = exports.insertTask = void 0;
 /** Insert a new task in a grunt config object.
  *
- * @param gruntConfig
- * The grunt configuration, before sending it to initConfig()
+ * @param gruntConfig - The grunt configuration, before sending it to initConfig()
  *
- * @param taskType
- * The task type name (first level of grunt config object)
+ * @param taskType - The task type name (first level of grunt config object)
  *
- * @param taskName
- * The task name under a givne type (second level of grunt config object)
+ * @param taskName - The task name under a givne type (second level of grunt config object)
  *
- * @param taskDef
- * The task definition to insert
+ * @param taskDef - The task definition to insert
  *
- * @return
+ * @returns
  * The task full name to reference in registerTask()
  */
 const insertTask = (gruntConfig, taskType, taskName, taskDef) => {
-    if (!(taskType in gruntConfig)) {
+    if (!(taskType in gruntConfig))
         gruntConfig[taskType] = {};
-    }
     const taskFullName = `${taskType}:${taskName}`;
     if (gruntConfig[taskType][taskName] !== undefined) {
         throw new Error(`Grunt task ${taskFullName} already defined`);
@@ -58,14 +53,16 @@ const insertTask = (gruntConfig, taskType, taskName, taskDef) => {
 exports.insertTask = insertTask;
 exports.dynamicKey = "_dynamic";
 const insertDynamicTask = (gruntConfig, taskType, taskName, task) => {
-    if (!(exports.dynamicKey in gruntConfig)) {
+    if (!(exports.dynamicKey in gruntConfig))
         gruntConfig[exports.dynamicKey] = {};
-    }
     const taskFullName = `${taskType}_${taskName}`;
     gruntConfig[exports.dynamicKey][taskFullName] = function dynamicTask() {
         const done = this.async();
-        task().then(() => done())
-            .catch(e => done(e));
+        task()
+            // eslint-disable-next-line promise/prefer-await-to-then, promise/no-callback-in-promise
+            .then(() => done())
+            // eslint-disable-next-line promise/prefer-await-to-then, promise/no-callback-in-promise
+            .catch((e) => done(e));
     };
     return taskFullName;
 };

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

@@ -1,7 +1,7 @@
-import { ResolveOptions } from "webpack";
-import { BaseOptions } from "../util.js";
-import { HandlerFunctionResult } from "../reactapp.js";
-import { GruntConfig } from "./util.js";
+import { type ResolveOptions } from "webpack";
+import { type BaseOptions } from "../util.js";
+import * as util from "./util.js";
+import type * as reactApp from "../reactapp.js";
 export interface WebpackLoadersOptions {
     development?: boolean;
     defines?: Record<string, string>;
@@ -14,28 +14,7 @@ export interface WebpackLoadersOptions {
 }
 /** Build the default webpack loaders list.
  *
- * Uses babel and eslint. Some options can be customized here.
- *
- * @param [options]
- * @param [options.development]
- * true for development-friendly options, false for production options
- *
- * @param [options.defines]
- * List of defines to set using Babel transform-define
- *
- * @param [options.babel]
- * @param [options.babel.corejs]
- * Version of core-js to use (default to 3)
- *
- * @param [options.babel.targets]
- * Browser targets (default to "> 2% and not dead, last 2 safari version, last 2 firefox version,
- * last 2 chrome version, last 2 edge version, Firefox ESR")
- *
- * @param [options.babel.plugins]
- * Plugins to add to babel
- *
- * @param [options.typescript]
- * Add support for importing .ts and .tsx files
+ * Uses babel. Some options can be customized here.
  */
 export declare const webpackLoadersDefault: (options: WebpackLoadersOptions) => Array<Record<string, unknown>>;
 export interface WebpackOptions extends BaseOptions {
@@ -57,64 +36,14 @@ export interface WebpackOptions extends BaseOptions {
 }
 /** Add a webpack task for the reactApp recipe
  *
- * @param gruntConfig
- * Grunt configuration to add the task to
- *
- * @param targetName
- * Name of the target for the image minification task.
- *
- * @param webpackOptions
- * Options for the webpack task configuration.
- *
- * @param [webpackOptions.options]
- * Options for webpack
- *
- * @param [webpackOptions.entry]
- * List of entrypoints.
- * Defaults to {targetName: "webres/<targetName>/js/loader.js"}
- *
- * @param [webpackOptions.externals]
- * List of external libraries.
- * Defaults to {}.
- *
- * @param [webpackOptions.output]
- * Configure webpack output location and name.
- * Defaults to {path: "dist/<targetName>/js", filename: "[name].js"}
- *
- * @param [webpackOptions.output.path]
- * Path to put the compiled files into.
- * It is possible to pass a completely different object as webpackOptions.output
- * than expected, it will be handed to webpack as-is.
- *
- * @param [webpackOptions.output.filename]
- * Template for output filename.
- * It is possible to pass a completely different object as webpackOptions.output
- * than expected, it will be handed to webpack as-is.
- *
- * @param [webpackOptions.loaders]
- * Configuration for webpack loaders. See webpack doc about module.rules.
- * Defaults to using babel with React configuration and eslint.
- * To customize the default behavior build an object with
- * webpackLoadersDefault().
- *
- * @param [webpackOptions.plugins]
- * Configuration for webpack plugins. See webpack doc about plugins.
- *
- * @param [webpackOptions.babelPlugins]
- * List of extra babel plugins.
- *
- * @param [webpackOptions.mode]
- * Build mode. "development", "production" or "none".
- * Defaults to "development"
+ * @param gruntConfig - Grunt configuration to add the task to
  *
- * @param [webpackOptions.generateReport]
- * Generate a bundle report HTML file.
+ * @param targetName - Name of the target for the image minification task.
  *
- * @param [webpackOptions.typescript]
- * Allow loading typescript source for webpack/babel.
+ * @param webpackOptions - Options for the webpack task configuration.
  *
- * @return
+ * @returns
  * List of tasks added.
  * This function add "webpack:<targetName>".
  */
-export declare const handle: (gruntConfig: GruntConfig, targetName: string, webpackOptions: WebpackOptions) => HandlerFunctionResult;
+export declare const handle: (gruntConfig: util.GruntConfig, targetName: string, webpackOptions: WebpackOptions) => reactApp.HandlerFunctionResult;