Removed creation of branches.json and added warning if the given data-dir / content dir contains any file/folder

Author: cs-raj

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

@@ -2,7 +2,7 @@ import merge from 'merge';
 import * as path from 'path';
 import { configHandler, isAuthenticated, cliux, sanitizePath, log } from '@contentstack/cli-utilities';
 import defaultConfig from '../config';
-import { readFile } from './file-helper';
+import { readFile, isDirectoryNonEmpty } from './file-helper';
 import { askExportDir, askAPIKey } from './interactive';
 import login from './basic-login';
 import { filter, includes } from 'lodash';
@@ -42,6 +42,15 @@ const setupConfig = async (exportCmdFlags: any): Promise<ExportConfig> => {
   config.exportDir = config.exportDir.replace(/['"]/g, '');
   config.exportDir = path.resolve(config.exportDir);
 
+  if (exportCmdFlags['data-dir'] || exportCmdFlags['data']) {
+    if (isDirectoryNonEmpty(config.exportDir)) {
+      cliux.print(
+        '\nThe export directory is not empty. Existing files in this folder may be overwritten.',
+        { color: 'yellow' },
+      );
+    }
+  }
+
   const managementTokenAlias = exportCmdFlags['management-token-alias'] || exportCmdFlags['alias'];
 
   if (managementTokenAlias) {

packages/contentstack-export/src/utils/file-helper.ts

@@ -109,6 +109,32 @@ export const readdir = function (dirPath: string): any {
   }
 };
 
+/**
+ * Returns true if the path exists, is a directory, and contains at least one entry.
+ */
+export function isDirectoryNonEmpty(absolutePath: string): boolean {
+  if (!absolutePath || !fs.existsSync(absolutePath)) {
+    return false;
+  }
+
+  let stat: fs.Stats;
+  try {
+    stat = fs.statSync(absolutePath);
+  } catch {
+    return false;
+  }
+
+  if (!stat.isDirectory()) {
+    return false;
+  }
+
+  try {
+    return fs.readdirSync(absolutePath).length > 0;
+  } catch {
+    return false;
+  }
+}
+
 exports.fileExistsSync = function (path: string) {
   return fs.existsSync(path);
 };

packages/contentstack-export/src/utils/setup-branches.ts

@@ -1,8 +1,5 @@
-import * as path from 'path';
-import { sanitizePath } from '@contentstack/cli-utilities';
-
 import { ExportConfig } from '../types';
-import { writeFileSync, makeDirectory } from './file-helper';
+import { makeDirectory } from './file-helper';
 
 const setupBranches = async (config: ExportConfig, stackAPIClient: any) => {
   if (typeof config !== 'object') {
@@ -40,9 +37,6 @@ const setupBranches = async (config: ExportConfig, stackAPIClient: any) => {
   }
 
   makeDirectory(config.exportDir);
-  // create branch info file
-  writeFileSync(path.join(sanitizePath(config.exportDir), 'branches.json'), branches);
-  // add branches list in the
   config.branches = branches;
 };
 

packages/contentstack-export/test/unit/utils/export-config-handler.test.ts

@@ -63,6 +63,24 @@ describe('Export Config Handler', () => {
       expect(askExportDirStub.called).to.be.false;
     });
 
+    it('should print yellow warning when data-dir is set and export directory is not empty', async () => {
+      configHandlerGetStub.withArgs('authorisationType').returns('OAUTH');
+      const isNonEmptyStub = sandbox.stub(fileHelper, 'isDirectoryNonEmpty').returns(true);
+      const cliuxPrint = utilities.cliux.print as sinon.SinonStub;
+      cliuxPrint.resetHistory();
+
+      const flags = { 'data-dir': '/some/export' };
+      await setupConfig(flags);
+
+      expect(isNonEmptyStub.calledWith(path.resolve('/some/export'))).to.be.true;
+      expect(
+        cliuxPrint.calledWith(
+          '\nThe export directory is not empty. Existing files in this folder may be overwritten.',
+          { color: 'yellow' },
+        ),
+      ).to.be.true;
+    });
+
     it('should ask for export directory when not provided', async () => {
       // Set authenticated: isAuthenticated() checks configHandler.get('authorisationType')
       // Returns 'OAUTH' or 'AUTH' for authenticated, undefined for not authenticated

packages/contentstack-export/test/unit/utils/is-directory-non-empty.test.ts

@@ -0,0 +1,44 @@
+import { expect } from 'chai';
+import * as fs from 'fs';
+import * as os from 'os';
+import * as path from 'path';
+import { isDirectoryNonEmpty } from '../../../src/utils/file-helper';
+
+describe('isDirectoryNonEmpty', () => {
+  it('returns false for empty string', () => {
+    expect(isDirectoryNonEmpty('')).to.be.false;
+  });
+
+  it('returns false when path does not exist', () => {
+    expect(isDirectoryNonEmpty(path.join(os.tmpdir(), `missing-${Date.now()}-${Math.random()}`))).to.be.false;
+  });
+
+  it('returns false when directory is empty', () => {
+    const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'empty-dir-'));
+    try {
+      expect(isDirectoryNonEmpty(dir)).to.be.false;
+    } finally {
+      fs.rmSync(dir, { recursive: true });
+    }
+  });
+
+  it('returns true when directory has an entry', () => {
+    const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'nonempty-dir-'));
+    fs.writeFileSync(path.join(dir, 'a.txt'), 'x');
+    try {
+      expect(isDirectoryNonEmpty(dir)).to.be.true;
+    } finally {
+      fs.rmSync(dir, { recursive: true });
+    }
+  });
+
+  it('returns false when path is a file', () => {
+    const f = path.join(os.tmpdir(), `file-only-${Date.now()}.txt`);
+    fs.writeFileSync(f, 'x');
+    try {
+      expect(isDirectoryNonEmpty(f)).to.be.false;
+    } finally {
+      fs.unlinkSync(f);
+    }
+  });
+});

packages/contentstack-export/test/unit/utils/setup-branches.test.ts

@@ -1,16 +1,13 @@
 import { expect } from 'chai';
 import sinon from 'sinon';
-import * as path from 'node:path';
 import setupBranches from '../../../src/utils/setup-branches';
 import * as fileHelper from '../../../src/utils/file-helper';
-import * as utilities from '@contentstack/cli-utilities';
 import { ExportConfig } from '../../../src/types';
 
 describe('Setup Branches', () => {
   let sandbox: sinon.SinonSandbox;
   let mockStackAPIClient: any;
   let mockConfig: ExportConfig;
-  let writeFileSyncStub: sinon.SinonStub;
   let makeDirectoryStub: sinon.SinonStub;
 
   beforeEach(() => {
@@ -28,8 +25,6 @@ describe('Setup Branches', () => {
       branches: []
     } as Partial<ExportConfig> as ExportConfig;
 
-    // Stub file-helper functions
-    writeFileSyncStub = sandbox.stub(fileHelper, 'writeFileSync');
     makeDirectoryStub = sandbox.stub(fileHelper, 'makeDirectory');
 
   });
@@ -80,12 +75,7 @@ describe('Setup Branches', () => {
       expect(mockStackAPIClient.branch.calledWith(branchName)).to.be.true;
       expect(mockBranchClient.fetch.called).to.be.true;
       expect(makeDirectoryStub.calledWith(mockConfig.exportDir)).to.be.true;
-      expect(writeFileSyncStub.called).to.be.true;
       expect(mockConfig.branches).to.deep.equal([mockBranch]);
-      expect(writeFileSyncStub.firstCall.args[0]).to.equal(
-        path.join(mockConfig.exportDir, 'branches.json')
-      );
-      expect(writeFileSyncStub.firstCall.args[1]).to.deep.equal([mockBranch]);
     });
 
     it('should throw error when branch name is provided but branch does not exist', async () => {
@@ -105,7 +95,6 @@ describe('Setup Branches', () => {
       }
 
       expect(makeDirectoryStub.called).to.be.false;
-      expect(writeFileSyncStub.called).to.be.false;
     });
 
     it('should throw error when branch fetch returns invalid result', async () => {
@@ -167,7 +156,6 @@ describe('Setup Branches', () => {
       expect(mockBranchClient.query.called).to.be.true;
       expect(mockQuery.find.called).to.be.true;
       expect(makeDirectoryStub.calledWith(mockConfig.exportDir)).to.be.true;
-      expect(writeFileSyncStub.called).to.be.true;
       expect(mockConfig.branches).to.deep.equal(mockBranches);
     });
 
@@ -186,7 +174,6 @@ describe('Setup Branches', () => {
 
       expect(result).to.be.undefined;
       expect(makeDirectoryStub.called).to.be.false;
-      expect(writeFileSyncStub.called).to.be.false;
     });
 
     it('should return early when result has no items', async () => {
@@ -204,7 +191,6 @@ describe('Setup Branches', () => {
 
       expect(result).to.be.undefined;
       expect(makeDirectoryStub.called).to.be.false;
-      expect(writeFileSyncStub.called).to.be.false;
     });
 
     it('should return early when items is not an array', async () => {
@@ -222,7 +208,6 @@ describe('Setup Branches', () => {
 
       expect(result).to.be.undefined;
       expect(makeDirectoryStub.called).to.be.false;
-      expect(writeFileSyncStub.called).to.be.false;
     });
 
     it('should handle query errors gracefully and return early', async () => {
@@ -240,7 +225,6 @@ describe('Setup Branches', () => {
 
       expect(result).to.be.undefined;
       expect(makeDirectoryStub.called).to.be.false;
-      expect(writeFileSyncStub.called).to.be.false;
     });
 
     it('should handle query catch rejection and return early', async () => {
@@ -258,35 +242,11 @@ describe('Setup Branches', () => {
 
       expect(result).to.be.undefined;
       expect(makeDirectoryStub.called).to.be.false;
-      expect(writeFileSyncStub.called).to.be.false;
     });
   });
 
   describe('File Operations', () => {
-    it('should create directory and write branches.json file', async () => {
-      const mockBranch = { uid: 'branch-123', name: 'test-branch' };
-      mockConfig.branchName = 'test-branch';
-      mockConfig.exportDir = '/test/export';
-
-      const mockBranchClient = {
-        fetch: sandbox.stub().resolves(mockBranch)
-      };
-      mockStackAPIClient.branch.returns(mockBranchClient);
-
-      await setupBranches(mockConfig, mockStackAPIClient);
-
-      expect(makeDirectoryStub.calledWith(mockConfig.exportDir)).to.be.true;
-      expect(writeFileSyncStub.calledOnce).to.be.true;
-      // sanitizePath is called internally, we verify the result instead
-      
-      const filePath = writeFileSyncStub.firstCall.args[0];
-      const fileData = writeFileSyncStub.firstCall.args[1];
-      
-      expect(filePath).to.equal(path.join(mockConfig.exportDir, 'branches.json'));
-      expect(fileData).to.deep.equal([mockBranch]);
-    });
-
-    it('should use sanitized export directory path', async () => {
+    it('should create export directory when branches are resolved', async () => {
       const mockBranch = { uid: 'branch-123', name: 'test-branch' };
       mockConfig.branchName = 'test-branch';
       mockConfig.exportDir = '/test/export/../export';
@@ -298,11 +258,7 @@ describe('Setup Branches', () => {
 
       await setupBranches(mockConfig, mockStackAPIClient);
 
-      // sanitizePath will be called internally by the real implementation
-      expect(writeFileSyncStub.called).to.be.true;
-      // Verify the file path contains the directory and branches.json
-      expect(writeFileSyncStub.firstCall.args[0]).to.include('branches.json');
-      expect(writeFileSyncStub.firstCall.args[0]).to.include('/test/export');
+      expect(makeDirectoryStub.calledWith(mockConfig.exportDir)).to.be.true;
     });
   });