@contentstack/cli-migration 1.6.3 → 1.6.5

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @contentstack/cli-migration
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-migration/1.6.3 darwin-arm64 node-v22.8.0
+@contentstack/cli-migration/1.6.5 darwin-arm64 node-v22.2.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -45,14 +45,18 @@ USAGE
     [--config <value>] [--multiple]
 
 FLAGS
-  -B, --branch=<value>         Use this flag to add the branch name where you want to perform the migration.
-  -a, --alias=<value>          Use this flag to add the management token alias.
-  -k, --stack-api-key=<value>  With this flag add the API key of your stack.
-  --config=<value>...          [optional] inline configuration, <key1>:<value1>
-  --config-file=<value>        [optional] Path of the JSON configuration file
-  --file-path=<value>          Use this flag to provide the path of the file of the migration script provided by the
-                               user.
-  --multiple                   This flag helps you to migrate multiple content files in a single instance.
+  -B, --branch=<value>         Use this flag to add the branch name where you want to perform the migration. (target
+                               branch name)
+  -a, --alias=<value>          Use this flag to add the management token alias. You must use either the --alias flag or
+                               the --stack-api-key flag.
+  -k, --stack-api-key=<value>  Use this flag to add the API key of your stack. You must use either the --stack-api-key
+                               flag or the --alias flag.
+  --config=<value>...          [optional] Inline configuration, <key1>:<value1>. Passing an external configuration makes
+                               the script re-usable.
+  --config-file=<value>        [optional] Path of the JSON configuration file.
+  --file-path=<value>          Use this flag to provide the path of the file of the migration script.
+  --multiple                   This flag helps you to migrate multiple content files in a single instance. Mention the
+                               folder path where your migration script files are stored.
 
 DESCRIPTION
   Contentstack migration script.
@@ -84,14 +88,18 @@ USAGE
     [--config <value>] [--multiple]
 
 FLAGS
-  -B, --branch=<value>         Use this flag to add the branch name where you want to perform the migration.
-  -a, --alias=<value>          Use this flag to add the management token alias.
-  -k, --stack-api-key=<value>  With this flag add the API key of your stack.
-  --config=<value>...          [optional] inline configuration, <key1>:<value1>
-  --config-file=<value>        [optional] Path of the JSON configuration file
-  --file-path=<value>          Use this flag to provide the path of the file of the migration script provided by the
-                               user.
-  --multiple                   This flag helps you to migrate multiple content files in a single instance.
+  -B, --branch=<value>         Use this flag to add the branch name where you want to perform the migration. (target
+                               branch name)
+  -a, --alias=<value>          Use this flag to add the management token alias. You must use either the --alias flag or
+                               the --stack-api-key flag.
+  -k, --stack-api-key=<value>  Use this flag to add the API key of your stack. You must use either the --stack-api-key
+                               flag or the --alias flag.
+  --config=<value>...          [optional] Inline configuration, <key1>:<value1>. Passing an external configuration makes
+                               the script re-usable.
+  --config-file=<value>        [optional] Path of the JSON configuration file.
+  --file-path=<value>          Use this flag to provide the path of the file of the migration script.
+  --multiple                   This flag helps you to migrate multiple content files in a single instance. Mention the
+                               folder path where your migration script files are stored.
 
 DESCRIPTION
   Contentstack migration script.

package/package.json

