@zohodesk/client_build_tool 0.0.1-0.exp.0.0.3

package/lib/schemas/defaultConfigValues.js

@@ -0,0 +1,393 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _os = require("os");
+
+// NOTE: Don't use 'config_file' as cli option it was reserved
+var _default = {
+  context: {
+    value: 'app',
+    cli: 'context'
+  },
+  devtool: 'source-map',
+  statsLogConfig: null,
+  stats: {
+    enable: {
+      value: false,
+      cli: 'enable_stats',
+      type: 'boolean'
+    },
+    fileName: null,
+    options: null,
+    excludeKeys: null
+  },
+  enableFileNameHashing: {
+    value: false,
+    cli: 'enable_hash'
+  },
+  bundleAnalyze: {
+    value: false,
+    cli: 'bundle_analyze'
+  },
+  enableMockReplace: {
+    value: false,
+    cli: 'enable_mock_replace'
+  },
+  noPublicPath: {
+    value: false,
+    cli: 'no_public_path'
+  },
+  output: {
+    value: 'build',
+    cli: 'output'
+  },
+  mode: {
+    value: null,
+    cli: 'mode'
+  },
+  printProgress: {
+    value: false,
+    cli: 'print_progress'
+  },
+  server: {
+    k8s: {
+      value: false,
+      cli: 'k8s'
+    },
+    httpsCerts: {
+      value: '',
+      cli: 'https_certs'
+    },
+    host: {
+      value: (0, _os.hostname)(),
+      cli: 'host'
+    },
+    port: {
+      value: 9090,
+      cli: 'port'
+    },
+    domain: {
+      value: null,
+      cli: 'domain'
+    },
+    disableContextURL: {
+      value: false,
+      cli: 'disable_context'
+    }
+  },
+  mockServer: {
+    enable: {
+      value: false,
+      cli: 'enable_mock'
+    },
+    separateSeverPort: {
+      value: null,
+      cli: 'mock_port'
+    },
+    disableNodemon: {
+      value: false,
+      cli: 'disable_nodemon'
+    },
+    mockEntryFile: 'mockapi/index.js',
+    mockPrefix: {
+      value: '/api',
+      cli: 'mock_prefix'
+    }
+  },
+  css: {
+    classNameOptions: {
+      customizations: [{
+        enable: true,
+        blob: '[local]',
+        patterns: ['*.plain.css']
+      }, {
+        enable: true,
+        blob: '[prefix]-[filename]-[local]',
+        patterns: []
+      }],
+      classNamePrefix: 'zd'
+    },
+    // NOTE: Suggestions
+    // Name Suggestions  `customizations` this will be easier then `plugin` to understand for developers
+    plugins: {
+      rtlSplit: {
+        enableRTLSplit: {
+          value: false,
+          cli: 'enable_rtl_split'
+        },
+        templateLabel: '{{--dir}}',
+        disableMinifySelector: false,
+        dirVarName: 'document.dir'
+      },
+      selectorWeight: {
+        enable: false,
+        patterns: [],
+        configFile: null,
+        defaultSelector: '',
+        customFileDetails: '',
+        excludeStrings: []
+      },
+      // postcss plugins start
+      // NOTE: These we have putted names of post-css-plugins in array
+      // packages/client_build_tool/src/shared/bundler/webpack/custom_postcss_loaders/PostCssOptionConstants.js
+      valueReplacer: {
+        enable: false,
+        patterns: [],
+        config: []
+      },
+      selectorReplace: {
+        enable: false,
+        patterns: [],
+        before: [],
+        after: []
+      },
+      hoverActive: {
+        enable: false,
+        patterns: [],
+        hover: '(hover: hover)',
+        active: '(hover: none)'
+      },
+      cssVariableReplacement: {
+        enable: false,
+        patterns: [],
+        configFile: null
+      },
+      rtl: {
+        enable: false,
+        patterns: []
+      } // postcss - plugins end
+
+    },
+    customPlugins: ['...']
+  },
+  i18nChunkSplit: {
+    chunkSplitEnable: {
+      value: false,
+      cli: 'i18n_split'
+    },
+    disableDefault: false,
+    templateLabel: '{{--user-locale}}',
+    localeVarName: 'document.documentElement.lang',
+    jsonpFunc: 'console.log',
+    jsResource: null,
+    propertiesFolder: null
+  },
+  i18nIndexing: {
+    enable: {
+      value: false,
+      cli: 'i18n_idx_enable'
+    },
+    disableDefaultMerge: {
+      value: false,
+      cli: 'i18n_idx_disable_default_merge'
+    },
+    htmlTemplateLabel: {
+      value: '{{--user-locale}}',
+      cli: 'i18n_idx_html_template_label'
+    },
+    localeVarName: {
+      value: 'window.userLangCode',
+      cli: 'i18n_idx_locale_var_name'
+    },
+    jsResourcePath: {
+      value: './deskapp/properties/JSResources.properties',
+      cli: 'i18n_idx_js_resource_path'
+    },
+    propertiesFolderPath: {
+      value: './deskapp/properties',
+      cli: 'i18n_idx_properties_folder_path'
+    },
+    propertiesPattern: {
+      value: ''
+    },
+    numericMapPath: {
+      value: './deskapp/properties/i18n-numeric-map.json',
+      cli: 'i18n_idx_numeric_map_path'
+    },
+    jsonpFunc: {
+      value: 'window.loadI18nData',
+      cli: 'i18n_idx_jsonp_func'
+    },
+    fallbackToHash: {
+      value: true,
+      cli: 'i18n_idx_fallback_to_hash'
+    }
+  },
+  publicFolders: ['...'],
+  app: {
+    entryFile: {
+      value: 'src/index.js',
+      cli: 'entry'
+    }
+  },
+  resolve: {
+    preferLocalFirst: false,
+    defaultAlias: true,
+    moduleResolvePath: {
+      value: '',
+      cli: 'module_resolve_path'
+    },
+    alias: null
+  },
+  htmlTemplate: {
+    crossorigin: {
+      value: false,
+      cli: 'enable_crossorigin'
+    },
+    templateFile: {
+      value: 'src/index.html',
+      cli: 'initial_html'
+    },
+    minify: null,
+    inject: true
+  },
+  efc: {
+    hasEFC: {
+      value: false,
+      cli: 'enable_efc',
+      type: 'boolean'
+    },
+    entryPointName: 'efc',
+    entryFile: {
+      value: 'src/efc.js',
+      cli: 'efc_entry'
+    },
+    version: {
+      value: 'v1',
+      cli: 'efc_version'
+    },
+    createSDkFile: {
+      value: false,
+      cli: 'create_efc_sdk'
+    },
+    templateFilePath: 'efcTemplate.js',
+    outputFile: {
+      value: 'efc-sdk-[version].js',
+      cli: 'efc_output'
+    },
+    resourceCleanup: {
+      value: false,
+      cli: 'enable_efc_resource_cleanup',
+      type: 'boolean'
+    }
+  },
+  createSeparateSMap: {
+    value: false,
+    cli: 'enable_smap'
+  },
+  babelCustomizations: {
+    browserList: null,
+    // NOTE: need to consider
+    // presets: [],
+    plugins: [],
+    removeAttribute: {
+      enable: false,
+      options: {
+        attributeNames: ['data-testid']
+      }
+    },
+    removePropTypes: {
+      enable: false,
+      options: {
+        mode: 'remove',
+        removeImport: true
+      }
+    },
+    devConsoleExclude: {
+      enable: {
+        value: false,
+        cli: 'console_exclude'
+      },
+      options: {
+        exclude: ['error']
+      }
+    }
+  },
+  webpackPlugins: [],
+  vendorPatterns: [],
+  customChunksBaseConfig: null,
+  customChunks: [{
+    name: 'styles',
+    patterns: ['*.css']
+  }],
+  cdnMapping: {
+    isCdnEnabled: {
+      value: false,
+      cli: 'enable_cdn'
+    },
+    variableName: '',
+    cssTemplate: '',
+    jsTemplate: '',
+    i18nTemplate: ''
+  },
+  manifestJson: {
+    enable: false,
+    i18nManifestJson: false,
+    licenseManifest: false
+  },
+  changeRuntimeChunkChar: '~',
+  serviceWorker: {
+    enable: false,
+    templateFilePath: 'sw.js',
+    outputFilePath: '/v1.js',
+    replaceText: '//<!--AssetsFromBuild -->'
+  },
+  customLoaders: [],
+  resourceHints: {
+    allowPrefetchingMultipleChunks: false
+  },
+  devModeContentHashAllowedTypes: null,
+  nameTemplateCustomization: null,
+  devLikeHash: {
+    value: false,
+    cli: 'dev_like_hash'
+  },
+  disableReactDevWarning: {
+    value: false,
+    cli: 'disable_react_dev_warning'
+  },
+  preProcess: {
+    enable: {
+      value: false,
+      cli: 'enable_pre_process'
+    },
+    // This option is for tell the CBT to which is preprocessor js file path
+    runner: {
+      value: '',
+      cli: 'preprocessor'
+    },
+    // usually preprocessor run in nodemon for, start and docs , preprocessor
+    stopNodemon: {
+      value: false,
+      cli: 'stop_nodemon'
+    }
+  },
+  fileHashMappingToVariable: null,
+  customAttributes: {
+    enable: false,
+    attributes: null,
+    jsAttributes: null,
+    cssAttributes: null,
+    i18nAttributes: null
+  },
+  externals: null,
+  typeScript: {
+    enable: {
+      value: false,
+      cli: 'type_script_enable'
+    }
+  },
+  optimization: {
+    jsExcludePath: '',
+    cssExcludePath: ''
+  },
+  customScriptLoadingStrategey: {
+    enable: false,
+    options: null
+  }
+};
+exports.default = _default;

