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.

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

Commonmarker 1.0 support #1540

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

ParadoxV5
Copy link

@ParadoxV5 ParadoxV5 commented Mar 23, 2024

Description

  • Add Commonmarker (all lower-case ms) provider for commonmarker ~> 1.0.0
  • Remove tests for Markdown header IDs or the lack of, considering they may improve with newer provider versions and that YARD shouldn’t constraint their growth
  • Also change “Missing markup renderer” from skip to raise to catch this sort of issues in the future

Completed Tasks

  • I have read the Contributing Guide.
  • The pull request is complete (implemented / written).
  • Git commits have been cleaned up (squash WIP / revert commits).
  • I wrote tests and ran bundle exec rake locally (if code is attached to PR).

ParadoxV5 and others added 3 commits March 22, 2024 17:22
Fixes lsegal#1528

Co-Authored-By: Andrew Haines <andrew@haines.org.nz>
Preference for the provider’s highlighting is outside of this PR’s scope.
@@ -89,6 +89,9 @@ def html_markup_markdown(text)
:tables,
:with_toc_data,
:no_intraemphasis).to_html
when 'Commonmarker'
# GFM configs are on by default; use YARD for syntax highlighting
Commonmarker.to_html(text, plugins: {syntax_highlighter: nil})
Copy link
Author

Choose a reason for hiding this comment

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

Suggested change
Commonmarker.to_html(text, plugins: {syntax_highlighter: nil})
Commonmarker.to_html(text)

However, preference for the provider’s highlighting is outside of this PR’s scope.

Testing providers’ implementation is outside of the scope of YARD. I let the backslash line break difference live since that’s probably provider-specific.
@ParadoxV5 ParadoxV5 marked this pull request as ready for review March 23, 2024 18:34
ParadoxV5 added a commit to ParadoxV5/template-ruby-gem that referenced this pull request Mar 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Commonmarker 1.0 support
1 participant