@zohodesk/react-cli 1.1.11-exp.1 → 1.1.11-exp.3

package/README.md

@@ -44,6 +44,19 @@ Now to run app
 
 # Change Logs
 
+# 1.1.11-exp.3 (22-8-2023)
+
+**Changes**
+- Changed the default name of stats file to `build-report-integrity.json`
+- Added optimization to reduce the stats file creation time. like streaming.
+- Added support to exclude keys suggested
+
+# 1.1.11-exp.2 (11-8-2023)
+
+**Changes**
+- Added more customization support for `stats.json` output.
+- Disabling `bundle-analyser` stats report for our customized stats output based on a flag.
+
 # 1.1.11-exp.1 (8-8-2023)
 
 **Changes** 

package/lib/pluginUtils/getProdPlugins.js

@@ -91,7 +91,10 @@ const getProdPlugins = (options, publicPath = '') => {
     localeAttr: efcLocaleAttr
   } = options.efc;
   const {
-    enable: enableStats
+    enable: enableStats,
+    options: statsOptions,
+    excludeKeys: statsOutputExcludeKeys,
+    fileName: statsFileName
   } = options.stats;
   const hasEFC = newOptionForEnableEFC || prevOptionForEnableEFC;
   const hashTempalate = enableChunkHash ? '.[chunkhash:20]_' : '';