package/lib/schemas/defaultConfigValuesOnly.js

@@ -0,0 +1,200 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _os = require("os");
+
+// NOTE: Don't use 'config_file' as cli option it was reserved
+var _default = {
+  context: 'app',
+  devtool: 'hidden-cheap-source-map',
+  enableFileNameHashing: false,
+  bundleAnalyze: false,
+  enableMockReplace: false,
+  noPublicPath: false,
+  output: 'build',
+  mode: null,
+  printProgress: false,
+  server: {
+    httpsCerts: '@zohodesk-private/client_dev_cert',
+    host: (0, _os.hostname)(),
+    port: 9090,
+    domain: 'tsi',
+    disableContextURL: false
+  },
+  mockServer: {
+    enable: false,
+    separateSeverPort: 5000,
+    disableNodemon: false,
+    mockEntryFile: 'mockapi/index.js',
+    mockPrefix: '/api/'
+  },
+  css: {
+    classNameOptions: {
+      customizations: [{
+        enable: true,
+        blob: '[local]',
+        patterns: ['*.plain.css']
+      }, {
+        enable: true,
+        blob: '[prefix]-[filename]-[local]',
+        patterns: []
+      }],
+      classNamePrefix: 'zd'
+    },
+    // NOTE: Suggestions
+    // Name Suggestions  `customizations` this will be easier then `plugin` to understand for developers
+    plugins: {
+      rtlSplit: {
+        enableRTLSplit: false,
+        templateLabel: '{{--dir}}',
+        disableMinifySelector: false,
+        dirVarName: 'document.dir'
+      },
+      selectorWeight: {
+        enable: false,
+        patterns: [],
+        configFile: null,
+        defaultSelector: '',
+        customFileDetails: '',
+        excludeStrings: []
+      },
+      selectorReplace: {
+        enable: false,
+        patterns: [],
+        before: [],
+        after: []
+      },
+      hoverActive: {
+        enable: false,
+        patterns: [],
+        hover: '(hover: hover)',
+        active: '(hover: none)'
+      },
+      cssVariableReplacement: {
+        enable: false,
+        patterns: [],
+        configFile: null
+      },
+      rtl: {
+        enable: false,
+        patterns: []
+      } // postcss - plugins end
+
+    },
+    customPlugins: []
+  },
+  i18nChunkSplit: {
+    chunkSplitEnable: false,
+    disableDefault: false,
+    templateLabel: '{{--user-locale}}',
+    localeVarName: 'document.documentElement.lang',
+    jsonpFunc: 'console.log',
+    jsResource: null,
+    propertiesFolder: null
+  },
+  i18nIndexing: {
+    enable: false,
+    disableDefaultMerge: false,
+    htmlTemplateLabel: '{{--user-locale}}',
+    localeVarName: 'window.userLangCode',
+    jsResourcePath: './deskapp/properties/JSResources.properties',
+    propertiesFolderPath: './deskapp/properties',
+    propertiesPattern: '',
+    numericMapPath: './deskapp/properties/i18n-numeric-map.json',
+    numericJsonpFunc: 'window.loadI18nChunk',
+    dynamicJsonpFunc: 'window.loadI18nChunk',
+    fallbackToHash: true
+  },
+  publicFolders: ['...', {
+    source: './deskapp/tp/',
+    target: './tp/'
+  }],
+  app: {
+    entryFile: 'src/index.js',
+    tpFolder: null,
+    moduleResolvePath: 'node_modules'
+  },
+  resolve: {
+    preferLocalFirst: false,
+    defaultAlias: true,
+    moduleResolvePath: 'node_modules',
+    alias: null
+  },
+  // EFC means Embedded Functional Components
+  efc: {
+    hasEFC: false,
+    entryPointName: 'efc',
+    entryFile: 'src/efc.js',
+    version: 'v1',
+    createSDkFile: false,
+    templateFilePath: 'efcTemplate.js',
+    outputFile: 'efc-sdk-[version].js',
+    resourceCleanup: false
+  },
+  createSeparateSMap: false,
+  babelCustomizations: {
+    browserList: null,
+    removeAttribute: {
+      enable: false,
+      options: {
+        attributeNames: ['data-testid']
+      }
+    },
+    removePropTypes: {
+      enable: false,
+      options: {
+        mode: 'remove',
+        removeImport: true
+      }
+    },
+    devConsoleExclude: {
+      enable: false,
+      options: {
+        exclude: ['error']
+      }
+    },
+    // NOTE: need to consider
+    // presets: [],
+    plugins: []
+  },
+  webpackPlugins: [],
+  vendorPatterns: [],
+  customChunks: [{
+    name: 'styles',
+    patterns: ['*.css']
+  }],
+  htmlTemplate: {
+    templateFile: 'src/index.html',
+    minify: null,
+    inject: true
+  },
+  // CDN means Content Delivery Network
+  cdnMapping: {
+    isCdnEnabled: false,
+    variableName: '',
+    cssTemplate: '',
+    jsTemplate: '',
+    i18nTemplate: ''
+  },
+  manifestJson: {
+    enable: true
+  },
+  changeRuntimeChunkChar: '~',
+  serviceWorker: {
+    enable: false,
+    templateFilePath: 'sw.js',
+    outputFilePath: '/v1.js',
+    replaceText: '//<!--AssetsFromBuild -->'
+  },
+  stats: {
+    enable: false,
+    fileName: null,
+    options: null,
+    excludeKeys: null
+  }
+};
+exports.default = _default;

