DX - 56 - Flags introduction for excluding the global modules

packages/contentstack-clone/package.json

@@ -7,7 +7,7 @@
   "dependencies": {
     "@colors/colors": "^1.5.0",
     "@contentstack/cli-cm-export": "~1.11.4",
-    "@contentstack/cli-cm-import": "~1.15.7",
+    "@contentstack/cli-cm-import": "~1.16.0",
     "@contentstack/cli-command": "~1.2.18",
     "@contentstack/cli-utilities": "~1.6.2",
     "async": "^3.2.4",

packages/contentstack-import/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-cm-import",
   "description": "Contentstack CLI plugin to import content into stack",
-  "version": "1.15.7",
+  "version": "1.16.0",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {

packages/contentstack-import/src/commands/cm/stacks/import.ts

@@ -109,6 +109,12 @@ export default class ImportCommand extends Command {
     'skip-audit': flags.boolean({
       description: 'Skips the audit fix.',
     }),
+    'exclude-global-modules': flags.boolean({
+      description: 'Excluded the Module that are branch independent from the import',
+    }),
+    'mapper-dir': flags.string({
+      description: 'path of backup directory for base branch import',
+    }),
   };
 
   static aliases: string[] = ['cm:import'];

packages/contentstack-import/src/config/index.ts

@@ -394,7 +394,8 @@ const config: DefaultConfig = {
     returnResponse: true, // On process completion should return config used in the command
     noTerminalOutput: false, // Skip final audit table output on terminal
     config: { basePath: '' }, // To overwrite any build-in config. And this config is equal to --config flag.
-  }
+  },
+  globalModules: ['taxonomies', 'environments', 'marketplace-apps', 'webhooks'],
 };
 
 export default config;

packages/contentstack-import/src/import/module-importer.ts

