@zohodesk/client_build_tool 0.0.12 → 0.0.13

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog and Release Notes
 
+# v0.0.13 (02-09-2025)
+
+**Adjustments:-**
+- Source map files are created in the smap/ folder by default. However, they are also being created in the js/ folder to resolve the issue where Murphy was unable to locate them. 
+
+**Feature:-**
+- Added support for Murphy to be built as a separate chunk and injected as the top script in the initial HTML.
+- To enable this support , add this in your configuration 
+
+```murphyBootstrapHtml{
+    enable: true,
+    chunkName: '',
+    filePath: ''
+}```
+
+
+
 # v0.0.12 (14-08-2025)
 
 - Fixed the initial i18n loading issue caused by using the same function in both the i18nRuntimeDealer plugin and decidePublicPath

package/README.md

@@ -294,6 +294,127 @@ For example
 - `customAttributes` support for add attributes to html, link , script tag in the output build.
 
 
+## v0.0.1 (18-04-2023)
+
+First Release
+**Features:-**
+
+- 'start' command to run react app
+- 'build' command to create build for react app
+- 'build:lib' command to create lib for react library
+- 'build:es' command to create es for react library
+- 'templates' command to create es for react library
+# Changelog and Release Notes
+
+# v0.0.13 (02-09-2025)
+
+**Adjustments:-**
+- Source map files are created in the smap/ folder by default. However, they are also being created in the js/ folder to resolve the issue where Murphy was unable to locate them. 
+
+**Feature:-**
+- Added support for Murphy to be built as a separate chunk and injected as the top script in the initial HTML.
+- To enable this support , add this in your configuration 
+
+```murphyBootstrapHtml{
+    enable: true,
+    chunkName: '',
+    filePath: ''
+}```
+
+
+
+# v0.0.12 (14-08-2025)
+
+- Fixed the initial i18n loading issue caused by using the same function in both the i18nRuntimeDealer plugin and decidePublicPath
+
+# v0.0.11 (07-08-2025) (had an issue while enable i18n chunk split plugin)
+- remove babel-plugin-module-resolver dependencies
+
+**Adjustments:-**
+ - Public Folder configuration is separated for development and production
+
+**Bug Fix:-**
+- Fixed the issue where the build log was not visible when `stats (bundle integrity)` was enabled. The problem was resolved by adding an error check in the `bundleIntegrity plugin`.
+- Removed the babel-plugin-module-resolver dependency to resolve the alias resolution issue in the application.
+- Fixed the issue where a space in the variable name causes it to return an undefined value.
+- Fixed the URL path generation issue that occurred while using context in the development setup.
+
+
+# v0.0.10 (12-05-2025)
+**Feature:-**
+- `alias` support for `build:es` and `build:lib`
+    - Add babel-plugin-module-resolver dependencies
+    - Modify getBabelPlugin to include module resolver with aliases
+
+**Bug Fix:-**
+- Enhance runBabelForTSFile to handle both .tsx and .ts file extensions
+- Update mockApiHandler to ensure mock function is called correctly
+
+**Change:-**
+- Refactor defaultConfigValues.js to include cli options for enableRTLSplit
+
+## v0.0.9 
+
+**Feature:-**
+- externals was added to  Prevent bundling of certain imported packages and retrieve these external dependencies at runtime.
+- to use externals, we use the following pattern in `app > externals` :
+
+For example
+```
+   externals: {
+    <key> : <value>
+   }
+```
+
+## v0.0.6 (4-09-2023)
+
+**Feature:-**
+- Generating bundle integrity report json file for the build assets only in production mode. To use this feature we need to add `stats > enable` or cli flags `enable_stats`.
+- Added Resource Cleanup plugin to cleanup resource retained by build tool. this plugin is controlled by efc flag resourcecleanup flag.
+- added support for using regex expression to get group of chunks chunkId via Resource Hint plugin prefetch/preload hook.
+  only will be activate when `resourceHints` => `allowPrefetchingMultipleChunks` as `true`
+- added support for glob pattern for custom chunks split logic.
+- added options to split chunks base config in the key `app` => `customChunksBaseConfig` as object
+
+**Change:-**
+- i18n name not generated issue fix.
+- public path not correctly set issue fix.
+- changing plugin hook stages in i18nRuntimePlugin and sourceMapPlugin
+## v0.0.5 (6-08-2023)
+
+**Changes:--**
+- Typo fix in i18nRuntimeDealerPlugin.js
+- fixing some bugs in resolvers.js file
+
+## v0.0.3 (1-08-2023)
+
+**Changes:--**
+- `devtool` default value changed from `hidden-cheap-source-map` to `source-map`
+- unwanted files deleted from build
+
+**Issue Fix:--**
+- The issue with the source map not being created in the build has been fixed."
+
+
+## v0.0.2 (28-04-2023)
+
+**Features:-**
+
+- `devModeContentHashAllowedTypes` support added for some project there will be a need for hash even though they run dev mode. for details [details](https://zgit.csez.zohocorpin.com/zohodesk/react-cli/-/blob/3.0.0/packages/client_build_tool/ConfigurationDocumentation.md#devModeContentHashAllowedTypes)
+- `devLikeHash` support for disable content hash for file names in production mode. for details [details](https://zgit.csez.zohocorpin.com/zohodesk/react-cli/-/blob/3.0.0/packages/client_build_tool/ConfigurationDocumentation.md#devLikeHash)
+- `disableReactDevWarning` disable react dev warning such as prop-type warnings will be removed in dev mode build or server. for details [details](https://zgit.csez.zohocorpin.com/zohodesk/react-cli/-/blob/3.0.0/packages/client_build_tool/ConfigurationDocumentation.md#disableReactDevWarning) can be enabled via `--disable_react_dev_warning` too.
+- `statsLogConfig` support to customize default webpack log after build finished. for details [details](https://zgit.csez.zohocorpin.com/zohodesk/react-cli/-/blob/3.0.0/packages/client_build_tool/ConfigurationDocumentation.md#statsLogConfig) can be enabled via `--disable_react_dev_warning` too.
+- `enableChunkHash` renamed as `enableFileNameHashing`
+
+- `pre_processor` command to run the preprocessor.js file.preProcessor runs in build, start, buildEs, buildLib commands bu default. and we have watch mode support as well with the option (`-w`)
+- `createSeparateSmap` flag `source_map_enable` renamed as `enable_smap`
+- `removeAttribute` option changes as `babelCustomizations.removeAttribute`
+- `removePropTypes` support for remove the prop types package in the output build.
+- `devConsoleExclude` support for remove the _console statements_ such as _console.log_, _console.warn_ in the output build.
+- `manifestJson` default value set as false.
+- `customAttributes` support for add attributes to html, link , script tag in the output build.
+
+
 ## v0.0.1 (18-04-2023)
 
 First Release

package/README_backup.md

@@ -190,6 +190,110 @@ For example
 - `customAttributes` support for add attributes to html, link , script tag in the output build.
 
 
+## v0.0.1 (18-04-2023)
+
+First Release
+**Features:-**
+
+- 'start' command to run react app
+- 'build' command to create build for react app
+- 'build:lib' command to create lib for react library
+- 'build:es' command to create es for react library
+- 'templates' command to create es for react library
+# Changelog and Release Notes
+
+# v0.0.12 (14-08-2025)
+
+- Fixed the initial i18n loading issue caused by using the same function in both the i18nRuntimeDealer plugin and decidePublicPath
+
+# v0.0.11 (07-08-2025) (had an issue while enable i18n chunk split plugin)
+- remove babel-plugin-module-resolver dependencies
+
+**Adjustments:-**
+ - Public Folder configuration is separated for development and production
+
+**Bug Fix:-**
+- Fixed the issue where the build log was not visible when `stats (bundle integrity)` was enabled. The problem was resolved by adding an error check in the `bundleIntegrity plugin`.
+- Removed the babel-plugin-module-resolver dependency to resolve the alias resolution issue in the application.
+- Fixed the issue where a space in the variable name causes it to return an undefined value.
+- Fixed the URL path generation issue that occurred while using context in the development setup.
+
+
+# v0.0.10 (12-05-2025)
+**Feature:-**
+- `alias` support for `build:es` and `build:lib`
+    - Add babel-plugin-module-resolver dependencies
+    - Modify getBabelPlugin to include module resolver with aliases
+
+**Bug Fix:-**
+- Enhance runBabelForTSFile to handle both .tsx and .ts file extensions
+- Update mockApiHandler to ensure mock function is called correctly
+
+**Change:-**
+- Refactor defaultConfigValues.js to include cli options for enableRTLSplit
+
+## v0.0.9 
+
+**Feature:-**
+- externals was added to  Prevent bundling of certain imported packages and retrieve these external dependencies at runtime.
+- to use externals, we use the following pattern in `app > externals` :
+
+For example
+```
+   externals: {
+    <key> : <value>
+   }
+```
+
+## v0.0.6 (4-09-2023)
+
+**Feature:-**
+- Generating bundle integrity report json file for the build assets only in production mode. To use this feature we need to add `stats > enable` or cli flags `enable_stats`.
+- Added Resource Cleanup plugin to cleanup resource retained by build tool. this plugin is controlled by efc flag resourcecleanup flag.
+- added support for using regex expression to get group of chunks chunkId via Resource Hint plugin prefetch/preload hook.
+  only will be activate when `resourceHints` => `allowPrefetchingMultipleChunks` as `true`
+- added support for glob pattern for custom chunks split logic.
+- added options to split chunks base config in the key `app` => `customChunksBaseConfig` as object
+
+**Change:-**
+- i18n name not generated issue fix.
+- public path not correctly set issue fix.
+- changing plugin hook stages in i18nRuntimePlugin and sourceMapPlugin
+## v0.0.5 (6-08-2023)
+
+**Changes:--**
+- Typo fix in i18nRuntimeDealerPlugin.js
+- fixing some bugs in resolvers.js file
+
+## v0.0.3 (1-08-2023)
+
+**Changes:--**
+- `devtool` default value changed from `hidden-cheap-source-map` to `source-map`
+- unwanted files deleted from build
+
+**Issue Fix:--**
+- The issue with the source map not being created in the build has been fixed."
+
+
+## v0.0.2 (28-04-2023)
+
+**Features:-**
+
+- `devModeContentHashAllowedTypes` support added for some project there will be a need for hash even though they run dev mode. for details [details](https://zgit.csez.zohocorpin.com/zohodesk/react-cli/-/blob/3.0.0/packages/client_build_tool/ConfigurationDocumentation.md#devModeContentHashAllowedTypes)
+- `devLikeHash` support for disable content hash for file names in production mode. for details [details](https://zgit.csez.zohocorpin.com/zohodesk/react-cli/-/blob/3.0.0/packages/client_build_tool/ConfigurationDocumentation.md#devLikeHash)
+- `disableReactDevWarning` disable react dev warning such as prop-type warnings will be removed in dev mode build or server. for details [details](https://zgit.csez.zohocorpin.com/zohodesk/react-cli/-/blob/3.0.0/packages/client_build_tool/ConfigurationDocumentation.md#disableReactDevWarning) can be enabled via `--disable_react_dev_warning` too.
+- `statsLogConfig` support to customize default webpack log after build finished. for details [details](https://zgit.csez.zohocorpin.com/zohodesk/react-cli/-/blob/3.0.0/packages/client_build_tool/ConfigurationDocumentation.md#statsLogConfig) can be enabled via `--disable_react_dev_warning` too.
+- `enableChunkHash` renamed as `enableFileNameHashing`
+
+- `pre_processor` command to run the preprocessor.js file.preProcessor runs in build, start, buildEs, buildLib commands bu default. and we have watch mode support as well with the option (`-w`)
+- `createSeparateSmap` flag `source_map_enable` renamed as `enable_smap`
+- `removeAttribute` option changes as `babelCustomizations.removeAttribute`
+- `removePropTypes` support for remove the prop types package in the output build.
+- `devConsoleExclude` support for remove the _console statements_ such as _console.log_, _console.warn_ in the output build.
+- `manifestJson` default value set as false.
+- `customAttributes` support for add attributes to html, link , script tag in the output build.
+
+
 ## v0.0.1 (18-04-2023)
 
 First Release

package/lib/schemas/defaultConfigValues.js

@@ -350,6 +350,11 @@ var _default = {
   customScriptLoadingStrategey: {
     enable: false,
     options: null
+  },
+  murphyBootstrapHtml: {
+    enable: false,
+    chunkName: '',
+    filePath: ''
   }
 };
 exports.default = _default;

package/lib/shared/bundler/webpack/custom_plugins/MurphyInjectorPlugin/index.js

@@ -0,0 +1,89 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _SingleEntryPlugin = _interopRequireDefault(require("webpack/lib/SingleEntryPlugin.js"));
+
+var _nameTemplates = require("../../common/nameTemplates");
+
+var _htmlWebpackPlugin = _interopRequireDefault(require("html-webpack-plugin"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const pluginName = 'MurphyInjectorPlugin';
+
+class MurphyInjectorPlugin {
+  constructor(entries = [], options) {
+    this.entries = entries;
+    this.options = options;
+    this.jsTemplate = options.cdnMapping.jsTemplate || '{{__JS_CDN__}}';
+    this.cdnMapping = options.cdnMapping;
+  }
+
+  apply(compiler) {
+    compiler.hooks.thisCompilation.tap(pluginName, compilation => {
+      this.entries.forEach(({
+        name,
+        file
+      }) => {
+        // Create child compiler for this entry
+        const childCompiler = compilation.createChildCompiler(`additional-entry ${name}`, {
+          filename: (0, _nameTemplates.nameTemplates)('js', this.options),
+          // output filename
+          chunkFilename: `${name}.[id].js`,
+          publicPath: compiler.options.output.publicPath,
+          globalObject: "self" // safe for workers too
+
+        }); // Attach the entry point
+
+        new _SingleEntryPlugin.default(compiler.context, file, name).apply(childCompiler); // Run the child compiler
+
+        childCompiler.runAsChild((err, entries, childCompilation) => {
+          if (err) {
+            compilation.errors.push(err);
+            return;
+          }
+
+          if (childCompilation.errors && childCompilation.errors.length) {
+            compilation.errors.push(...childCompilation.errors);
+          } // Files are emitted automatically by child compiler
+          // ⚡ Hook HtmlWebpackPlugin and inject this file
+
+
+          _htmlWebpackPlugin.default.getHooks(compilation).alterAssetTags.tapAsync(pluginName, (data, cb) => {
+            let fileName = '';
+            const childFiles = childCompilation.entrypoints.get(name).getFiles();
+
+            if (childFiles.length !== 1) {
+              compilation.errors.push(new Error(`${pluginName}: Expected exactly 1 child file for entry "${name}", but got ${childFiles.length}.`));
+            }
+
+            if (this.cdnMapping.isCdnEnabled) {
+              fileName = `${this.jsTemplate}${childFiles[0]}`;
+            }
+
+            ;
+            data.assetTags.scripts.unshift({
+              tagName: "script",
+              voidTag: false,
+              attributes: {
+                src: fileName
+              },
+              meta: {
+                plugin: pluginName
+              }
+            });
+            cb(null, data);
+          });
+        });
+      });
+    });
+  }
+
+}
+
+var _default = MurphyInjectorPlugin;
+exports.default = _default;

package/lib/shared/bundler/webpack/custom_plugins/SourceMapPlugin/index.js

@@ -44,6 +44,18 @@ class SourceMapPlugin {
             }
           }
         });
+      });
+      compilation.hooks.processAssets.tap({
+        name: pluginName,
+        stage: _webpack.Compilation.PROCESS_ASSETS_STAGE_REPORT
+      }, assets => {
+        Object.keys(assets).forEach(assetName => {
+          const assetCode = assets[assetName].source();
+
+          if (/\.map$/.test(assetName)) {
+            compilation.emitAsset(assetName.split('smap/')[1], new RawSource(assetCode));
+          }
+        });
       }); // if contenthash enabled we need to add this to include the runtime files 
       //  compilation.hooks.processAssets.tap(
       //   {

package/lib/shared/bundler/webpack/pluginConfigs/configMurphyInjectorPlugin.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.configMurphyInjectorPlugin = configMurphyInjectorPlugin;
+
+var _constants = require("../../../constants");
+
+var _MurphyInjectorPlugin = _interopRequireDefault(require("../custom_plugins/MurphyInjectorPlugin"));
+
+var _path = _interopRequireDefault(require("path"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function configMurphyInjectorPlugin(options) {
+  const {
+    enable,
+    chunkName,
+    filePath
+  } = options.murphyBootstrapHtml;
+
+  if (enable) {
+    return new _MurphyInjectorPlugin.default([{
+      name: chunkName,
+      file: _path.default.join(_constants.appPath, filePath)
+    }], options);
+  }
+
+  return null;
+}

package/lib/shared/bundler/webpack/plugins.js

@@ -47,6 +47,8 @@ var _configBundleIntegrityReport = require("./pluginConfigs/configBundleIntegrit
 
 var _configRuntimeResourceCleanup = require("./pluginConfigs/configRuntimeResourceCleanup");
 
+var _configMurphyInjectorPlugin = require("./pluginConfigs/configMurphyInjectorPlugin");
+
 var _configCustomScriptLoadingStrategyPlugin = require("./pluginConfigs/configCustomScriptLoadingStrategyPlugin");
 
 // import { IgnorePlugin } from 'webpack';
@@ -54,5 +56,5 @@ function plugins(options) {
   const {
     webpackPlugins
   } = options;
-  return [(0, _configEnvVariables.configEnvVariables)(options), (0, _configCustomAttributesPlugin.configCustomAttributesPlugin)(options), (0, _configTPHashMappingPlugin.configTPHashMappingPlugin)(options), (0, _configCopyPublicFolders.configCopyPublicFolders)(options), (0, _configIgnorePlugin.configIgnorePlugin)(options), (0, _configMiniCSSExtractPlugin.configMiniCSSExtractPlugin)(options), (0, _configSelectorWeightPlugin.configSelectorWeightPlugin)(options), (0, _configVariableConversionPlugin.configVariableConversionPlugin)(options), (0, _configI18nSplitPlugin.configI18nSplitPlugin)(options), (0, _configRtlCssPlugin.configRtlCssPlugin)(options), (0, _configHtmlWebpackPlugin.configHtmlWebpackPlugin)(options), (0, _configCustomScriptLoadingStrategyPlugin.configCustomScriptLoadingStrategyPlugin)(options), (0, _configCdnChangePlugin.configCdnChangePlugin)(options), (0, _configServiceWorkerPlugin.configServiceWorkerPlugin)(options), (0, _configEFCTemplatePlugin.configEFCTemplatePlugin)(options), (0, _configResourceHintsPlugin.configResourceHintsPlugin)(options), (0, _configBundleAnalyzer.configBundleAnalyzer)(options), (0, _configManifestJsonPlugin.configManifestJsonPlugin)(options), (0, _configSourceMapPlugin.configSourceMapPlugin)(options), (0, _configProgressPlugin.configProgressPlugin)(options), (0, _configBundleIntegrityReport.configBundleIntegrityReport)(options), (0, _configRuntimeResourceCleanup.configRuntimeResourceCleanup)(options), ...webpackPlugins].filter(Boolean);
+  return [(0, _configEnvVariables.configEnvVariables)(options), (0, _configCustomAttributesPlugin.configCustomAttributesPlugin)(options), (0, _configTPHashMappingPlugin.configTPHashMappingPlugin)(options), (0, _configCopyPublicFolders.configCopyPublicFolders)(options), (0, _configIgnorePlugin.configIgnorePlugin)(options), (0, _configMiniCSSExtractPlugin.configMiniCSSExtractPlugin)(options), (0, _configSelectorWeightPlugin.configSelectorWeightPlugin)(options), (0, _configVariableConversionPlugin.configVariableConversionPlugin)(options), (0, _configI18nSplitPlugin.configI18nSplitPlugin)(options), (0, _configRtlCssPlugin.configRtlCssPlugin)(options), (0, _configHtmlWebpackPlugin.configHtmlWebpackPlugin)(options), (0, _configCustomScriptLoadingStrategyPlugin.configCustomScriptLoadingStrategyPlugin)(options), (0, _configCdnChangePlugin.configCdnChangePlugin)(options), (0, _configServiceWorkerPlugin.configServiceWorkerPlugin)(options), (0, _configEFCTemplatePlugin.configEFCTemplatePlugin)(options), (0, _configResourceHintsPlugin.configResourceHintsPlugin)(options), (0, _configBundleAnalyzer.configBundleAnalyzer)(options), (0, _configManifestJsonPlugin.configManifestJsonPlugin)(options), (0, _configSourceMapPlugin.configSourceMapPlugin)(options), (0, _configProgressPlugin.configProgressPlugin)(options), (0, _configBundleIntegrityReport.configBundleIntegrityReport)(options), (0, _configRuntimeResourceCleanup.configRuntimeResourceCleanup)(options), (0, _configMurphyInjectorPlugin.configMurphyInjectorPlugin)(options), ...webpackPlugins].filter(Boolean);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/client_build_tool",
-  "version": "0.0.12",
+  "version": "0.0.13",
   "description": "A CLI tool to  build  web applications and client libraries",
   "main": "lib/index.js",
   "bin": {