package/lib/schemas/deprecatedOptionsHandler.js

@@ -0,0 +1,67 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.deprecatedOptionsHandler = deprecatedOptionsHandler;
+
+var _logger = require("../logger");
+
+function nestedSelect(obj, key) {
+  let temp = obj;
+  const keys = key.split('.');
+
+  for (let i = 0; i < keys.length && temp; i++) {
+    const element = keys[i];
+    temp = temp[element];
+  }
+
+  return temp;
+}
+
+function nestedUpdate(obj, key, value) {
+  let temp = obj;
+  const keys = key.split('.');
+  let i = 0;
+
+  for (; i < keys.length - 1 && temp; i++) {
+    const element = keys[i];
+    temp = temp[element];
+  }
+
+  if (temp) {
+    temp[keys[i]] = value;
+  }
+}
+
+function deprecatedOptionsHandler(options) {
+  function checkAndUpdateAndPrintWaring(oldKey, newkey) {
+    const oldVal = nestedSelect(options, oldKey);
+    const newVal = nestedSelect(options, newkey); // console.log({ oldVal, newVal });
+
+    if (oldVal !== undefined && newVal === undefined) {
+      nestedUpdate(options, newkey, newVal);
+      (0, _logger.warnLogger)(`"${oldKey}" deprecated use "${newkey}" instead`);
+    }
+  } // return;
+
+
+  checkAndUpdateAndPrintWaring('app.context', 'context'); // TODO handle deprecations  here
+  // we will finish this logic later when options are confirmed
+
+  if (nestedSelect(options, 'app.hasRTL') === true) {
+    nestedUpdate(options, 'app.plugins.hasRTL', true);
+  }
+
+  if (nestedSelect(options, 'docs.hasRTL') === true) {
+    nestedUpdate(options, 'docs.plugins.hasRTL', true);
+  }
+
+  if (nestedSelect(options, 'app.rtlExclude.length') > 0) {
+    nestedUpdate(options, 'app.exclude.rtl', nestedSelect(options, 'app.rtlExclude'));
+  }
+
+  if (nestedSelect(options, 'docs.rtlExclude.length') > 0) {
+    nestedUpdate(options, 'docs.exclude.rtl', nestedSelect(options, 'docs.rtlExclude'));
+  }
+}

package/lib/schemas/getNpmVersion.js

@@ -0,0 +1,22 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getNpmVersion = getNpmVersion;
+
+var _child_process = require("child_process");
+
+var _logger = require("../logger");
+
+function getNpmVersion() {
+  let vers = '6';
+
+  try {
+    [vers] = (0, _child_process.execSync)('npm -v').toString().trim().split('.');
+  } catch (error) {
+    (0, _logger.messageLogger)(error);
+  }
+
+  return vers;
+}

package/lib/schemas/giveDefaultValue.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.giveDefaultValue = giveDefaultValue;
+
+function giveDefaultValue(value) {
+  if (value === true || value === 'true') {
+    return true;
+  }
+
+  if (value === false || value === 'false' || value === '') {
+    return false;
+  }
+
+  return value;
+}