fix(app): replace remark with react-markdown #14942
Merged
Conversation
This file contains 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
After the vite migration, the app would crash any time the release notes markdown file needed to parsed, because remark decides to invoke process.cwd() for some reason. Webpack mocks process out, but vite doesn't. Although there's probably some hacky way do accomplish the same thing in vite, remark-react has been depricated for over two years, so that's more incentive to migrate. After testing a few options, react-markdown is relatively lightweight and properly overrides the markdown as desired (ie, no additional changes need to be made to the markdown for the same end result). It also doesn't have the same Vfile lib dependency that is the source of the "process" issue, so no more crashing when parsing release notes.
sfoster1
approved these changes
Apr 17, 2024
Carlos-fernandez
pushed a commit
that referenced
this pull request
May 20, 2024
Closes RQA-2587 and RQA-2566 After the vite migration, the app would crash any time the release notes markdown file needed parsing, because remark decides to invoke process.cwd() for some reason. Webpack can mock "process" out, but there's no 1:1 analogous solution with Vite. Although there's probably some hacky way do accomplish the same thing, remark-react has been deprecated for over three years, so that's more incentive to migrate. After testing a few options, react-markdown is relatively lightweight and properly overrides the markdown as desired (ie, no additional changes need to be made to the markdown for the refactor). It also doesn't have the same Vfile lib dependency that is the source of the "process" issue, so no more crashing when parsing release notes. It's also well-maintained, etc.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes RQA-2587 and RQA-2566
Overview
After the vite migration, the app would crash any time the release notes markdown file needed parsing, because remark decides to invoke process.cwd() for some reason. Webpack can mock "process" out, but there's no 1:1 analogous solution with Vite.
Although there's probably some hacky way do accomplish the same thing, remark-react has been deprecated for over three years, so that's more incentive to migrate.
After testing a few options, react-markdown is relatively lightweight and properly overrides the markdown as desired (ie, no additional changes need to be made to the markdown for the refactor). It also doesn't have the same Vfile lib dependency that is the source of the "process" issue, so no more crashing when parsing release notes. It's also well-maintained, etc.
Test Plan
Changelog
Review requests
Risk assessment
low