Skip to content

Support both Commonmarker pre and post 1.0 #1601

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

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

Support both Commonmarker pre and post 1.0 #1601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cf44a71
Support both Commonmarker pre and post 1.0
gjtorikian Jan 27, 2025
c4caabc
Merge branch 'main' into commonmarker-onetwo-oh
lsegal May 10, 2025
ab096d6
use the correct gem name in test
gjtorikian Jun 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion lib/yard/templates/helpers/html_helper.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,9 @@ def html_markup_markdown(text)
:tables,
:with_toc_data,
:no_intraemphasis).to_html
when 'CommonMarker'
when 'Commonmarker' # GFM configs are on by default; use YARD for syntax highlighting
Copy link
Author

Choose a reason for hiding this comment

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

Maybe defined? needs to go here too? I didn't really follow the thread of how const is used.

It seems like its only usage is here, to check if the const is available: https://github.com/gjtorikian/yard/blob/cf44a71c6715e39c9868b2beddaa0be4cf67b71e/lib/yard/templates/helpers/markup_helper.rb#L106

But that just instantiates a class, which is turned into a string, which is used in this case statement.

It seems like you could drop the class instantiation and just pass a string here, because klass serves no purpose: https://github.com/gjtorikian/yard/blob/cf44a71c6715e39c9868b2beddaa0be4cf67b71e/lib/yard/templates/helpers/markup_helper.rb#L104-L110

But I don't know all the details of this project. 🤷

Commonmarker.to_html(text, options: { extension: { header_ids: nil } }, plugins: {syntax_highlighter: nil})
when 'CommonMarker' # old, pre 1.0; downstream consumers should upgrade
CommonMarker.render_html(text, %i[DEFAULT GITHUB_PRE_LANG], %i[autolink table])
else
provider.new(text).to_html
Expand Down
2 changes: 1 addition & 1 deletion lib/yard/templates/helpers/markup_helper.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ def clear_markup_cache
{:lib => :maruku, :const => 'Maruku'},
{:lib => :'rpeg-markdown', :const => 'PEGMarkdown'},
{:lib => :rdoc, :const => 'YARD::Templates::Helpers::Markup::RDocMarkdown'},
{:lib => :commonmarker, :const => 'CommonMarker'}
{:lib => :commonmarker, :const => defined?(CommonMarker) ? 'CommonMarker' : "Commonmarker" }
],
:textile => [
{:lib => :redcloth, :const => 'RedCloth'}
Expand Down
2 changes: 1 addition & 1 deletion spec/templates/markup_processor_integrations/markdown_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
end
end

describe 'CommonMarker', if: RUBY_VERSION >= '2.3' do
describe defined?(CommonMarker) ? 'CommonMarker' : "Commonmarker", if: RUBY_VERSION >= '2.3' do
let(:markup) { :markdown }
let(:markup_provider) { :commonmarker }

Expand Down