@cley_faye/boilerplate 3.21.2 → 4.0.1

package/lib/grunt/reactapp/webpack.js

@@ -25,35 +25,62 @@
  *
  */
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
+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 = exports.webpackLoadersDefault = void 0;
-const path_1 = require("path");
 const node_fs_1 = require("node:fs");
-const eslint_webpack_plugin_1 = __importDefault(require("eslint-webpack-plugin"));
+const path_1 = require("path");
 const webpack_bundle_analyzer_1 = require("webpack-bundle-analyzer");
-const util_js_1 = require("./util.js");
+const util = __importStar(require("./util.js"));
 const defaultCoreJS = 3;
-const eslintPlugin = () => new eslint_webpack_plugin_1.default({ cache: true });
 const defaultLoadersDefine = (options) => [
     "transform-define",
     {
         // eslint-disable-next-line @typescript-eslint/naming-convention
-        "process.env.BUILD_TYPE": options.development
-            ? "development"
-            : "production",
+        "process.env.BUILD_TYPE": options.development ? "development" : "production",
         ...options.defines,
     },
 ];
 const defaultLoadersPresetEnv = (options) => [
     "@babel/preset-env",
     {
-        targets: (options.babel?.targets) ?? "> 2% and not dead, last 2 safari version, last 2 firefox version, last 2 chrome version, last 2 edge version, Firefox ESR",
-        useBuiltIns: "usage",
-        corejs: (options.babel?.corejs) ?? defaultCoreJS,
+        corejs: options.babel?.corejs ?? defaultCoreJS,
         modules: false,
+        targets: options.babel?.targets ??
+            "> 2% and not dead, last 2 safari version, last 2 firefox version, last 2 chrome version, last 2 edge version, Firefox ESR",
+        useBuiltIns: "usage",
     },
 ];
 const defaultLoadersReact = (options) => [
@@ -62,49 +89,20 @@ const defaultLoadersReact = (options) => [
 ];
 /** 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.
  */
 const webpackLoadersDefault = (options) => {
-    const allFilesCheck = options.typescript
-        ? /.(?:js|ts|tsx)$/u
-        : /.js$/u;
+    const allFilesCheck = options.typescript ? /.(?:js|ts|tsx)$/u : /.js$/u;
     const res = [
         {
-            test: allFilesCheck,
             exclude: /node_modules/u,
+            test: allFilesCheck,
             use: {
                 loader: "babel-loader",
                 options: {
                     cacheDirectory: true,
-                    presets: [
-                        defaultLoadersPresetEnv(options),
-                        defaultLoadersReact(options),
-                    ],
-                    plugins: [
-                        defaultLoadersDefine(options),
-                        ...(options.babel?.plugins ?? []),
-                    ],
+                    plugins: [defaultLoadersDefine(options), ...(options.babel?.plugins ?? [])],
+                    presets: [defaultLoadersPresetEnv(options), defaultLoadersReact(options)],
                 },
             },
         },
@@ -112,24 +110,26 @@ const webpackLoadersDefault = (options) => {
     if (options.typescript) {
         const alternativeConfig = "tsconfig-tsloader.json";
         const tsLoader = (0, node_fs_1.existsSync)(alternativeConfig)
-            ? [{
+            ? [
+                {
                     loader: "ts-loader",
                     options: { configFile: alternativeConfig },
-                }]
+                },
+            ]
             : "ts-loader";
         res.push({
+            exclude: /node_modules/u,
             test: /.(?:ts|tsx)$/u,
             use: tsLoader,
-            exclude: /node_modules/u,
         });
     }
     return res;
 };
 exports.webpackLoadersDefault = webpackLoadersDefault;
 const computeWebpackOutput = (webpackOptions, targetName) => webpackOptions.output ?? {
-    path: (0, path_1.resolve)("dist", targetName, "js"),
-    filename: "[name].js",
     chunkFilename: "[name]-[fullhash].js",
+    filename: "[name].js",
+    path: (0, path_1.resolve)("dist", targetName, "js"),
 };
 const lastNamePosition = 2;
 const getHandledFiles = (webpackEntry) => Object.keys(webpackEntry).reduce((acc, cur) => {
@@ -160,135 +160,75 @@ const getWatchTasks = (webpackOptions, targetName) => {
     return [];
 };
 const registerTasks = (gruntConfig, targetName, webpackConfig) => {
-    (0, util_js_1.insertTask)(gruntConfig, "webpack", `${targetName}_watch`, {
+    util.insertTask(gruntConfig, "webpack", `${targetName}_watch`, {
         ...webpackConfig,
         watch: true,
     });
-    return [
-        (0, util_js_1.insertTask)(gruntConfig, "webpack", targetName, webpackConfig),
-    ];
+    return [util.insertTask(gruntConfig, "webpack", targetName, webpackConfig)];
 };
 const computeWebpackResolve = (webpackOptions) => {
     const res = { ...webpackOptions.resolve };
     if (webpackOptions.typescript) {
-        if (res.extensionAlias === undefined) {
-            res.extensionAlias = {};
-        }
+        res.extensionAlias ?? (res.extensionAlias = {});
         res.extensionAlias[".js"] = [".ts", ".tsx", ".js", ".jsx"];
         res.extensionAlias[".mjs"] = [".mts", ".mtsx", ".mjs", ".mjsx"];
     }
     return res;
 };
 const getWebpackPlugins = (webpackOptions) => {
-    const plugins = [
-        eslintPlugin(),
-        ...webpackOptions.plugins ?? [],
-    ];
+    const plugins = [...(webpackOptions.plugins ?? [])];
     if (webpackOptions.generateReport) {
         plugins.push(new webpack_bundle_analyzer_1.BundleAnalyzerPlugin({
             analyzerMode: "static",
-            reportFilename: (0, path_1.join)(process.cwd(), "bundle_report.html"),
             openAnalyzer: false,
+            reportFilename: (0, path_1.join)(process.cwd(), "bundle_report.html"),
         }));
     }
     return plugins;
 };
 /** 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 gruntConfig - Grunt configuration to add the task to
  *
- * @param [webpackOptions.babelPlugins]
- * List of extra babel plugins.
+ * @param targetName - Name of the target for the image minification task.
  *
- * @param [webpackOptions.mode]
- * Build mode. "development", "production" or "none".
- * Defaults to "development"
+ * @param webpackOptions - Options for the webpack task configuration.
  *
- * @param [webpackOptions.generateReport]
- * Generate a bundle report HTML file.
- *
- * @param [webpackOptions.typescript]
- * Allow loading typescript source for webpack/babel.
- *
- * @return
+ * @returns
  * List of tasks added.
  * This function add "webpack:<targetName>".
  */
 const handle = (gruntConfig, targetName, webpackOptions) => {
-    const webpackEntry = webpackOptions.entry
-        ?? { [targetName]: (0, path_1.join)("webres", targetName, "js", "loader.js") };
+    const webpackEntry = webpackOptions.entry ?? {
+        [targetName]: (0, path_1.join)("webres", targetName, "js", "loader.js"),
+    };
     const handledFiles = getHandledFiles(webpackEntry);
     const webpackOutput = computeWebpackOutput(webpackOptions, targetName);
-    const webpackLoaders = webpackOptions.loaders
-        ?? (0, exports.webpackLoadersDefault)({
-            development: webpackOptions.mode === "development",
-            defines: webpackOptions.defines,
+    const webpackLoaders = webpackOptions.loaders ??
+        (0, exports.webpackLoadersDefault)({
             babel: { plugins: webpackOptions.babelPlugins },
+            defines: webpackOptions.defines,
+            development: webpackOptions.mode === "development",
             typescript: webpackOptions.typescript,
         });
     const webpackResolve = computeWebpackResolve(webpackOptions);
     const webpackConfig = {
-        mode: webpackOptions.mode,
         devtool: webpackOptions.mode === "development" ? "eval-source-map" : false,
         entry: webpackEntry,
-        output: webpackOutput,
         externals: webpackOptions.externals,
+        mode: webpackOptions.mode,
         module: { rules: webpackLoaders },
+        output: webpackOutput,
         plugins: getWebpackPlugins(webpackOptions),
         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.
     if (webpackOptions.options) {
-        (0, util_js_1.insertTask)(gruntConfig, "webpack", "options", webpackOptions.options);
+        util.insertTask(gruntConfig, "webpack", "options", webpackOptions.options);
     }
     const requiredTasks = registerTasks(gruntConfig, targetName, webpackConfig);
     const watchTasks = getWatchTasks(webpackOptions, targetName);
-    return {
-        requiredTasks,
-        handledFiles,
-        watchTasks,
-    };
+    return { handledFiles, requiredTasks, watchTasks, };
 };
 exports.handle = handle;

package/lib/grunt/reactapp.d.ts

@@ -1,11 +1,10 @@
-/// <reference types="grunt" />
-import { BaseOptions } from "./util.js";
-import { PugOptions } from "./reactapp/pug.js";
-import { ImageOptions } from "./reactapp/image.js";
-import { WebpackOptions } from "./reactapp/webpack.js";
-import { SassOptions } from "./reactapp/sass.js";
-import { CopyOptions } from "./reactapp/copy.js";
-import { GruntConfig } from "./reactapp/util.js";
+import * as reactAppCopy from "./reactapp/copy.js";
+import * as reactAppImage from "./reactapp/image.js";
+import * as reactAppPug from "./reactapp/pug.js";
+import * as reactAppSass from "./reactapp/sass.js";
+import * as reactAppUtil from "./reactapp/util.js";
+import * as reactAppWebpack from "./reactapp/webpack.js";
+import * as util from "./util.js";
 export declare enum HandlerType {
     PUG = "pug",
     IMAGE = "image",
@@ -14,11 +13,11 @@ export declare enum HandlerType {
     COPY = "copy"
 }
 export interface ReactAppOptions {
-    [HandlerType.PUG]?: PugOptions;
-    [HandlerType.IMAGE]?: ImageOptions;
-    [HandlerType.WEBPACK]?: WebpackOptions;
-    [HandlerType.SASS]?: SassOptions;
-    [HandlerType.COPY]?: CopyOptions;
+    [HandlerType.PUG]?: reactAppPug.PugOptions;
+    [HandlerType.IMAGE]?: reactAppImage.ImageOptions;
+    [HandlerType.WEBPACK]?: reactAppWebpack.WebpackOptions;
+    [HandlerType.SASS]?: reactAppSass.SassOptions;
+    [HandlerType.COPY]?: reactAppCopy.CopyOptions;
     watch?: number | boolean;
 }
 export interface WatchTaskDef {
@@ -31,7 +30,7 @@ export interface HandlerFunctionResult {
     handledFiles: Array<string>;
     watchTasks: Array<WatchTaskDef>;
 }
-export type HandlerFunction = (gruntConfig: GruntConfig, targetName: string, options: BaseOptions) => HandlerFunctionResult;
+export type HandlerFunction = (gruntConfig: reactAppUtil.GruntConfig, targetName: string, options: util.BaseOptions) => HandlerFunctionResult;
 /** Insert necessary build step for a React/Web app.
  *
  * This function will add the following Grunt tasks:
@@ -42,73 +41,31 @@ export type HandlerFunction = (gruntConfig: GruntConfig, targetName: string, opt
  * - "sass:<targetName>": compile sass/scss files
  * - "copy:<targetName>": copy files not handled in other tasks
  *
- * @param gruntConfig
- * The Grunt configuration with other tasks, before it is passed to
+ * @param gruntConfig - The Grunt configuration with other tasks, before it is passed to
  * grunt.initConfig()
  *
- * @param [targetName]
- * Name for the various targets added to Grunt. Defaults to "reactApp"
+ * @param targetName - Name for the various targets added to Grunt. Defaults to "reactApp"
  *
- * @param [options]
- * Options to control the extra tasks
+ * @param options - Options to control the extra tasks
  *
- * @param [options.pug]
- * Options for the pug task. See pug.js for details.
- *
- * @param [options.pug.disabled]
- * Do not generate pug task
- *
- * @param [options.image]
- * Options for the image task. See image.js for details.
- *
- * @param [options.image.disabled]
- * Do not generate image task
- *
- * @param [options.webpack]
- * Options for the webpack task. See webpack.js for details.
- *
- * @param [options.webpack.disabled]
- * Do not generate webpack task
- *
- * @param [options.sass]
- * Options for the sass task. See sass.js for details.
- *
- * @param [options.sass.disabled]
- * Do not generate sass task
- *
- * @param [options.copy]
- * Optiosn for the copy task. See copy.js for details.
- *
- * @param [options.copy.disabled]
- * Do not generate copy task
- *
- * @return
+ * @returns
  * List of tasks to build the application
  */
-export declare const reactApp: (gruntConfig: GruntConfig, targetName?: string, options?: ReactAppOptions) => Array<string>;
+export declare const reactApp: (gruntConfig: reactAppUtil.GruntConfig, targetName?: string, options?: ReactAppOptions) => Array<string>;
 export interface HelperOptions {
     production?: boolean;
     watch?: boolean | number;
 }
 /** Helper for common options shared across multiple tasks.
  *
- * @param [helperOptions]
- * Options shared by multiple tasks
- *
- * @param [helperOptions.production]
- * Make a production build.
- * - set outputStyle and sourceMap for sass
- * - set pretty for pug
- * - add a "productionBuild" property in pug data
- * - set mode for webpack
+ * @param helperOptions - Options shared by multiple tasks
  *
- * @param [options]
- * Initial options for reactApp().
+ * @param options - Initial options for reactApp().
  * This object will be copied and required parameters will be added by this
  * function.
  * Modified object are also duplicated, so no original data is modified.
  *
- * @return
+ * @returns
  * A configuration object for reactApp().
  */
 export declare const reactAppOptionsHelper: (helperOptions: HelperOptions, options: ReactAppOptions) => ReactAppOptions;
@@ -117,4 +74,4 @@ export declare const reactAppOptionsHelper: (helperOptions: HelperOptions, optio
  *
  * Must be called before any other `grunt.registerTask()`
  */
-export declare const reactAppDynamicTasks: (grunt: grunt.task.CommonTaskModule, gruntConfig: GruntConfig) => void;
+export declare const reactAppDynamicTasks: (grunt: grunt.task.CommonTaskModule, gruntConfig: reactAppUtil.GruntConfig) => void;