@contentstack/cli-migration 1.4.2 → 1.5.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Contentstack
+Copyright (c) 2024 Contentstack
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -5,7 +5,7 @@ The Contentstack CLI’s “Migration” plugin allows developers to automate th
 [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
 [![Version](https://img.shields.io/npm/v/@contentstack/cli-migration.svg)](https://npmjs.org/package/@contentstack/cli-migration)
 [![Downloads/week](https://img.shields.io/npm/dw/@contentstack/cli-migration.svg)](https://npmjs.org/package/@contentstack/cli-migration)
-[![License](https://img.shields.io/npm/l/@contentstack/cli-migration.svg)](https://github.com/ninadhatkar/cli-migration/blob/master/package.json)
+[![License](https://img.shields.io/npm/l/@contentstack/cli-migration.svg)](https://github.com/***REMOVED***/cli-migration/blob/master/package.json)
 
 <!-- toc -->
 * [@contentstack/cli-migration](#contentstackcli-migration)
@@ -21,7 +21,7 @@ $ npm install -g @contentstack/cli-migration
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-migration/1.4.2 darwin-arm64 node-v20.8.0
+@contentstack/cli-migration/1.5.1 darwin-arm64 node-v20.8.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@contentstack/cli-migration",
-  "version": "1.4.2",
+  "version": "1.5.1",
   "author": "@contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
     "@contentstack/cli-command": "~1.2.16",
-    "@contentstack/cli-utilities": "~1.5.9",
+    "@contentstack/cli-utilities": "~1.6.0",
     "async": "^3.2.4",
     "callsites": "^3.1.0",
     "cardinal": "^2.1.1",
@@ -16,13 +16,13 @@
     "winston": "^3.7.2"
   },
   "devDependencies": {
-    "@oclif/test": "^2.2.10",
+    "@oclif/test": "^2.5.6",
     "chai": "^4.3.4",
     "eslint": "^8.18.0",
     "globby": "^10.0.2",
     "husky": "^8.0.3",
     "jsdoc": "^4.0.0",
-    "jsdoc-to-markdown": "^7.0.1",
+    "jsdoc-to-markdown": "^8.0.0",
     "mkdirp": "^1.0.4",
     "nock": "^13.1.1",
     "nyc": "^15.1.0",
@@ -66,4 +66,4 @@
       "cm:migration": "O-MGRTN"
     }
   }
-}
+}

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

@@ -12,7 +12,13 @@ const { Parser } = require('../../../modules');
 const { ActionList } = require('../../../actions');
 const fs = require('fs');
 const chalk = require('chalk');
-const { printFlagDeprecation, managementSDKClient, flags, isAuthenticated } = require('@contentstack/cli-utilities');
+const {
+  printFlagDeprecation,
+  managementSDKClient,
+  flags,
+  isAuthenticated,
+  pathValidator,
+} = require('@contentstack/cli-utilities');
 
 const { ApiError, SchemaValidator, MigrationError, FieldValidator } = require('../../../validators');
 
@@ -77,7 +83,7 @@ class MigrationCommand extends Command {
       let configObj = config.reduce((a, v) => {
         //NOTE: Temp code to handle only one spilt(Window absolute path issue).Need to replace with hardcoded config key
         let [key, ...value] = v.split(':');
-        value = value?.length > 1 ? value?.join(':') : value?.join( );
+        value = value?.length > 1 ? value?.join(':') : value?.join();
         return { ...a, [key]: value };
       }, {});
       set('config', mapInstance, configObj);
@@ -132,7 +138,7 @@ class MigrationCommand extends Command {
 
   async execSingleFile(filePath, mapInstance) {
     // Resolved absolute path
-    const resolvedMigrationPath = resolve(filePath);
+    const resolvedMigrationPath = pathValidator(filePath);
     // User provided migration function
     const migrationFunc = require(resolvedMigrationPath);
 
@@ -166,15 +172,15 @@ class MigrationCommand extends Command {
         this.log(error.message);
       } else if (error.errorMessage) {
         this.log(error.errorMessage);
-      }else{
-        this.log(error)
+      } else {
+        this.log(error);
       }
     }
   }
 
   async execMultiFiles(filePath, mapInstance) {
     // Resolved absolute path
-    const resolvedMigrationPath = resolve(filePath);
+    const resolvedMigrationPath = pathValidator(filePath);
     try {
       const files = fs.readdirSync(resolvedMigrationPath);
       for (const element of files) {
@@ -182,7 +188,7 @@ class MigrationCommand extends Command {
         if (extname(file) === '.js') {
           success(chalk`{white Executing file:} {grey {bold ${file}}}`);
           // eslint-disable-next-line no-await-in-loop
-          await this.execSingleFile(resolve(filePath, file), mapInstance);
+          await this.execSingleFile(pathValidator(resolve(filePath, file)), mapInstance);
         }
       }
     } catch (error) {

package/src/utils/callsite.js

@@ -2,9 +2,10 @@
 
 const getCallsites = require('callsites');
 const { parse, resolve } = require('path');
+const { pathValidator } = require('@contentstack/cli-utilities');
 
 function getFileDirectory(path) {
-  const parentPath = resolve(path, '../'); // Assuming that will be 2 folders up
+  const parentPath = pathValidator(resolve(path, '../')); // Assuming that will be 2 folders up
   return parse(parentPath).dir;
 }
 

package/src/utils/error-helper.js

@@ -1,6 +1,7 @@
 const { highlight } = require('cardinal');
 const { keys } = Object;
 const chalk = require('chalk');
+const isEmpty = require('lodash/isEmpty')
 
 const { readFile } = require('./fs-helper');
 const groupBy = require('./group-by');
@@ -50,10 +51,11 @@ module.exports = (errors) => {
 
     messages.push(`${fileErrorsMessage}${errorMessages}`);
   }
-  // eslint-disable-next-line
-  // console.error(chalk`{red.bold Validation failed}\n\n`);
-  // eslint-disable-next-line
-  console.log(messages.join('\n'));
+  if (isEmpty(messages) && errors !== undefined && isEmpty(errorsByFile)) {
+    console.error('Migration error---', errors);
+  } else {
+    console.log(messages.join('\n'));
+  }
   // eslint-disable-next-line
   console.log(chalk`{bold.red Migration unsuccessful}`);
 };

package/src/utils/fs-helper.js

@@ -2,6 +2,7 @@
 
 const { existsSync, mkdirSync, readFileSync, readFile } = require('fs');
 const path = require('path');
+const { pathValidator } = require('@contentstack/cli-utilities');
 
 exports.makeDir = (dirname) => {
   !this.existsSync(dirname) && mkdirSync(dirname);
@@ -16,7 +17,7 @@ exports.readFile = (filePath) => {
 
 exports.readJSONFile = (filePath) => {
   return new Promise((resolve, reject) => {
-    filePath = path.resolve(filePath);
+    filePath = pathValidator(filePath);
     readFile(filePath, 'utf-8', (error, data) => {
       if (error) {
         reject(error);

package/src/utils/logger.js

@@ -4,6 +4,7 @@ const { createLogger, format, transports } = require('winston');
 const { resolve, join } = require('path');
 const { slice } = Array.prototype;
 const { stringify } = JSON;
+const { pathValidator } = require('@contentstack/cli-utilities');
 
 const { combine, label, printf, colorize } = format;
 
@@ -32,7 +33,7 @@ function init(logFileName) {
   // Create dir if does not exist
   makeDir(logsDir);
 
-  const logPath = join(logsDir, logFileName + '.log');
+  const logPath = pathValidator(join(logsDir, logFileName + '.log'));
   const logger = createLogger({
     format: combine(colorize(), label({ label: 'Migration' }), customFormat),
     transports: [new transports.File({ filename: logPath }), new transports.Console()],