@workleap/webpack-configs 1.0.3 → 1.0.5

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @workleap/webpack-configs
 
+## 1.0.5
+
+### Patch Changes
+
+- [#131](https://github.com/gsoft-inc/wl-web-configs/pull/131) [`11bb287`](https://github.com/gsoft-inc/wl-web-configs/commit/11bb287847b4f525faa83abd23e46c56f58e41f4) Thanks [@patricklafrance](https://github.com/patricklafrance)! - Added a default key to exports
+
+## 1.0.4
+
+### Patch Changes
+
+- [#127](https://github.com/gsoft-inc/wl-web-configs/pull/127) [`f440b12`](https://github.com/gsoft-inc/wl-web-configs/commit/f440b1251e2b3c1960dfc7f68bd090f573ec67d6) Thanks [@patricklafrance](https://github.com/patricklafrance)! - Fix environment variables
+
 ## 1.0.3
 
 ### Patch Changes

package/dist/build.d.ts

@@ -15,13 +15,13 @@ interface DefineBuildConfigOptions {
     cacheDirectory?: string;
     moduleRules?: NonNullable<Configuration["module"]>["rules"];
     plugins?: Configuration["plugins"];
-    htmlWebpackPlugin?: false | HtmlWebpackPlugin.Options;
+    htmlWebpackPlugin?: boolean | HtmlWebpackPlugin.Options;
     miniCssExtractPluginOptions?: MiniCssExtractPluginOptions;
     minify?: boolean;
     cssModules?: boolean;
-    environmentVariables?: Record<string, string | undefined>;
+    environmentVariables?: Record<string, unknown>;
     transformers?: WebpackConfigTransformer[];
-    profile?: boolean;
+    verbose?: boolean;
 }
 declare function defineBuildConfig(swcConfig: Config, options?: DefineBuildConfigOptions): Configuration;
 

package/dist/build.js

@@ -1,2 +1,3 @@
-export { defineBuildConfig, defineBuildHtmlWebpackPluginConfig, defineMiniCssExtractPluginConfig } from './chunk-2Q5IGCCY.js';
-import './chunk-EF2WO5MC.js';
+export { defineBuildConfig, defineBuildHtmlWebpackPluginConfig, defineMiniCssExtractPluginConfig } from './chunk-GFNG2PBM.js';
+import './chunk-P2Z3EEVF.js';
+import './chunk-QJI26K46.js';

package/dist/{chunk-2Q5IGCCY.js → chunk-GFNG2PBM.js}

@@ -1,4 +1,5 @@
-import { applyTransformers } from './chunk-EF2WO5MC.js';
+import { isObject } from './chunk-P2Z3EEVF.js';
+import { applyTransformers } from './chunk-QJI26K46.js';
 import HtmlWebpackPlugin from 'html-webpack-plugin';
 import MiniCssExtractPlugin from 'mini-css-extract-plugin';
 import { createRequire } from 'node:module';
@@ -29,7 +30,15 @@ function defineMiniCssExtractPluginConfig(options = {}) {
     filename
   };
 }
+function preflight(options) {
+  if (options.publicPath) {
+    if (!options.publicPath.endsWith("/")) {
+      throw new Error('[webpack-configs] The "publicPath" must end with a "/".');
+    }
+  }
+}
 function defineBuildConfig(swcConfig, options = {}) {
+  preflight(options);
   const {
     entry = path.resolve("./src/index.tsx"),
     outputPath = path.resolve("dist"),
@@ -47,7 +56,7 @@ function defineBuildConfig(swcConfig, options = {}) {
     // "process.env" is always available.
     environmentVariables = {},
     transformers = [],
-    profile = false
+    verbose = false
   } = options;
   const config = {
     mode: "production",
@@ -99,7 +108,7 @@ function defineBuildConfig(swcConfig, options = {}) {
         })
       ]
     } : void 0,
-    infrastructureLogging: profile ? {
+    infrastructureLogging: verbose ? {
       appendOnly: true,
       level: "verbose",
       debug: /PackFileCache/
@@ -155,18 +164,23 @@ function defineBuildConfig(swcConfig, options = {}) {
       }
     },
     plugins: [
-      htmlWebpackPlugin && new HtmlWebpackPlugin(htmlWebpackPlugin),
+      htmlWebpackPlugin && new HtmlWebpackPlugin(isObject(htmlWebpackPlugin) ? htmlWebpackPlugin : defineBuildHtmlWebpackPluginConfig()),
       new MiniCssExtractPlugin(miniCssExtractPluginOptions),
+      // Stringify the environment variables because the plugin does a direct text replacement. Otherwise, "production" would become production
+      // after replacement and cause an undefined var error because the production var doesn't exist.
+      // For more information, view: https://webpack.js.org/plugins/define-plugin.
       new DefinePlugin({
-        // Webpack automatically stringify object literals.
-        "process.env": environmentVariables
+        "process.env": Object.keys(environmentVariables).reduce((acc, key) => {
+          acc[key] = JSON.stringify(environmentVariables[key]);
+          return acc;
+        }, {})
       }),
       ...plugins
     ].filter(Boolean)
   };
   const transformedConfig = applyTransformers(config, transformers, {
     environment: "build",
-    profile
+    verbose
   });
   return transformedConfig;
 }

