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

Adds remark-comment plugin to list #931

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

leebyron
Copy link

@leebyron leebyron commented Jan 10, 2022

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

https://github.com/leebyron/remark-comment

@github-actions github-actions bot added the 👋 phase/new Post is being triaged automatically label Jan 10, 2022
@github-actions

This comment has been minimized.

@github-actions github-actions bot added 🤞 phase/open Post is being triaged manually and removed 👋 phase/new Post is being triaged automatically labels Jan 10, 2022
@codecov-commenter

This comment has been minimized.

@wooorm
Copy link
Member

wooorm commented Jan 10, 2022

Hey, I was already hoping that someone would create such a plugin!

  • Would it be a good idea to perhaps give this a different name that alludes to MDX and HTML? E.g., remark-mdx-html-comment
  • Should node.commentValue be changed to node.value? All nodes that have a literal string value, use the field value
  • Instead of the literal 60 in the code, you could use codes.lessThan
  • Should it instead expose the same AST as normal comments (probably not)? Or the same AST as {/*stuff*/}? (I like this?) — reason: that way it integrates with existing tools, such as those that turn on or off linting messages
  • Probably good to add it here too: https://mdxjs.com/docs/extending-mdx/#list-of-plugins

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤞 phase/open Post is being triaged manually
Development

Successfully merging this pull request may close these issues.

None yet

3 participants