@zohodesk/client_build_tool 0.0.11-exp.15.1 → 0.0.11-exp.15.4

package/lib/shared/bundler/webpack/loaders/i18nIdReplaceLoader.js

@@ -20,7 +20,7 @@ module.exports = function i18nIdReplaceLoader(source, map) {
   const resourcePath = this.resourcePath;
   this.cacheable && this.cacheable();
   const options = getOptions(this) || {};
-  const callback = this.async();
+  const callback = this.async(); // Skip files in excluded paths
 
   if (options.excludePaths) {
     const shouldExclude = options.excludePaths.some(excludePath => resourcePath.includes(excludePath));
@@ -28,7 +28,8 @@ module.exports = function i18nIdReplaceLoader(source, map) {
     if (shouldExclude) {
       return callback(null, source, map);
     }
-  }
+  } // Only process files in included paths if specified
+
 
   if (options.includePaths && options.includePaths.length > 0) {
     const shouldInclude = options.includePaths.some(includePath => resourcePath.includes(includePath));
@@ -36,11 +37,13 @@ module.exports = function i18nIdReplaceLoader(source, map) {
     if (!shouldInclude) {
       return callback(null, source, map);
     }
-  }
+  } // Validate i18n data exists
+
 
   if (!options.allI18nData || Object.keys(options.allI18nData).length === 0) {
     return callback(new Error(`i18nIdReplaceLoader: 'allI18nData' option is missing or empty`));
-  }
+  } // Load numeric ID mapping
+
 
   let numericIdMap = null;
 