package/dist/{chunk-EYIS42GE.js → chunk-JJEPV2N2.js}

@@ -1,5 +1,5 @@
 import { isObject } from './chunk-P2Z3EEVF.js';
-import { applyTransformers } from './chunk-EF2WO5MC.js';
+import { applyTransformers } from './chunk-QJI26K46.js';
 import ReactRefreshWebpackPlugin from '@pmmmwh/react-refresh-webpack-plugin';
 import HtmlWebpackPlugin from 'html-webpack-plugin';
 import { createRequire } from 'node:module';
@@ -23,15 +23,10 @@ function defineDevHtmlWebpackPluginConfig(options = {}) {
 function defineFastRefreshPluginConfig(options = {}) {
   return options;
 }
-function preflight(options) {
+function preflight() {
   if (!require2.resolve("webpack-dev-server")) {
     throw new Error('[webpack-configs] To use the "dev" config, install https://www.npmjs.com/package/webpack-dev-server as a "devDependency".');
   }
-  if (options.fastRefresh) {
-    if (!require2.resolve("@pmmmwh/react-refresh-webpack-plugin")) {
-      throw new Error('[webpack-configs] To use Webpack Fast Refresh, install https://www.npmjs.com/package/@pmmmwh/react-refresh-webpack-plugin as a "devDependency".');
-    }
-  }
 }
 function trySetSwcFastRefresh(config, enabled) {
   if (config?.jsc?.transform?.react) {
@@ -40,7 +35,7 @@ function trySetSwcFastRefresh(config, enabled) {
   return config;
 }
 function defineDevConfig(swcConfig, options = {}) {
-  preflight(options);
+  preflight();
   const {
     entry = path.resolve("./src/index.tsx"),
     https = false,
@@ -57,7 +52,7 @@ function defineDevConfig(swcConfig, options = {}) {
     // "process.env" is always available.
     environmentVariables = {},
     transformers = [],
-    profile = false
+    verbose = false
   } = options;
   const config = {
     mode: "development",
@@ -115,7 +110,7 @@ function defineDevConfig(swcConfig, options = {}) {
       removeEmptyChunks: false,
       splitChunks: false
     },
-    infrastructureLogging: profile ? {
+    infrastructureLogging: verbose ? {
       appendOnly: true,
       level: "verbose",
       debug: /PackFileCache/
@@ -171,10 +166,15 @@ function defineDevConfig(swcConfig, options = {}) {
       }
     },
     plugins: [
-      htmlWebpackPlugin && new HtmlWebpackPlugin(htmlWebpackPlugin),
+      htmlWebpackPlugin && new HtmlWebpackPlugin(isObject(htmlWebpackPlugin) ? htmlWebpackPlugin : defineDevHtmlWebpackPluginConfig()),
+      // Stringify the environment variables because the plugin does a direct text replacement. Otherwise, "production" would become production
+      // after replacement and cause an undefined var error.
+      // For more information, view: https://webpack.js.org/plugins/define-plugin/.
       new DefinePlugin({
-        // Webpack automatically stringify object literals.
-        "process.env": environmentVariables
+        "process.env": Object.keys(environmentVariables).reduce((acc, key) => {
+          acc[key] = JSON.stringify(environmentVariables[key]);
+          return acc;
+        }, {})
       }),
       fastRefresh && new ReactRefreshWebpackPlugin(isObject(fastRefresh) ? fastRefresh : defineFastRefreshPluginConfig()),
       ...plugins
@@ -182,7 +182,7 @@ function defineDevConfig(swcConfig, options = {}) {
   };
   const transformedConfig = applyTransformers(config, transformers, {
     environment: "dev",
-    profile
+    verbose
   });
   return transformedConfig;
 }

package/dist/{chunk-EF2WO5MC.js → chunk-QJI26K46.js}

@@ -6,7 +6,7 @@ function applyTransformers(config, transformers, context) {
     count += 1;
     return acc;
   }, config);
-  if (context.profile) {
+  if (context.verbose) {
     if (count > 0) {
       console.log(`[webpack-configs] Applied ${count} configuration transformers.`);
     }

package/dist/dev.d.ts

@@ -15,12 +15,12 @@ interface DefineDevConfigOptions {
     cacheDirectory?: string;
     moduleRules?: NonNullable<Configuration["module"]>["rules"];
     plugins?: Configuration["plugins"];
-    htmlWebpackPlugin?: false | HtmlWebpackPlugin.Options;
+    htmlWebpackPlugin?: boolean | HtmlWebpackPlugin.Options;
     fastRefresh?: boolean | ReactRefreshPluginOptions;
     cssModules?: boolean;
-    environmentVariables?: Record<string, string | undefined>;
+    environmentVariables?: Record<string, unknown>;
     transformers?: WebpackConfigTransformer[];
-    profile?: boolean;
+    verbose?: boolean;
 }
 declare function defineDevConfig(swcConfig: Config, options?: DefineDevConfigOptions): Configuration;
 

package/dist/dev.js

@@ -1,3 +1,3 @@
-export { defineDevConfig, defineDevHtmlWebpackPluginConfig, defineFastRefreshPluginConfig } from './chunk-EYIS42GE.js';
+export { defineDevConfig, defineDevHtmlWebpackPluginConfig, defineFastRefreshPluginConfig } from './chunk-JJEPV2N2.js';
 import './chunk-P2Z3EEVF.js';
-import './chunk-EF2WO5MC.js';
+import './chunk-QJI26K46.js';

package/dist/index.js

@@ -1,6 +1,6 @@
-export { defineBuildConfig, defineBuildHtmlWebpackPluginConfig, defineMiniCssExtractPluginConfig } from './chunk-2Q5IGCCY.js';
-export { defineDevConfig, defineDevHtmlWebpackPluginConfig, defineFastRefreshPluginConfig } from './chunk-EYIS42GE.js';
+export { defineBuildConfig, defineBuildHtmlWebpackPluginConfig, defineMiniCssExtractPluginConfig } from './chunk-GFNG2PBM.js';
+export { defineDevConfig, defineDevHtmlWebpackPluginConfig, defineFastRefreshPluginConfig } from './chunk-JJEPV2N2.js';
 import './chunk-P2Z3EEVF.js';
-import './chunk-EF2WO5MC.js';
+import './chunk-QJI26K46.js';
 export { addAfterModuleRule, addBeforeModuleRule, findModuleRule, findModuleRules, matchAssetModuleType, matchLoaderName, matchTest, removeModuleRules, replaceModuleRule } from './chunk-34O5ZLZ6.js';
 export { addAfterPlugin, addBeforePlugin, findPlugin, matchConstructorName, removePlugin, replacePlugin } from './chunk-JPURRV2F.js';

package/dist/transformers/applyTransformers.d.ts

@@ -2,7 +2,7 @@ import { Configuration } from 'webpack';
 
 interface WebpackConfigTransformerContext {
     environment: "dev" | "build";
-    profile: boolean;
+    verbose: boolean;
 }
 type WebpackConfigTransformer = (config: Configuration, context: WebpackConfigTransformerContext) => Configuration;
 declare function applyTransformers(config: Configuration, transformers: WebpackConfigTransformer[], context: WebpackConfigTransformerContext): Configuration;

package/dist/transformers/applyTransformers.js

@@ -1 +1 @@
-export { applyTransformers } from '../chunk-EF2WO5MC.js';
+export { applyTransformers } from '../chunk-QJI26K46.js';

package/package.json

@@ -2,7 +2,7 @@
   "name": "@workleap/webpack-configs",
   "author": "Workleap",
   "description": "Workleap recommended webpack config.",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "license": "Apache-2.0",
   "keywords": [
     "workleap",
@@ -13,7 +13,8 @@
   "exports": {
     ".": {
       "import": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
     }
   },
   "files": [
@@ -56,6 +57,7 @@
     "@swc/helpers": "0.5.1",
     "@swc/jest": "0.2.29",
     "@types/jest": "29.5.4",
+    "@types/node": "20.5.7",
     "browserslist": "4.21.10",
     "jest": "29.6.4",
     "postcss": "8.4.29",
@@ -66,9 +68,9 @@
     "webpack": "5.88.2",
     "webpack-dev-server": "4.15.1",
     "@workleap/eslint-plugin": "2.1.0",
+    "@workleap/swc-configs": "2.1.1",
     "@workleap/tsup-configs": "3.0.0",
-    "@workleap/typescript-configs": "3.0.2",
-    "@workleap/swc-configs": "2.1.1"
+    "@workleap/typescript-configs": "3.0.2"
   },
   "publishConfig": {
     "access": "public",