fix: cross-platform path handling in MDX utilities #887
Conversation
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
|
@hhniao is attempting to deploy a commit to the WorkOS Team on Vercel. A member of the Team first needs to authorize it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
fix: resolve Windows path handling issues in MDX processing
Summary
This PR addresses critical path handling issues that caused build failures on Windows systems. The changes ensure consistent behavior across all platforms by implementing proper cross-platform path handling.
Changes Made
Replaced hardcoded path separators with path.relative() for proper cross-platform compatibility
Normalized path separators to forward slashes (/) in slugs for consistent URL handling
Fixed path comparison logic that previously relied on platform-specific separators
Resolved ENOENT errors that occurred during build processes on Windows
Fixed file path resolution issues when processing MDX files with nested directories
Eliminated path casing inconsistencies between Linux and Windows environments
Ensured slug consistency regardless of the operating system
Maintained proper relative path calculations for both content linking and asset resolution
Standardized path handling throughout the MDX processing pipeline
Technical Details
Uses Node.js path module methods instead of string manipulation
Implements forward slash normalization for web-compatible URLs
Maintains backward compatibility with existing content structures
Testing
Verified build success on both Windows and Linux environments
Confirmed consistent slug generation across platforms
Tested nested directory structures and special character handling
Impact
Fixes: ENOENT errors and build failures on Windows
Improves: Developer experience for Windows users
Maintains: Full backward compatibility with existing sites
URL for testing: [Add your testing URL here if applicable]
This pull request:
Fixes a bug
Adds additional features/functionality
Updates documentation or example code
Other
The key improvements in this version:
Better structure with clear sections
More specific technical details about what was fixed
Clear testing verification
Impact section that summarizes the benefits
Professional tone suitable for open-source contributions
Complete checklist with the appropriate option checked