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

Add rehype-callouts to list of plugins #175

Merged
merged 1 commit into from
Aug 22, 2024
Merged

Conversation

lin-stephanie
Copy link
Contributor

Initial checklist

  • I read the support docs
  • I read the contributing guide
  • I agree to follow the code of conduct
  • I searched issues and couldn’t find anything (or linked relevant results below)
  • If applicable, I’ve added docs and tests

Description of changes

Added a new plugin rehype-callouts to list of plugins

@github-actions github-actions bot added 👋 phase/new Post is being triaged automatically 🤞 phase/open Post is being triaged manually and removed 👋 phase/new Post is being triaged automatically labels Jul 21, 2024
@codecov-commenter
Copy link

codecov-commenter commented Jul 21, 2024

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (9bc5528) to head (6e1d5db).
Report is 8 commits behind head on main.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #175   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            6         6           
  Lines          154       154           
=========================================
  Hits           154       154           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@ChristianMurphy ChristianMurphy left a comment

Choose a reason for hiding this comment

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

Thanks @lin-stephanie!
This plugin looks really good.
It's great that testing, types, and lint checks area already in place.

Some subtle, non-blocking thoughts:

  1. @types/hast is included in the distributed/production types, it could be good to move it to a dependency (rather then devDependency) to ensure stricter package managers like yarn/pnpm are happy using it https://github.com/lin-stephanie/rehype-callouts/blob/a48cda574d01d6b931d954f93fec36e0517675d8/package.json#L53
  2. It looks like publishing is done through a GitHub action, it could be good to include provenance information to allow adopters to trace the release back to a specific build https://github.blog/security/supply-chain-security/introducing-npm-package-provenance/, though it might take some tinkering to get that to work with pnpm Pnpm publish with provenance flag doesn't work pnpm/pnpm#6607

@wooorm wooorm merged commit 6df7687 into rehypejs:main Aug 22, 2024
3 checks passed
@wooorm wooorm added 📚 area/docs This affects documentation 💪 phase/solved Post is done labels Aug 22, 2024
@wooorm
Copy link
Member

wooorm commented Aug 22, 2024

Thanks!

This comment has been minimized.

@github-actions github-actions bot removed the 🤞 phase/open Post is being triaged manually label Aug 22, 2024
@lin-stephanie
Copy link
Contributor Author

Thanks for the merge @wooorm and suggestions @ChristianMurphy! I’ll consider them for the next update.

@lin-stephanie lin-stephanie deleted the patch-1 branch October 11, 2024 03:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 area/docs This affects documentation 💪 phase/solved Post is done
Development

Successfully merging this pull request may close these issues.

4 participants