@@ -1,32 +1,27 @@
 {
   "name": "@contentstack/cli-migration",
-  "version": "1.6.3",
+  "version": "1.6.5",
   "author": "@contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "~1.3.2",
-    "@contentstack/cli-utilities": "~1.8.0",
+    "@contentstack/cli-command": "~1.3.3",
+    "@contentstack/cli-utilities": "~1.8.1",
     "async": "^3.2.6",
     "callsites": "^3.1.0",
     "cardinal": "^2.1.1",
-    "chalk": "^4.1.0",
-    "dot-object": "^2.1.5",
-    "dotenv": "^16.4.5",
+    "chalk": "^4.1.2",
+    "concat-stream": "^2.0.0",
     "listr": "^0.14.3",
-    "winston": "^3.15.0"
+    "winston": "^3.17.0"
   },
   "devDependencies": {
-    "@oclif/test": "^2.5.6",
+    "@oclif/test": "^4.1.6",
     "chai": "^4.5.0",
-    "eslint": "^8.18.0",
-    "globby": "^10.0.2",
-    "husky": "^8.0.3",
-    "jsdoc": "^4.0.3",
+    "eslint": "^8.57.1",
     "jsdoc-to-markdown": "^8.0.3",
-    "mkdirp": "^1.0.4",
-    "nock": "^13.5.5",
+    "nock": "^13.5.6",
     "nyc": "^15.1.0",
-    "oclif": "^3.11.3"
+    "oclif": "^3.17.2"
   },
   "engines": {
     "node": ">=8.3.0"

package/src/commands/cm/stacks/migration.js

@@ -246,33 +246,33 @@ MigrationCommand.description = 'Contentstack migration script.';
 MigrationCommand.flags = {
   'stack-api-key': flags.string({
     char: 'k',
-    description: 'With this flag add the API key of your stack.',
+    description: 'Use this flag to add the API key of your stack. You must use either the --stack-api-key flag or the --alias flag.',
     exclusive: ['alias'],
   }),
   alias: flags.string({
     char: 'a',
-    description: 'Use this flag to add the management token alias.',
+    description: 'Use this flag to add the management token alias. You must use either the --alias flag or the --stack-api-key flag.',
   }),
   'file-path': flags.string({
-    description: 'Use this flag to provide the path of the file of the migration script provided by the user.',
+    description: 'Use this flag to provide the path of the file of the migration script.',
   }),
   branch: flags.string({
     char: 'B',
-    description: 'Use this flag to add the branch name where you want to perform the migration.',
+    description: 'Use this flag to add the branch name where you want to perform the migration. (target branch name)',
     parse: printFlagDeprecation(['-B'], ['--branch']),
   }),
   'config-file': flags.string({
-    description: '[optional] Path of the JSON configuration file',
+    description: '[optional] Path of the JSON configuration file.',
   }),
   config: flags.string({
-    description: '[optional] inline configuration, <key1>:<value1>',
+    description: '[optional] Inline configuration, <key1>:<value1>. Passing an external configuration makes the script re-usable.',
     multiple: true,
   }),
   multiple: flags.boolean({
-    description: 'This flag helps you to migrate multiple content files in a single instance.',
+    description: 'This flag helps you to migrate multiple content files in a single instance. Mention the folder path where your migration script files are stored.',
   }),
 
-  //To be  deprecated
+  // To be deprecated
   'api-key': flags.string({
     char: 'k',
     description: 'With this flag add the API key of your stack.',
@@ -283,15 +283,14 @@ MigrationCommand.flags = {
   }),
   authtoken: flags.boolean({
     char: 'A',
-    description:
-      'Use this flag to use the auth token of the current session. After logging in CLI, an auth token is generated for each new session.',
+    description: 'Use this flag to use the auth token of the current session. After logging in CLI, an auth token is generated for each new session.',
     dependsOn: ['api-key'],
     exclusive: ['alias'],
     parse: printFlagDeprecation(['-A', '--authtoken']),
     hidden: true,
   }),
   'management-token-alias': flags.string({
-    description: 'alias of the management token',
+    description: 'Alias of the management token.',
     exclusive: ['authtoken'],
     hidden: true,
     parse: printFlagDeprecation(['--management-token-alias'], ['-a', '--alias']),

package/src/utils/modules.js

@@ -1,5 +1,5 @@
 const fs = require('fs');
-const { execFileSync } = require('child_process');
+const { spawnSync } = require('child_process');
 const path = require('path');
 const { sanitizePath } = require('@contentstack/cli-utilities');
 const os = require('os');
@@ -61,27 +61,22 @@ function installDependencies(dependencies, directory) {
     if (!internalModules.has(dep)) {
       const pkg = dep.startsWith('@') ? dep : dep.split('/')[0];
       if (!installedDependencies.has(pkg)) {
-        executeShellCommand(`npm i ${pkg}`, directory);
+        executeShellCommand(pkg, directory);
         installedDependencies.add(pkg);
       }
     }
   });
 }
 
-function executeShellCommand(command, directory = '') {
+function executeShellCommand(pkg, directory = '') {
   try {
-    if (command.startsWith('npm i')) {
-      const [cmd, ...args] = command.split(' ');
-      execFileSync(cmd, args, { stdio: 'inherit', cwd: directory });
-      console.log(`Command executed successfully: ${command}`);
-    } else {
-      console.log(`Command should only be 'npm i <package-name>'`);
-    }
+    const result = spawnSync(`npm`, ['i', pkg], { stdio: 'inherit', cwd: directory, shell: false });
+    if (result?.error) throw result.error;
+    console.log(`Command executed successfully: ${command}`);
   } catch (error) {
-    console.error(`Command execution failed. Error: ${error.message}`);
+    console.error(`Command execution failed. Error: ${error?.message}`);
   }
 }
-
 async function installModules(filePath, multiple) {
   const files = multiple ? [] : [path.basename(filePath)];
   const dirPath = multiple ? filePath : path.dirname(filePath);