fix: add validation to mount-path (#2391)

* fix: add validation to mountPath

Author: kanoru3101

.changeset/violet-jobs-doubt.md

@@ -0,0 +1,5 @@
+---
+"@redocly/cli": patch
+---
+
+Fixed an issue where the `mount-path` option was not validated, leading to errors when used with an empty path or a path identical to the project path.

docs/@v1/commands/push.md

@@ -37,7 +37,7 @@ REDOCLY_AUTHORIZATION=<api-key> redocly push <files> --organization <organizatio
 | files                 | [string] | **REQUIRED.** List of folders and/or files to upload.                                                                                                                                  |
 | --organization, -o    |  string  | **REQUIRED.** Organization slug.                                                                                                                                                       |
 | --project, -p         |  string  | **REQUIRED.** Project slug.                                                                                                                                                            |
-| --mount-path, -mp     |  string  | **REQUIRED.** The path where the files are mounted in the project.                                                                                                                     |
+| --mount-path, -mp     |  string  | **REQUIRED.** The path where the files are mounted in the project. Cannot be empty or identical to the project path.                                                                   |
 | --branch, -b          |  string  | **REQUIRED.** The branch files are pushed from.                                                                                                                                        |
 | --author, -a          |  string  | **REQUIRED.** The author of the push in the format: `'Author Name <author-email@example.com>'`.                                                                                        |
 | --message, -m         |  string  | **REQUIRED.** The commit message for the push.                                                                                                                                         |

docs/@v2/commands/push.md

@@ -33,7 +33,7 @@ REDOCLY_AUTHORIZATION=<api-key> redocly push <files> --organization <organizatio
 | files                 | [string] | **REQUIRED.** List of folders and/or files to upload.                                                                                                                                  |
 | --organization, -o    |  string  | **REQUIRED.** Organization slug.                                                                                                                                                       |
 | --project, -p         |  string  | **REQUIRED.** Project slug.                                                                                                                                                            |
-| --mount-path, -mp     |  string  | **REQUIRED.** The path where the files are mounted in the project.                                                                                                                     |
+| --mount-path, -mp     |  string  | **REQUIRED.** The path where the files are mounted in the project. Cannot be empty or identical to the project path.                                                                   |
 | --branch, -b          |  string  | **REQUIRED.** The branch files are pushed from.                                                                                                                                        |
 | --author, -a          |  string  | **REQUIRED.** The author of the push in the format: `'Author Name <author-email@example.com>'`.                                                                                        |
 | --message, -m         |  string  | **REQUIRED.** The commit message for the push.                                                                                                                                         |

packages/cli/src/index.ts

@@ -28,6 +28,7 @@ import {
 import { handleRespect, type RespectArgv } from './commands/respect/index.js';
 import { version } from './utils/package.js';
 import { validatePositiveNumber } from './utils/validate-positive-number.js';
+import { validateMountPath } from './utils/validate-mount-path.js';
 import { validateMtlsCommandOption } from './commands/respect/mtls/validate-mtls-command-option.js';
 
 import type { Arguments } from 'yargs';
@@ -247,6 +248,7 @@ yargs(hideBin(process.argv))
             type: 'string',
             alias: 'mp',
             required: true,
+            coerce: validateMountPath,
           },
           author: {
             description: 'Author of the commit.',

packages/cli/src/utils/__tests__/validate-mount-path.test.ts

@@ -0,0 +1,22 @@
+import { describe, it, expect } from 'vitest';
+import { validateMountPath } from '../validate-mount-path.js';
+
+describe('validateMountPath', () => {
+  it('should accept valid mount path', () => {
+    expect(validateMountPath('/docs')).toBe('/docs');
+    expect(validateMountPath('/api/v1')).toBe('/api/v1');
+    expect(validateMountPath('/my-path')).toBe('/my-path');
+  });
+
+  it('should reject empty mount path', () => {
+    expect(() => validateMountPath('')).toThrow(
+      'Mount path cannot be empty or root path. Please use --mount-path option with a valid path.'
+    );
+  });
+
+  it('should reject root path "/"', () => {
+    expect(() => validateMountPath('/')).toThrow(
+      'Mount path cannot be empty or root path. Please use --mount-path option with a valid path.'
+    );
+  });
+});

packages/cli/src/utils/validate-mount-path.ts

@@ -0,0 +1,8 @@
+export function validateMountPath(value: string) {
+  if (!value || value === '/') {
+    throw new Error(
+      'Mount path cannot be empty or root path. Please use --mount-path option with a valid path.'
+    );
+  }
+  return value;
+}