-
Notifications
You must be signed in to change notification settings - Fork 224
fix: add validation to mount-path #2391
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
3b00187
fix: add validation to mountPath
kanoru3101 ab72f01
fix: update error message
kanoru3101 1d633cd
fix: move logic to yard
kanoru3101 35ae0fe
fix: update error message
kanoru3101 97ca025
fix: add changeset
kanoru3101 c9fe324
Update .changeset/violet-jobs-doubt.md
kanoru3101 512a7ce
fix: update docs
kanoru3101 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
22 changes: 22 additions & 0 deletions
22
packages/cli/src/utils/__tests__/validate-mount-path.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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( | ||
|
mark-redocly marked this conversation as resolved.
|
||
| '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.' | ||
| ); | ||
| }); | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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; | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.