Merge pull request #2251 from contentstack/feat/dx-3734

Removed deprecated code from import setup plugin

Author: netrajpatel

package-lock.json

@@ -8,7 +8,6 @@
         "sourceType": "module"
     },
     "extends": [
-        "oclif-typescript",
         "plugin:@typescript-eslint/recommended"
     ],
     "rules": {

packages/contentstack-import-setup/.eslintrc

@@ -69,14 +69,14 @@ USAGE
   $ csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]
 
 FLAGS
-  -B, --branch=<value>         The name of the branch where you want to import your content. If you don't mention the
-                               branch name, then by default the content will be imported to the main branch.
   -a, --alias=<value>          The management token of the destination stack where you will import the content.
   -d, --data-dir=<value>       The path or the location in your file system where the content, you intend to import, is
                                stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the export folder has
                                branches involved, then the path should point till the particular branch. For example,
                                “-d "C:\Users\Name\Desktop\cli\content\branch_name"
   -k, --stack-api-key=<value>  API key of the target stack
+      --branch=<value>         The name of the branch where you want to import your content. If you don't mention the
+                               branch name, then by default the content will be imported to the main branch.
       --branch-alias=<value>   Specify the branch alias where you want to import your content. If not specified, the
                                content is imported into the main branch by default.
       --module=<option>...     [optional] Specify the modules/module to import into the target stack. currently options
@@ -87,11 +87,7 @@ DESCRIPTION
   Helps to generate mappers and backup folder for importing (overwriting) specific modules
 
 EXAMPLES
