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

✨ NEW: Port admon plugin #53

Merged
merged 14 commits into from
Dec 5, 2022
Merged

✨ NEW: Port admon plugin #53

merged 14 commits into from
Dec 5, 2022

Conversation

KyleKing
Copy link
Contributor

@KyleKing KyleKing commented Nov 26, 2022

(Partially) Fixes: hukkin/mdformat#309 (in combination with KyleKing/mdformat-admon#1)

I had two hours this morning and tried porting the plugin! It passes all tests locally and seems to work, but I'll take another look through tomorrow to make sure it is merge-ready. I'm opening a PR for now, since there seemed to be a couple of people interested, and I would benefit from any feedback.

@welcome
Copy link

welcome bot commented Nov 26, 2022

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.

Welcome to the EBP community! 🎉

mdit_py_plugins/admon/LICENSE Show resolved Hide resolved
mdit_py_plugins/admon/index.py Outdated Show resolved Hide resolved
mdit_py_plugins/admon/index.py Outdated Show resolved Hide resolved
@KyleKing KyleKing marked this pull request as ready for review November 27, 2022 13:49
@KyleKing KyleKing changed the title feat: port the admon plugin ✨ NEW: Port admon plugin Nov 27, 2022
@KyleKing KyleKing changed the title ✨ NEW: Port admon plugin ✨ NEW: Port admon plugin Nov 27, 2022
@KyleKing
Copy link
Contributor Author

I think this is now ready for review. Let me know if there is anything that needs to be modified, and I would be happy to make those changes, or feel free to go ahead and make changes directly!

Based on this recommendation, this PR ports this JS plugin to Python: https://github.com/commenthol/markdown-it-admon/blob/9820ba89415c464a3cc18a780f222a0ceb3e18bd/index.js

Copy link
Contributor

@hukkin hukkin left a comment

Choose a reason for hiding this comment

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

Thanks! This seems good to me assuming that tests pass.

Would @chrisjsewell be able to approve CI and review too?

mdit_py_plugins/admon/port.yaml Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Dec 1, 2022

Codecov Report

Base: 92.37% // Head: 92.66% // Increases project coverage by +0.28% 🎉

Coverage data is based on head (c690983) compared to base (3f90276).
Patch coverage: 97.08% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##           master      #53      +/-   ##
==========================================
+ Coverage   92.37%   92.66%   +0.28%     
==========================================
  Files          27       29       +2     
  Lines        1574     1677     +103     
==========================================
+ Hits         1454     1554     +100     
- Misses        120      123       +3     
Flag Coverage Δ
pytests 92.66% <97.08%> (+0.28%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
mdit_py_plugins/admon/index.py 97.05% <97.05%> (ø)
mdit_py_plugins/admon/__init__.py 100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@hukkin
Copy link
Contributor

hukkin commented Dec 1, 2022

Regarding broken CI checks:

mdit_py_plugins/admon/index.py Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
mdit_py_plugins/admon/index.py Outdated Show resolved Hide resolved
mdit_py_plugins/admon/index.py Outdated Show resolved Hide resolved
@KyleKing
Copy link
Contributor Author

KyleKing commented Dec 5, 2022

Thanks for the feedback! I think I made all the requested changes. Let me know if there is anything else.

For coverage, is 100% statement coverage expected? There are a few that aren't tested, but they are only single lines like return True or return "", ""

Copy link
Member

@chrisjsewell chrisjsewell left a comment

Choose a reason for hiding this comment

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

cheers!

@chrisjsewell
Copy link
Member

@hukkin do you want to approve before I merge ta

Copy link
Contributor

@hukkin hukkin left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks @KyleKing !

@chrisjsewell chrisjsewell merged commit ec51e60 into executablebooks:master Dec 5, 2022
@welcome
Copy link

welcome bot commented Dec 5, 2022

Congrats on your first merged pull request in this project! 🎉
congrats

Thank you for contributing, we are very proud of you! ❤️

@KyleKing KyleKing deleted the admon branch December 6, 2022 01:36
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.

Support Admonitions
3 participants