@@ -232,9 +235,9 @@ const getProdPlugins = (options, publicPath = '') => {
     if (bundleAnalyze) {
       pluginsArr.push(new _webpackBundleAnalyzer.BundleAnalyzerPlugin({
         analyzerMode: 'static',
-        generateStatsFile: true,
+        generateStatsFile: !enableStats,
         openAnalyzer: false,
-        statsOptions: {
+        statsOptions: enableStats ? null : {
           source: false,
           normal: true,
           chunks: false,
@@ -293,7 +296,11 @@ const getProdPlugins = (options, publicPath = '') => {
 
 
   customAttributes.enable && pluginsArr.push(new _CustomAttributePlugin.CustomAttributePlugin(customAttributes));
-  enableStats && new _StatsPlugin.default();
+  enableStats && pluginsArr.push(new _StatsPlugin.default({
+    statsOptions,
+    statsOutputExcludeKeys,
+    statsFileName
+  }));
   return pluginsArr;
 };
 

package/lib/plugins/StatsPlugin.js

@@ -1,24 +1,64 @@
 "use strict";
 
-const {
-  defaulter
-} = require('../utils/getOptions');
-
 const fs = require('fs');
 
 const path = require('path');
 
+const {
+  Readable
+} = require('stream');
+
 const pluginName = 'stats-plugin';
 const statsSchema = {
-  preset: 'normal',
-  moduleTrace: true // source: true
-  //   errorDetails: true,
-  //   chunkRelations: true
-
+  all: true
 };
-module.exports = class StatsPlugin {
-  constructor(options = {}) {
-    this.statsOptions = defaulter(statsSchema, options);
+
+function* convertObjectToStringGen(obj, excludeKeys = []) {
+  if (typeof obj === 'string' || typeof obj === 'number' || typeof obj === 'boolean' || obj === null) {
+    yield JSON.stringify(obj);
+  } else if (Array.isArray(obj)) {
+    yield '[';
+    let isFirst = true;
+
+    for (let item of obj) {
+      if (item === undefined) {
+        item = null;
+      }
+
+      yield `${isFirst ? '' : ','}`;
+      yield* convertObjectToStringGen(item, excludeKeys);
+      isFirst = false;
+    }
+
+    yield obj.length ? ']' : ']';
+  } else {
+    yield '{';
+    let isFirst = true;
+    const entries = Object.entries(obj);
+
+    for (const [itemKey, itemValue] of entries) {
+      if (itemValue === undefined || excludeKeys.includes(itemKey)) {
+        continue;
+      }
+
+      yield `${isFirst ? '' : ','}${JSON.stringify(itemKey)}: `;
+      yield* convertObjectToStringGen(itemValue, excludeKeys);
+      isFirst = false;
+    }
+
+    yield entries.length ? '}' : '}';
+  }
+}
+
+class StatsPlugin {
+  constructor({
+    statsOptions = {},
+    statsOutputExcludeKeys = [],
+    statsFileName = 'bundle-report-integrity.json'
+  }) {
+    this.excludeKeysInStat = statsOutputExcludeKeys;
+    this.statsOptions = Object.assign({}, statsSchema, statsOptions);
+    this.statsFileName = statsFileName;
   }
 
   apply(compiler) {
@@ -28,17 +68,47 @@ module.exports = class StatsPlugin {
     });
   }
 
-  emitStats(statsJson) {
+  writeStatsFileInAStream(statsObj) {
     const {
       outputPath
-    } = statsJson;
-    const stringifiedJson = typeof statsJson === 'object' ? JSON.stringify(statsJson) : statsJson;
-    const bufferJson = Buffer.from(stringifiedJson);
-    fs.writeFile(path.join(outputPath, 'stats.json'), bufferJson, err => {
-      if (err) {
-        throw err;
+    } = statsObj;
+    const ouputFileName = path.join(outputPath, this.statsFileName);
+    this.createReadStream(statsObj).pipe(fs.createWriteStream(ouputFileName)).on('end', () => {
+      console.log(`${this.statsFileName} generated successfully`);
+    }).on('error', e => {
+      console.error('error in stats generation', e);
+    });
+  }
+
+  createReadStream(statsObj) {
+    const excludeKeys = this.excludeKeysInStat;
+    return new Readable({
+      read() {
+        let isDone = false;
+        const objToStringGen = convertObjectToStringGen(statsObj, excludeKeys);
+
+        while (!isDone) {
+          const {
+            done,
+            value
+          } = objToStringGen.next();
+
+          if (done) {
+            isDone = true;
+            this.push(null);
+          } else {
+            this.push(value);
+          }
+        }
       }
+
     });
   }
 
-};
+  emitStats(statsJson) {
+    return this.writeStatsFileInAStream(statsJson);
+  }
+
+}
+
+module.exports = StatsPlugin;

package/lib/schemas/index.js

@@ -728,7 +728,10 @@ var _default = {
     enable: {
       value: false,
       cli: 'enable_stats'
-    }
+    },
+    fileName: undefined,
+    options: undefined,
+    excludeKeys: undefined
   }
 };
 exports.default = _default;

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@zohodesk/react-cli",
-  "version": "1.1.11-exp.1",
+  "version": "1.1.10",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@zohodesk/react-cli",
-      "version": "1.1.11-exp.1",
+      "version": "1.1.10",
       "license": "ISC",
       "dependencies": {
         "@babel/cli": "7.10.5",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/react-cli",
-  "version": "1.1.11-exp.1",
+  "version": "1.1.11-exp.3",
   "description": "A CLI tool for build modern web application and libraries",
   "scripts": {
     "init": "node ./lib/utils/init.js",

package/packages/client_build_tool/lib/allCommandsConfigs.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _fs = require("fs");
+
+var _path = require("path");
+
+const allConfigs = [];
+(0, _fs.readdirSync)((0, _path.join)(__dirname, 'commands')).forEach(folderName => {
+  const modulePath = (0, _path.join)(__dirname, './commands/' + folderName + '/config.js');
+
+  if ((0, _fs.existsSync)(modulePath)) {
+    const config = require(modulePath).default;
+
+    allConfigs.push(config);
+  }
+});
+var _default = allConfigs;
+exports.default = _default;

package/packages/client_build_tool/lib/buildToolLoggers.js

@@ -0,0 +1,32 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.debugLogger = debugLogger;
+exports.errorLogger = errorLogger;
+exports.messageLogger = messageLogger;
+exports.verboseLogger = verboseLogger;
+exports.warnLogger = warnLogger;
+
+/* eslint-disable no-console */
+function verboseLogger(...args) {// TODO: need to be remove when publish happens 
+  // console.log(...args);
+  console.log(...args);
+}
+
+function warnLogger(...args) {
+  console.warn(...args);
+}
+
+function messageLogger(...args) {
+  console.log(...args);
+}
+
+function debugLogger(...args) {// TODO: need to be remove when publish happens 
+  // console.log(...args);
+}
+
+function errorLogger(...args) {
+  console.error(...args);
+}

package/packages/client_build_tool/lib/commands/build/commandExecutor.js

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.commandExecutor = commandExecutor;
+
+var _buildToolLoggers = require("../../buildToolLoggers");
+
+var _webpackBuild = _interopRequireDefault(require("../../shared/bundler/webpack/webpackBuild"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// import { spawnSyncIO } from '../../shared/commands-utlis/spanSync';
+function commandExecutor(options) {
+  (0, _buildToolLoggers.messageLogger)('Build is runnning');
+  (0, _webpackBuild.default)(options); // spawnSyncIO('webpack', [
+  //   '--config',
+  //   require.resolve('../../shared/bundler/webpack/webpack.dev.config.js')
+  // ]);
+}

package/packages/client_build_tool/lib/commands/build/config.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = {
+  name: "build",
+  alias: ["devbuild"],
+  dirname: __dirname
+};
+exports.default = _default;

package/packages/client_build_tool/lib/commands/build/errorHander.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.errorHander = errorHander;
+
+function errorHander(e) {
+  console.error(e);
+}

package/packages/client_build_tool/lib/commands/build/index.js

@@ -0,0 +1,35 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.configs = void 0;
+
+var _commandExecutor = require("./commandExecutor");
+
+var _errorHander = require("./errorHander");
+
+var _optionsProcesser = require("./optionsProcesser");
+
+// import { spawnSyncIO } from '../commands-utlis/spanSync.js';
+function run(options) {
+  // const { disableWatch } = options.app;
+  // spawnSyncIO('node', [
+  //   require.resolve(
+  //     disableWatch ? '../servers/nowatchserver' : '../servers/server'
+  //   ),
+  //   '--expose-http2',
+  //   ...args
+  // ]);
+  (0, _commandExecutor.commandExecutor)(options).then(console.log).catch(e => {
+    (0, _errorHander.errorHander)(e);
+  });
+}
+
+const configs = {
+  name: 'devSeverStart',
+  alias: ['start'],
+  optionsProcesser: _optionsProcesser.optionsProcesser,
+  run
+};
+exports.configs = configs;

package/packages/client_build_tool/lib/commands/build/optionsProcesser.js

@@ -0,0 +1,40 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.optionsProcesser = optionsProcesser;
+
+var _path = require("path");
+
+var _decidePublicPath = require("../../shared/bundler/webpack/common/decidePublicPath");
+
+var _urlConcat = require("../../shared/server/urlConcat");
+
+function optionsProcesser(options) {
+  const {
+    server,
+    context
+  } = options;
+  const {
+    disableContextURL
+  } = server;
+  const serverExtras = (0, _decidePublicPath.modifiedServerOptions)(options);
+  const publicPath = (0, _decidePublicPath.decidePublicPath)(serverExtras);
+  const contextURL = disableContextURL ? '' : `/${context}`;
+  const serverURL = (0, _urlConcat.urlConcat)(publicPath, contextURL);
+  const contextFolderPath = (0, _path.join)(process.cwd(), context);
+  console.log({
+    serverURL,
+    publicPath
+  });
+  const defaultApplyedOptions = { ...options,
+    serverExtras,
+    publicPath,
+    contextURL,
+    serverURL,
+    contextFolderPath,
+    httpsOptions: serverExtras.httpsOptions
+  };
+  return defaultApplyedOptions;
+}

package/packages/client_build_tool/lib/commands/buildEs/commandExecutor.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.commandExecutor = commandExecutor;
+
+var _spanSync = require("../../shared/commands-utlis/spanSync");
+
+var _constants = require("../../shared/constants");
+
+function commandExecutor(options) {
+  const {
+    extraArgs
+  } = options;
+  (0, _spanSync.spawnSyncIO)("babel", ["src", "--out-dir", "es", "--copy-files", "--config-file=" + _constants.babelrcPath, ...extraArgs]);
+}

package/packages/client_build_tool/lib/commands/buildEs/config.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = {
+  name: "build:es",
+  alias: ["build_es", "build:es"],
+  dirname: __dirname
+};
+exports.default = _default;

package/packages/client_build_tool/lib/commands/buildLib/commandExecutor.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.commandExecutor = commandExecutor;
+
+var _spanSync = require("../../shared/commands-utlis/spanSync");
+
+var _constants = require("../../shared/constants");
+
+function commandExecutor(options) {
+  const {
+    extraArgs
+  } = options;
+  (0, _spanSync.spawnSyncIO)("babel", ["src", "--out-dir", "lib", "--copy-files", "--config-file=" + _constants.babelrcPath, ...extraArgs]);
+}

package/packages/client_build_tool/lib/commands/buildLib/config.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = {
+  name: "build:lib",
+  alias: ["build_lib"],
+  dirname: __dirname
+};
+exports.default = _default;

package/packages/client_build_tool/lib/commands/start/commandExecutor.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.commandExecutor = commandExecutor;
+
+var _serverBywebpackDevMiddleware = require("../../shared/server/serverBywebpackDevMiddleware");
+
+function commandExecutor(options) {
+  // require("../../shared/server/devServer").run(options);
+  (0, _serverBywebpackDevMiddleware.run)(options);
+}

package/packages/client_build_tool/lib/commands/start/config.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = {
+  name: "start",
+  alias: ["dstart", "devSeverStart"],
+  dirname: __dirname
+};
+exports.default = _default;

package/packages/client_build_tool/lib/commands/start/deprecationHandler.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.deprecationHandler = deprecationHandler;
+
+function deprecationHandler(options) {// options.app.deprecated &&
+  // console.log('options.app.deprecated this option  was deprecated since V1.3.1' );
+}

package/packages/client_build_tool/lib/commands/start/errorHander.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.errorHander = errorHander;
+
+function errorHander(e) {
+  console.error(e);
+}

package/packages/client_build_tool/lib/commands/start/optionsProcesser.js

@@ -0,0 +1,36 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.optionsProcesser = optionsProcesser;
+
+var _path = require("path");
+
+var _decidePublicPath = require("../../shared/bundler/webpack/common/decidePublicPath");
+
+var _urlConcat = require("../../shared/server/urlConcat");
+
+function optionsProcesser(options) {
+  const {
+    server,
+    context
+  } = options;
+  const {
+    disableContextURL
+  } = server;
+  const serverExtras = (0, _decidePublicPath.modifiedServerOptions)(options);
+  const publicPath = (0, _decidePublicPath.decidePublicPath)(serverExtras);
+  const contextURL = disableContextURL ? '' : `/${context}`;
+  const serverURL = (0, _urlConcat.urlConcat)(publicPath, contextURL);
+  const contextFolderPath = (0, _path.join)(process.cwd(), context);
+  const defaultApplyedOptions = { ...options,
+    serverExtras,
+    publicPath,
+    contextURL,
+    serverURL,
+    contextFolderPath,
+    httpsOptions: serverExtras.httpsOptions
+  };
+  return defaultApplyedOptions;
+}

package/packages/client_build_tool/lib/commands/start/postProcesser.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.postProcesser = postProcesser;
+
+function postProcesser(options) {
+  console.log('postProcesser');
+}

package/packages/client_build_tool/lib/commands/start/preProcesser.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.preProcesser = preProcesser;
+
+function preProcesser(options) {
+  console.log('preProcesser');
+}

package/packages/client_build_tool/lib/commandsRouter.js

@@ -0,0 +1,71 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.route = route;
+
+var _fs = require("fs");
+
+var _path = require("path");
+
+var _allCommandsConfigs = _interopRequireDefault(require("./allCommandsConfigs"));
+
+var _buildToolLoggers = require("./buildToolLoggers");
+
+var _readOptions = require("./shared/schemas/readOptions");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function runCommand(commandConfig) {
+  const options = (0, _readOptions.getOptions)();
+  const {
+    dirname
+  } = commandConfig;
+
+  function runRespectiveFile(name, data) {
+    const commandExecutorPath = (0, _path.join)(dirname, name + ".js");
+
+    if ((0, _fs.existsSync)(commandExecutorPath)) {
+      const commandExecutor = require(commandExecutorPath);
+
+      return (commandExecutor[name] || commandExecutor.default)(data);
+    } else {
+      (0, _buildToolLoggers.debugLogger)("file not found", commandExecutorPath);
+    }
+  }
+
+  const processedOption = runRespectiveFile("optionsProcesser", options) || options;
+  runRespectiveFile("deprecationHandler", processedOption); // runRespectiveFile("errorHandler", () => {
+
+  runRespectiveFile("preProcesser", processedOption);
+  runRespectiveFile("commandExecutor", processedOption);
+  runRespectiveFile("postProcesser", processedOption); // });
+}
+
+function route(option, args) {
+  // TODO:  need to modify this log
+  (0, _buildToolLoggers.debugLogger)("the command was " + option, args);
+  const commandConfig = findCommandConfig(option);
+
+  if (commandConfig) {
+    try {
+      runCommand(commandConfig);
+    } catch (error) {
+      console.error(error);
+    }
+  } else {
+    // TODO: need to  write proper error message
+    (0, _buildToolLoggers.warnLogger)("Un known command", option, "please check the document");
+  }
+}
+
+function findCommandConfig(option) {
+  for (const commandConfig of _allCommandsConfigs.default) {
+    if (commandConfig.name === option || commandConfig.alias.includes(option)) {
+      return commandConfig;
+    }
+  }
+
+  return null;
+}