-  $ csdx cm:stacks:import-setup --stack-api-key <target_stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name>
-
-  $ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name>
-
-  $ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name> -b <branch_name>
+  $ csdx cm:stacks:import-setup --stack-api-key <target_stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name> --branch <branch_name>
 ```
 
 _See code: [src/commands/cm/stacks/import-setup.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-import-setup/src/commands/cm/stacks/import-setup.ts)_

packages/contentstack-import-setup/README.md

@@ -24,6 +24,7 @@
     "@types/mkdirp": "^1.0.2",
     "@types/mocha": "^8.2.3",
     "@types/node": "^14.18.63",
+    "@types/proxyquire": "^1.3.31",
     "@types/rewire": "^2.5.30",
     "@types/tar": "^6.1.13",
     "@types/uuid": "^9.0.8",
@@ -34,6 +35,7 @@
     "mocha": "^10.8.2",
     "nyc": "^15.1.0",
     "oclif": "^4.17.46",
+    "proxyquire": "^2.1.3",
     "rewire": "^9.0.1",
     "ts-node": "^10.9.2",
     "tsx": "^4.20.3",

packages/contentstack-import-setup/package.json

@@ -2,7 +2,6 @@ import path from 'node:path';
 import { Command } from '@contentstack/cli-command';
 import {
   messageHandler,
-  printFlagDeprecation,
   managementSDKClient,
   flags,
   FlagInput,
@@ -21,9 +20,7 @@ export default class ImportSetupCommand extends Command {
   );
 
   static examples: string[] = [
-    `csdx cm:stacks:import-setup --stack-api-key <target_stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name>`,
-    `csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name>`,
-    `csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name> -b <branch_name>`,
+    `csdx cm:stacks:import-setup --stack-api-key <target_stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name> --branch <branch_name>`,
   ];
 
   static flags: FlagInput = {
@@ -46,27 +43,25 @@ export default class ImportSetupCommand extends Command {
       multiple: true,
     }),
     branch: flags.string({
-      char: 'B',
       description:
         "The name of the branch where you want to import your content. If you don't mention the branch name, then by default the content will be imported to the main branch.",
-      parse: printFlagDeprecation(['-B'], ['--branch']),
-      exclusive: ['branch-alias']
+      exclusive: ['branch-alias'],
     }),
     'branch-alias': flags.string({
       description:
-        "Specify the branch alias where you want to import your content. If not specified, the content is imported into the main branch by default.",
+        'Specify the branch alias where you want to import your content. If not specified, the content is imported into the main branch by default.',
       exclusive: ['branch'],
     }),
   };
 
-  static aliases: string[] = ['cm:import-setup'];
+  static aliases: string[] = [];
 
-  static usage: string = 'cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]';
+  static usage = 'cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]';
 
   async run(): Promise<void> {
     try {
       const { flags } = await this.parse(ImportSetupCommand);
-      let importSetupConfig = await setupImportConfig(flags);
+      const importSetupConfig = await setupImportConfig(flags);
       // Note setting host to create cma client
       importSetupConfig.host = this.cmaHost;
       importSetupConfig.region = this.region;

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

@@ -1,13 +1,12 @@
 import { ImportConfig, Modules } from '../types';
 import { backupHandler, log, setupBranchConfig } from '../utils';
 import { ContentstackClient } from '@contentstack/cli-utilities';
-import { validateBranch } from '../utils';
 
 export default class ImportSetup {
   protected config: ImportConfig;
-  private managementAPIClient: ContentstackClient;
-  private importConfig: ImportConfig;
-  private stackAPIClient: any;
+  private readonly managementAPIClient: ContentstackClient;
+  private readonly importConfig: ImportConfig;
+  private readonly stackAPIClient: any;
   public dependencyTree: { [key: string]: string[] } = {};
 
   constructor(config: ImportConfig, managementAPIClient: ContentstackClient) {
@@ -35,7 +34,7 @@ export default class ImportSetup {
       visited.add(module);
       const dependencies: Modules[] = this.config.modules[module]?.dependencies || [];
 
-      let allDeps: Modules[] = [...dependencies];
+      const allDeps: Modules[] = [...dependencies];
 
       for (const dependency of dependencies) {
         allDeps.push(...getAllDependencies(dependency as ModulesKey));
@@ -53,7 +52,9 @@ export default class ImportSetup {
       this.dependencyTree[module] = allDependencies;
 
       // Mark these dependencies as assigned so they won't be included in later modules
-      allDependencies.forEach((dep) => assignedDependencies.add(dep));
+      for (const dep of allDependencies) {
+        assignedDependencies.add(dep);
+      }
     }
   }
 
@@ -107,7 +108,7 @@ export default class ImportSetup {
       await this.generateDependencyTree();
       await this.runModuleImports();
     } catch (error) {
-      console.log(error);
+      log(this.config, `Error during import setup: ${error instanceof Error ? error.message : String(error)}`, 'error');
       throw error;
     }
   }

packages/contentstack-import-setup/src/import/import-setup.ts

@@ -89,7 +89,7 @@ export default class AssetImportSetup extends BaseImportSetup {
       });
 
       if (chunk) {
-        let apiContent = orderBy(values(chunk as Record<string, any>[]), '_version');
+        const apiContent = orderBy(values(chunk as Record<string, any>[]), '_version');
 
         await this.makeConcurrentCall(
           {

packages/contentstack-import-setup/src/import/modules/assets.ts

@@ -18,7 +18,7 @@ export default class TaxonomiesImportSetup {
   private taxonomiesMapperDirPath: string;
   private termsMapperDirPath: string;
   private localesFilePath: string;
-  private isLocaleBasedStructure: boolean = false;
+  private isLocaleBasedStructure = false;
   public taxonomiesMapper: Record<string, unknown> = {};
   public termsMapper: Record<string, unknown> = {};
   public masterLocaleFilePath: string;

packages/contentstack-import-setup/src/import/modules/taxonomies.ts

@@ -62,7 +62,7 @@ export interface InquirePayload {
   name: string;
   message: string;
   choices?: Array<any>;
-  transformer?: Function;
+  transformer?: (...args: any[]) => any;
 }
 
 export interface User {

packages/contentstack-import-setup/src/types/index.ts

@@ -4,7 +4,7 @@ import mkdirp from 'mkdirp';
 import * as bigJSON from 'big-json';
 import { FsUtility, sanitizePath } from '@contentstack/cli-utilities';
 
-export const readFileSync = function (filePath: string, parse: boolean = true): any {
+export const readFileSync = function (filePath: string, parse = true): any {
   let data;
   filePath = path.resolve(sanitizePath(filePath));
   if (fs.existsSync(filePath)) {
@@ -87,7 +87,7 @@ export const writeLargeFile = function (filePath: string, data: any): Promise<an
     const stringifyStream = bigJSON.createStringifyStream({
       body: data,
     });
-    var writeStream = fs.createWriteStream(filePath, 'utf-8');
+    const writeStream = fs.createWriteStream(filePath, 'utf-8');
     stringifyStream.pipe(writeStream);
     writeStream.on('finish', () => {
       resolve('');
@@ -98,9 +98,9 @@ export const writeLargeFile = function (filePath: string, data: any): Promise<an
   });
 };
 
-export const makeDirectory = function (dir: string): void {
-  for (let key in arguments) {
-    const dirname = path.resolve(arguments[key]);
+export const makeDirectory = function (...dirs: string[]): void {
+  for (const dir of dirs) {
+    const dirname = path.resolve(dir);
     if (!fs.existsSync(dirname)) {
       mkdirp.sync(dirname);
     }