remark icon indicating copy to clipboard operation
remark copied to clipboard

Adds remark-comment plugin to list

Open leebyron opened this issue 3 years ago • 3 comments

Initial checklist

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

Description of changes

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

leebyron avatar Jan 10 '22 05:01 leebyron

Hi! It seems you removed the template which we require. Here are our templates (pick the one you want to use and click *raw* to see its source):

I won’t send you any further notifications about this, but I’ll keep on updating this comment, and hide it when done!

Thanks, — bb

github-actions[bot] avatar Jan 10 '22 05:01 github-actions[bot]

Codecov Report

Merging #931 (1a96df2) into main (13734ff) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##              main      #931   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines          905       905           
=========================================
  Hits           905       905           

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 13734ff...1a96df2. Read the comment docs.

codecov-commenter avatar Jan 10 '22 08:01 codecov-commenter

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

wooorm avatar Jan 10 '22 08:01 wooorm