@cley_faye/boilerplate 3.1.0 → 3.2.2

package/README.md

@@ -27,12 +27,11 @@ For webapp building:
 - babel-plugin-transform-define
 - core-js
 - @babel/plugin-transform-runtime
-- @keeex/grunt-contrib-imagemin
 - grunt-contrib-pug
 - grunt-contrib-copy
 - grunt-contrib-watch
 - grunt-sass
-- node-sass
+- sass
 - grunt-webpack
 - grunt
 
@@ -155,6 +154,7 @@ The webpack options support a host of properties:
 - babelPlugins: array of plugins for Babel
 - mode: The build mode. "development", "production" or "none"
 - defines: a record of value to define using Babel transform-define
+- resolve: a custom "resolve" object for webpack config
 
 ### SASS
 All `.sass` and `.scss` files in the webapp directory will be processed as `.css` files in the
@@ -200,7 +200,7 @@ module.exports = grunt => {
     )
   );
   grunt.initConfig(baseGruntConfig);
-  grunt.register(
+  grunt.registerTask(
     "myWebApp",
     "Build the webapp",
     requiredTasks

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/image.d.ts

@@ -18,10 +18,10 @@ export interface ImageOptions extends BaseOptions {
  * Options for the image task configuration.
  *
  * @param [imageOptions.options]
- * Options to pass to grunt-contrib-imagemin.
+ * Options to pass to @cley_faye/imagemin-lite.
  *
  * @param [imageOptions.sourcePath]
- * Path where the pug templates can be found. Subdirectories will be searched.
+ * Path where the source images can be found. Subdirectories will be searched.
  * Default to "webres/<targetName>"
  *
  * @param [imageOptions.outputPath]

package/lib/grunt/reactapp/image.js

@@ -47,10 +47,10 @@ const handledExtensions = [
  * Options for the image task configuration.
  *
  * @param [imageOptions.options]
- * Options to pass to grunt-contrib-imagemin.
+ * Options to pass to @cley_faye/imagemin-lite.
  *
  * @param [imageOptions.sourcePath]
- * Path where the pug templates can be found. Subdirectories will be searched.
+ * Path where the source images can be found. Subdirectories will be searched.
  * Default to "webres/<targetName>"
  *
  * @param [imageOptions.outputPath]
@@ -63,6 +63,7 @@ const handledExtensions = [
  */
 const handle = (gruntConfig, targetName, imageOptions) => {
     const handledFiles = handledExtensions.map(ext => `**/*${ext}`);
+    // TODO use @cley_faye/imagemin-lite once it exists
     const newImageTask = {
         options: imageOptions.options,
         files: [
@@ -75,7 +76,7 @@ const handle = (gruntConfig, targetName, imageOptions) => {
         ],
     };
     const requiredTasks = [
-        (0, util_js_1.insertTask)(gruntConfig, "imagemin", targetName, newImageTask),
+        (0, util_js_1.insertTask)(gruntConfig, "copy", `${targetName}_image`, newImageTask),
     ];
     const watchTasks = [
         {

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

@@ -45,6 +45,7 @@ export interface WebpackOptions extends BaseOptions {
     plugins?: Array<Record<string, unknown>>;
     babelPlugins?: Array<Record<string, unknown>>;
     defines?: Record<string, string>;
+    resolve?: unknown;
 }
 /** Add a webpack task for the reactApp recipe
  *

package/lib/grunt/reactapp/webpack.js

@@ -221,6 +221,7 @@ const handle = (gruntConfig, targetName, webpackOptions) => {
             eslintPlugin(),
             ...webpackOptions.plugins ?? [],
         ],
+        resolve: webpackOptions.resolve,
     };
     // 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cley_faye/boilerplate",
-  "version": "3.1.0",
+  "version": "3.2.2",
   "description": "Boilerplate code generator for generic projects",
   "repository": {
     "type": "git",
@@ -17,15 +17,15 @@
   },
   "homepage": "https://github.com/CleyFaye/boilerplate#readme",
   "devDependencies": {
-    "@keeex/eslint-config": "^1.4.3",
+    "@keeex/eslint-config": "^1.5.9",
     "@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": "^4.15.0",
-    "@typescript-eslint/parser": "^4.15.0",
+    "@typescript-eslint/eslint-plugin": "^5.3.1",
+    "@typescript-eslint/parser": "^5.3.1",
     "eslint": "^7.20.0",
-    "eslint-plugin-promise": "^5.1.0",
+    "eslint-plugin-promise": "^5.1.1",
     "eslint-webpack-plugin": "^3.0.1",
     "express-winston": "^4.0.5",
     "grunt": "^1.4.1",
@@ -49,11 +49,10 @@
     "express-winston": "4.x",
     "grunt": "1.x",
     "grunt-contrib-copy": "1.x",
-    "@keeex/grunt-contrib-imagemin": "4.x",
     "grunt-contrib-pug": "3.x",
     "grunt-contrib-watch": "1.x",
     "grunt-sass": "3.x",
-    "grunt-webpack": "4.x",
+    "grunt-webpack": "5.x",
     "sass": "1.x",
     "winston": "3.x"
   },
@@ -79,9 +78,6 @@
     "grunt-contrib-pug": {
       "optional": true
     },
-    "grunt-contrib-imagemin": {
-      "optional": true
-    },
     "@babel/plugin-transform-runtime": {
       "optional": true
     },