@@ -48,14 +51,22 @@ module.exports = function i18nIdReplaceLoader(source, map) {
     try {
       if (fs.existsSync(options.numericMapPath)) {
         const fileContent = fs.readFileSync(options.numericMapPath, 'utf-8');
-        const parsedData = JSON.parse(fileContent);
-
-        if (parsedData && parsedData.originalKeyToNumericId) {
-          numericIdMap = parsedData.originalKeyToNumericId;
+        const parsedData = JSON.parse(fileContent); // Handle both wrapped and flat formats
+
+        if (parsedData) {
+          if (parsedData.originalKeyToNumericId) {
+            // New format with wrapper
+            numericIdMap = parsedData.originalKeyToNumericId;
+          } else if (typeof parsedData === 'object') {
+            // Flat format - use directly
+            numericIdMap = parsedData;
+          }
         }
       }
-    } catch (err) {}
-  }
+    } catch (err) {// Silently continue without numeric mapping
+    }
+  } // If no numeric map available, return source as-is
+
 
   if (!numericIdMap) {
     return callback(null, source, map);
@@ -64,21 +75,24 @@ module.exports = function i18nIdReplaceLoader(source, map) {
   const isDevMode = options.devMode || process.env.NODE_ENV === 'development';
 
   try {
+    // Parse the JavaScript/TypeScript source code
     const ast = parser.parse(source, {
       sourceType: 'module',
       plugins: ['jsx', 'typescript', 'classProperties', 'optionalChaining', 'nullishCoalescingOperator'],
       sourceFilename: resourcePath
     });
-    let hasTransformations = false;
+    let hasTransformations = false; // Traverse AST and replace i18n keys with numeric IDs
+
     traverse(ast, {
       StringLiteral(path) {
         const {
           node
-        } = path;
+        } = path; // Check if this string is an i18n key
 
         if (!options.allI18nData.hasOwnProperty(node.value)) {
           return;
-        }
+        } // Replace with numeric ID if available
+
 
         if (numericIdMap.hasOwnProperty(node.value)) {
           const numericId = String(numericIdMap[node.value]);
@@ -87,7 +101,7 @@ module.exports = function i18nIdReplaceLoader(source, map) {
         }
       }
 
-    });
+    }); // Generate code if transformations were made
 
     if (hasTransformations) {
       const output = generator(ast, {

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

@@ -0,0 +1,42 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = configI18nIndexingPlugin;
+
+var _I18nNumericIndexPlugin = _interopRequireDefault(require("../custom_plugins/I18nNumericIndexPlugin/I18nNumericIndexPlugin"));
+
+var _resourceBasedPublicPath = require("../common/resourceBasedPublicPath");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function configI18nIndexingPlugin(config) {
+  const {
+    i18nIndexing,
+    cdnMapping
+  } = config;
+
+  if (!i18nIndexing || !i18nIndexing.enable) {
+    return null;
+  } // Get the public path for i18n resources
+
+
+  const i18nPublicPath = (0, _resourceBasedPublicPath.resourceBasedPublicPath)('i18n', config); // Get the CDN template for i18n resources if CDN is enabled
+
+  const i18nCdnTemplate = cdnMapping && cdnMapping.isCdnEnabled ? cdnMapping.i18nTemplate || cdnMapping.jsTemplate : '';
+  const options = {
+    jsResourcePath: i18nIndexing.jsResourcePath,
+    propertiesFolderPath: i18nIndexing.propertiesFolderPath,
+    numericMapPath: i18nIndexing.numericMapPath,
+    numericFilenameTemplate: i18nIndexing.numericFilenameTemplate || 'i18n-chunk/[locale]/numeric.i18n.js',
+    dynamicFilenameTemplate: i18nIndexing.dynamicFilenameTemplate || 'i18n-chunk/[locale]/dynamic.i18n.js',
+    jsonpFunc: i18nIndexing.jsonpFunc || 'window.loadI18nChunk',
+    htmlTemplateLabel: i18nIndexing.htmlTemplateLabel || '{{--user-locale}}',
+    localeVarName: i18nIndexing.localeVarName || 'window.userLangCode',
+    customGroups: i18nIndexing.customGroups || {},
+    publicPath: i18nPublicPath || '',
+    i18nCdnTemplate
+  };
+  return new _I18nNumericIndexPlugin.default(options);
+}

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

@@ -0,0 +1,92 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = configI18nNumericHtmlInjector;
+
+var _htmlWebpackPlugin = _interopRequireDefault(require("html-webpack-plugin"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const pluginName = 'I18nNumericHtmlInjectorPlugin';
+
+class I18nNumericHtmlInjectorPlugin {
+  constructor(options) {
+    this.options = options;
+  }
+
+  apply(compiler) {
+    compiler.hooks.thisCompilation.tap(pluginName, compilation => {
+      // Hook into HtmlWebpackPlugin to inject i18n script tags
+      _htmlWebpackPlugin.default.getHooks(compilation).beforeAssetTagGeneration.tap(pluginName, hookData => {
+        const {
+          assets
+        } = hookData;
+        const {
+          numericFilenameTemplate,
+          dynamicFilenameTemplate,
+          htmlTemplateLabel,
+          i18nCdnTemplate,
+          customGroups
+        } = this.options;
+        const newI18nAssets = []; // Add numeric i18n chunk
+
+        if (numericFilenameTemplate) {
+          const numericFilename = numericFilenameTemplate.replace(/\[locale\]/g, htmlTemplateLabel).replace(/%5Blocale%5D/g, htmlTemplateLabel); // Don't add CDN template - HtmlWebpackPlugin handles it
+
+          newI18nAssets.push(numericFilename);
+        } // Add dynamic i18n chunk
+
+
+        if (dynamicFilenameTemplate) {
+          const dynamicFilename = dynamicFilenameTemplate.replace(/\[locale\]/g, htmlTemplateLabel).replace(/%5Blocale%5D/g, htmlTemplateLabel); // Don't add CDN template - HtmlWebpackPlugin handles it
+
+          newI18nAssets.push(dynamicFilename);
+        } // Add custom group chunks if they should be in initial HTML
+
+
+        if (customGroups) {
+          Object.entries(customGroups).forEach(([groupName, groupConfig]) => {
+            // Only add to initial HTML if preload is true
+            if (groupConfig.preload && groupConfig.filenameTemplate) {
+              const groupFilename = groupConfig.filenameTemplate.replace(/\[locale\]/g, htmlTemplateLabel).replace(/%5Blocale%5D/g, htmlTemplateLabel); // Don't add CDN template - HtmlWebpackPlugin handles it
+
+              newI18nAssets.push(groupFilename);
+            }
+          });
+        } // Prepend i18n assets to ensure they load before main bundle
+
+
+        if (newI18nAssets.length > 0) {
+          assets.js = [...newI18nAssets, ...assets.js];
+        }
+
+        return hookData;
+      });
+    });
+  }
+
+}
+
+function configI18nNumericHtmlInjector(config) {
+  const {
+    i18nIndexing,
+    cdnMapping
+  } = config; // Only create this plugin if i18nIndexing is enabled
+
+  if (!i18nIndexing || !i18nIndexing.enable) {
+    return null;
+  } // Get the CDN template for i18n resources if CDN is enabled
+
+
+  const i18nCdnTemplate = cdnMapping && cdnMapping.isCdnEnabled ? cdnMapping.i18nTemplate || cdnMapping.jsTemplate : '';
+  const options = {
+    numericFilenameTemplate: i18nIndexing.numericFilenameTemplate || 'i18n-chunk/[locale]/numeric.i18n.js',
+    dynamicFilenameTemplate: i18nIndexing.dynamicFilenameTemplate || 'i18n-chunk/[locale]/dynamic.i18n.js',
+    htmlTemplateLabel: i18nIndexing.htmlTemplateLabel || '{{--user-locale}}',
+    customGroups: i18nIndexing.customGroups || {},
+    i18nCdnTemplate
+  };
+  return new I18nNumericHtmlInjectorPlugin(options);
+}

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

@@ -11,6 +11,10 @@ var _configEnvVariables = require("./pluginConfigs/configEnvVariables");
 
 var _configI18nSplitPlugin = require("./pluginConfigs/configI18nSplitPlugin");
 
+var _configI18nIndexingPlugin = _interopRequireDefault(require("./pluginConfigs/configI18nIndexingPlugin"));
+
+var _configI18nNumericHtmlInjector = _interopRequireDefault(require("./pluginConfigs/configI18nNumericHtmlInjector"));
+
 var _configMiniCSSExtractPlugin = require("./pluginConfigs/configMiniCSSExtractPlugin");
 
 var _configRtlCssPlugin = require("./pluginConfigs/configRtlCssPlugin");
@@ -49,12 +53,12 @@ var _configRuntimeResourceCleanup = require("./pluginConfigs/configRuntimeResour
 
 var _configCustomScriptLoadingStrategyPlugin = require("./pluginConfigs/configCustomScriptLoadingStrategyPlugin");
 
-var _configI18nNumericIndexPlugin = require("./pluginConfigs/configI18nNumericIndexPlugin");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 // import { IgnorePlugin } from 'webpack';
 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, _configI18nNumericIndexPlugin.configI18nNumericIndexPlugin)(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, _configI18nIndexingPlugin.default)(options), (0, _configRtlCssPlugin.configRtlCssPlugin)(options), (0, _configHtmlWebpackPlugin.configHtmlWebpackPlugin)(options), (0, _configI18nNumericHtmlInjector.default)(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);
 }

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@zohodesk/client_build_tool",
-  "version": "0.0.11-exp.15",
+  "version": "0.0.11",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@zohodesk/client_build_tool",
-      "version": "0.0.11-exp.15",
+      "version": "0.0.11",
       "license": "ISC",
       "dependencies": {
         "@babel/cli": "7.17.10",

package/package.json

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

package/README_backup.md

@@ -1,202 +0,0 @@
-# Client Build Tool
-
-This is a build tool for react based web applications.
-
-Supported and Tested Environment
-
-| Name | Version  |
-| :--: | :------: |
-| node | v18.11.0 |
-| npm  |  8.19.2  |
-
-OS : Mac , ubuntu
-
-# client_build_tool
-
-A CLI tool for build modern web application and libraries
-
-# Installation
-
-Below Steps:-
-
-> `npm i -g @zohodesk/client_build_tool`
-
-# Usage
-
-## Step 1
-
-> `cbt template app <your-project-folder> && cd <your-project-folder>`
-
-## Step 2
-
-Now to run app
-
-> `npm run start`
-
----
-
-Happy Code :>) 🤟
-
-# "Client Build Tool (CBT): Streamline and Optimize Your Client-side Build Process"
-
-## Description:
-
-CBT is a powerful client-side build tool designed to streamline and optimize your development workflow. With CBT, you can effortlessly manage and configure your project's build process, automating tasks, and improving efficiency. It provides an intuitive interface and a comprehensive set of features to simplify the build pipeline, allowing you to focus more on coding and less on tedious configuration.
-
-## Key Features:
-
-- **Integrated Dev Server:** Run your application locally with a built-in development server for quick feedback and real-time updates.
-- **Mock API Server:** Seamlessly integrate a mock API server to simulate backend interactions during development.
-- **Intelligent CSS Processing:** Automatically process and optimize CSS files, including customizable class name generation and advanced postcss plugins.
-- **Internationalization Support:** Easily manage internationalization (i18n) with efficient chunk splitting and language-specific resource loading.
-- **CDN Mapping:** Effortlessly map assets to a Content Delivery Network (CDN) for faster delivery and improved performance.
-- **Comprehensive Configuration:** Fine-tune your build process with extensive configuration options, including source maps, Babel customizations, and more.
-- **Service Worker Integration:** Enable service worker functionality for offline support and improved caching capabilities.
-- **Customizable Build Artifacts:** Define custom chunks, modify HTML templates, and generate a manifest.json file for better control over your build output.
-- **User-friendly Interface:** CBT provides a user-friendly interface, making it easy to configure, customize, and monitor your build process.
-
-With CBT, you can optimize your client-side development workflow, increase productivity, and deliver high-quality applications faster. Start using CBT today and experience the power of efficient and streamlined client-side builds.
-
-# Commands
-
-The following commands are available options for the `cbt` (Client Build Tool) CLI. You can execute these commands by prefixing them with `cbt`. For example, `cbt start`.
-
-- **preProcessor:** Runs the preProcessor.js in the app to set the variables before the build or run the dev mode.
-
-- **start**: Starts the development server with mode support. You can specify the mode as either `dev` or `prod`. This command is used for local development and testing.
-
-- **build**: Executes the build command with mode support. You can specify the mode as either `dev` or `prod`. This command compiles and bundles your application for deployment.
-
-- **build:lib**: Transpile the `src` folder to the `lib` folder, generating CommonJS modules. This command is specifically designed for building libraries that require CommonJS module format.
-
-- **build:es**: Transpile the `src` folder to the `es` folder, generating modules using import statements. This command is useful for building libraries that use ECMAScript module syntax.
-
-- **version**: Prints the version of the CBT CLI tool.
-
-- **template**: Creates an initial template or skeleton for your project. You can specify the option as `app`. This command sets up a basic project structure and configuration files to get you started quickly.
-
-- **mock:server**: Starts an external mock API server. This command enables you to run a separate server specifically for mocking API responses during development and testing.
-
-> Note: Make sure to replace `start` in the examples above with the actual command or script that you use to run the Client Build Tool CLI.
-
-These commands provide flexibility and control over your client-side build process, allowing you to start the development server, build your application, transpile libraries, create templates, run a mock API server, and more.
-
-For more [Details](ConfigurationDocumentation.md)
-
-
-version details :- 
-
-# 0.0.8 
-
-- Main version 
-
-# 0.0.9 
-
-fixes :- 
-
-- service worker wrong i18n entry fixed 
-
-- preload plc undefined url fixed 
-
-# Changelog and Release Notes
-
-- 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.11
-
-# 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
-**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

package/init/README.md

@@ -1,170 +0,0 @@
-# Client Build Tool Init Guide
-
-This folder provides a quick-start for integrating `@zohodesk/client_build_tool` (aka `cbt`) into an app. It covers installation, minimal config, and common feature toggles.
-
-## Install
-
-- As a dev dependency (recommended):
-  - npm: `npm i -D @zohodesk/client_build_tool`
-  - yarn: `yarn add -D @zohodesk/client_build_tool`
-- Or use via npx: `npx cbt --help`
-
-Add convenient scripts to your app’s `package.json`:
-
-```
-{
-  "scripts": {
-    "dev": "cbt start --context=app",
-    "build:es": "cbt build:es src es",
-    "build:lib": "cbt build:lib src lib",
-    "mock": "cbt mock:server --mock_port=3001",
-    "pre": "cbt pre:process"
-  }
-}
-```
-
-## Minimal Config (cbt.config.js)
-
-Copy `cbt.config.example.js` to your app root as `cbt.config.js` and edit:
-
-```
-module.exports = {
-  config: {
-    context: 'app',
-    mode: 'dev',
-    server: {
-      port: 9090,
-      host: 'localhost',
-      httpsCerts: '@zohodesk-private/client_dev_cert',
-      disableContextURL: false
-    },
-    htmlTemplate: { templateFile: 'src/index.html', inject: true },
-    app: { entryFile: 'src/index.js' },
-    css: {
-      plugins: {
-        rtlSplit: { enableRTLSplit: false }
-      }
-    },
-    i18nChunkSplit: { chunkSplitEnable: false },
-    i18nIndexing: { enable: false },
-    preProcess: { enable: false }
-  }
-};
-```
-
-Run dev server: `npm run dev` (or `cbt start`).
-
-## Common Feature Recipes
-
-- Enable i18n chunk split (per-locale chunks):
-```
-config: {
-  i18nChunkSplit: {
-    chunkSplitEnable: true,
-    templateLabel: '{{--user-locale}}',
-    localeVarName: 'document.documentElement.lang',
-    jsonpFunc: 'window.loadI18nChunk',
-    // optional: jsResource/propertiesFolder when using default reader
-  }
-}
-```
-
-- Enable i18n numeric indexing (per-locale or single-file):
-```
-config: {
-  i18nIndexing: {
-    enable: true,
-    devMode: false,
-    jsResourcePath: './deskapp/properties/JSResources.properties',
-    propertiesFolderPath: './deskapp/properties',
-    numericMapPath: './deskapp/properties/i18n-numeric-map.json',
-    // choose one mode
-    numericFilenameTemplate: 'i18n-chunk/[locale]/numeric.i18n.js',
-    dynamicFilenameTemplate: 'i18n-chunk/[locale]/dynamic.i18n.js',
-    // or single-file mode
-    // singleFile: true,
-    // singleFileTemplate: 'i18n/[locale].js',
-    jsonpFunc: 'window.loadI18nChunk',
-    htmlTemplateLabel: '{{--user-locale}}',
-    localeVarName: 'window.userLangCode',
-    includeContentHash: false,
-    generateManifest: false
-  }
-}
-```
-
-- Enable RTL CSS split and path templating:
-```
-config: {
-  css: {
-    plugins: {
-      rtlSplit: {
-        enableRTLSplit: true,
-        templateLabel: '{{--dir}}',
-        disableMinifySelector: false,
-        dirVarName: 'document.dir'
-      }
-    }
-  }
-}
-```
-
-- EFC SDK output:
-```
-config: {
-  efc: {
-    hasEFC: true,
-    createSDkFile: true,
-    entryPointName: 'efc',
-    entryFile: 'src/efc.js',
-    version: 'v1',
-    templateFilePath: 'efcTemplate.js',
-    outputFile: 'efc-sdk-[version].js',
-    resourceCleanup: true
-  }
-}
-```
-
-- Service worker:
-```
-config: {
-  serviceWorker: {
-    enable: true,
-    templateFilePath: 'sw.js',
-    outputFilePath: '/v1.js',
-    replaceText: '//<!--AssetsFromBuild -->'
-  }
-}
-```
-
-- Custom PostCSS plugins (built-in + custom):
-```
-config: {
-  css: {
-    plugins: {
-      valueReplacer: { enable: true, patterns: ['**/*.css'], config: [
-        { props: ['color'], values: { 'zd-': 'im-' } }
-      ]},
-      selectorReplace: { enable: true, patterns: ['**/*.module.css'], before: ['.old'], after: ['.new'] },
-      hoverActive: { enable: true, patterns: ['**/*.css'], hover: '(hover: hover)', active: '(hover: none)' },
-      cssVariableReplacement: { enable: false, patterns: [], configFile: null },
-      rtl: { enable: false, patterns: [] }
-    },
-    customPlugins: [
-      // { enable: true, patterns: ['**/*.css'], plugin: '/absolute/path/to/custom-postcss-plugin.js' }
-    ]
-  }
-}
-```
-
-## Tips & Troubleshooting
-
-- Node.js: CBT supports Node 14–18.
-- HTTPS certs: `server.httpsCerts` can be a local or global npm package exposing `{ httpsOptions }`.
-- Public path: Controlled via server extras; disable context prefix with `server.disableContextURL=true`.
-- Proxies: If you have stale npm proxy settings during install: `npm config delete proxy && npm config delete https-proxy`.
-- Verbose logs: set `VERBOSE=true`.
-
----
-
-For full option reference and internal architecture, read `../docs/client_build_tool_source_doc.md`.