Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Refactor mdplain package to use yuin/goldmark library for markdown processing #332

Merged
merged 2 commits into from
Jan 26, 2024
Merged

Refactor mdplain package to use yuin/goldmark library for markdown processing #332

merged 2 commits into from
Jan 26, 2024

Conversation

SBGoods
Copy link
Contributor

@SBGoods SBGoods commented Jan 25, 2024

Closes: #321

This PR adds a golden file test for the PlainMarkdown() function and refactors the mdplain package to use yuin/goldmark library instead of russross/blackfriday for markdown processing.

@SBGoods SBGoods requested a review from a team as a code owner January 25, 2024 21:14
@SBGoods SBGoods added command/generate dependencies Pull requests that update a dependency file labels Jan 25, 2024
@SBGoods SBGoods added this to the v0.19.0 milestone Jan 25, 2024
bendbennett
bendbennett approved these changes Jan 26, 2024
View reviewed changes
Copy link
Contributor

@bendbennett bendbennett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀

bflad
bflad approved these changes Jan 26, 2024
View reviewed changes
Copy link
Contributor

@bflad bflad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me 🚀 (I'm assuming there are no differences with the unit test between the prior implementation and this new one without explicitly verifying.)

internal/mdplain/testdata/markdown.md
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love using this to verify the functionality ❤️

@SBGoods SBGoods merged commit 6b686ee into main Jan 26, 2024
6 checks passed
@SBGoods SBGoods deleted the SBGoods/switch-to-goldmark branch January 26, 2024 19:53
This was referenced Apr 16, 2024
Closed
Merged
@github-actions GitHub Actions
Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@bendbennett bendbennett bendbennett approved these changes

@bflad bflad bflad approved these changes

Assignees
No one assigned
Labels
command/generate dependencies Pull requests that update a dependency file
Projects
None yet
Milestone
v0.19.0
Development

Successfully merging this pull request may close these issues.

Switch to github.com/yuin/goldmark library for all Markdown processing
3 participants
@SBGoods @bflad @bendbennett