@@ -103,6 +103,10 @@ class ModuleImporter {
   async importAllModules(): Promise<any> {
     // use the algorithm to determine the parallel and sequential execution of modules
     for (let moduleName of this.importConfig.modules.types) {
+      if (this.importConfig.globalModules.includes(moduleName) && this.importConfig['exclude-global-modules']) {
+        log(this.importConfig, `Skipping the import for '${moduleName}' ...`,'warn');
+        continue;
+      }
       await this.importByModuleByName(moduleName);
     }
   }

packages/contentstack-import/src/import/modules/content-types.ts

@@ -65,8 +65,18 @@ export default class ContentTypesImport extends BaseClass {
     this.cTsSuccessPath = path.join(sanitizePath(this.cTsMapperPath), 'success.json');
     this.gFsFolderPath = path.resolve(sanitizePath(this.importConfig.data), sanitizePath(this.gFsConfig.dirName));
     this.gFsMapperFolderPath = path.join(sanitizePath(importConfig.data), 'mapper', 'global_fields', 'success.json');
-    this.gFsPendingPath = path.join(sanitizePath(importConfig.data), 'mapper', 'global_fields', 'pending_global_fields.js');
-    this.marketplaceAppMapperPath = path.join(sanitizePath(this.importConfig.data), 'mapper', 'marketplace_apps', 'uid-mapping.json');
+    this.gFsPendingPath = path.join(
+      sanitizePath(importConfig.data),
+      'mapper',
+      'global_fields',
+      'pending_global_fields.js',
+    );
+    this.marketplaceAppMapperPath = path.join(
+      sanitizePath(this.importConfig.data),
+      'mapper',
+      'marketplace_apps',
+      'uid-mapping.json',
+    );
     this.ignoredFilesInContentTypesFolder = new Map([
       ['__master.json', 'true'],
       ['__priority.json', 'true'],

packages/contentstack-import/src/types/default-config.ts

@@ -157,4 +157,5 @@ export default interface DefaultConfig {
       branch?: string;
     } & Record<string, any>; // To overwrite any build-in config. And this config is equal to --config flag.
   };
+  globalModules: string[];
 }

packages/contentstack-import/src/types/import-config.ts

@@ -51,6 +51,8 @@ export default interface ImportConfig extends DefaultConfig, ExternalConfig {
   skipExisting?: boolean;
   skipAudit?: boolean;
   stackName?: string;
+  'mapper-dir'?: string;
+  'exclude-global-modules': false;
 }
 
 type branch = {

packages/contentstack-import/src/utils/backup-handler.ts

@@ -7,14 +7,19 @@ import { ImportConfig } from '../types';
 
 export default async function backupHandler(importConfig: ImportConfig): Promise<string> {
   if (importConfig.hasOwnProperty('useBackedupDir')) {
+    // await copyMapperFolder(importConfig, importConfig.useBackedupDir);
     return importConfig.useBackedupDir;
   }
 
   let backupDirPath: string;
   const subDir = isSubDirectory(importConfig);
 
   if (subDir) {
-    backupDirPath = path.resolve(sanitizePath(importConfig.contentDir), '..', '_backup_' + Math.floor(Math.random() * 1000));
+    backupDirPath = path.resolve(
+      sanitizePath(importConfig.contentDir),
+      '..',
+      '_backup_' + Math.floor(Math.random() * 1000),
+    );
     if (importConfig.createBackupDir) {
       cliux.print(
         `Warning!!! Provided backup directory path is a sub directory of the content directory, Cannot copy to a sub directory. Hence new backup directory created - ${backupDirPath}`,
@@ -37,7 +42,7 @@ export default async function backupHandler(importConfig: ImportConfig): Promise
 
   if (backupDirPath) {
     cliux.print('Copying content to the backup directory...');
-
+    await copyMapperFolder(importConfig, backupDirPath);
     return new Promise((resolve, reject) => {
       return copy(importConfig.contentDir, backupDirPath, (error: any) => {
         if (error) {
@@ -67,3 +72,25 @@ function isSubDirectory(importConfig: ImportConfig) {
   // true if both parent and child have same path
   return true;
 }
+
+/**
+ *
+ */
+
+async function copyMapperFolder(importConfig: ImportConfig, backupDirPath: string) {
+  try {
+    const mapperDir = importConfig['mapper-dir'];
+    if (!mapperDir) {
+      return;
+    }
+    const globalModules = ['taxonomies', 'environments', 'marketplace_apps', 'webhooks'];
+    const copyPromises = globalModules.map((globalModule) =>
+      copy(`${mapperDir}/mapper/${globalModule}`, `${backupDirPath}/mapper/${globalModule}`),
+    );
+    await Promise.all(copyPromises);
+    return backupDirPath;
+  } catch (error) {
+    trace(error, 'error', true);
+    throw error;
+  }
+}

packages/contentstack-import/src/utils/import-config-handler.ts

@@ -23,12 +23,9 @@ const setupConfig = async (importCmdFlags: any): Promise<ImportConfig> => {
   config.contentDir = importCmdFlags['data'] || importCmdFlags['data-dir'] || config.data || (await askContentDir());
   const pattern = /[*$%#<>{}!&?]/g;
   if (pattern.test(config.contentDir)) {
-    cliux.print(
-      `\nPlease add a directory path without any of the special characters: (*,&,{,},[,],$,%,<,>,?,!)`,
-      {
-        color: 'yellow',
-      },
-    );
+    cliux.print(`\nPlease add a directory path without any of the special characters: (*,&,{,},[,],$,%,<,>,?,!)`, {
+      color: 'yellow',
+    });
     config.contentDir = await askContentDir();
   }
   config.contentDir = config.contentDir.replace(/['"]/g, '');
@@ -81,7 +78,7 @@ const setupConfig = async (importCmdFlags: any): Promise<ImportConfig> => {
 
   if (importCmdFlags['branch']) {
     config.branchName = importCmdFlags['branch'];
-    config.branchDir = path.join(sanitizePath(config.contentDir), sanitizePath  (config.branchName));
+    config.branchDir = path.join(sanitizePath(config.contentDir), sanitizePath(config.branchName));
   }
   if (importCmdFlags['module']) {
     config.moduleName = importCmdFlags['module'];
@@ -98,6 +95,14 @@ const setupConfig = async (importCmdFlags: any): Promise<ImportConfig> => {
   config.replaceExisting = importCmdFlags['replace-existing'];
   config.skipExisting = importCmdFlags['skip-existing'];
 
+  if (importCmdFlags['mapper-dir']) {
+    config['mapper-dir'] = importCmdFlags['mapper-dir'];
+  }
+
+  if (importCmdFlags['exclude-global-modules']) {
+    config['exclude-global-modules'] = importCmdFlags['exclude-global-modules'];
+  }
+
   return config;
 };
 

packages/contentstack-seed/package.json

@@ -5,7 +5,7 @@
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-cm-import": "~1.15.7",
+    "@contentstack/cli-cm-import": "~1.16.0",
     "@contentstack/cli-command": "~1.2.18",
     "@contentstack/cli-utilities": "~1.6.2",
     "inquirer": "8.2.4",

packages/contentstack/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli",
   "description": "Command-line tool (CLI) to interact with Contentstack",
-  "version": "1.19.0",
+  "version": "1.20.0",
   "author": "Contentstack",
   "bin": {
     "csdx": "./bin/run.js"
@@ -30,7 +30,7 @@
     "@contentstack/cli-cm-export": "~1.11.4",
     "@contentstack/cli-cm-clone": "~1.10.5",
     "@contentstack/cli-cm-export-to-csv": "~1.7.1",
-    "@contentstack/cli-cm-import": "~1.15.7",
+    "@contentstack/cli-cm-import": "~1.16.0",
     "@contentstack/cli-cm-migrate-rte": "~1.4.17",
     "@contentstack/cli-cm-seed": "~1.7.5",
     "@contentstack/cli-command": "~1.2.18",