HTML comments return unexpected-character on md files

[tiagoporto]

Initial checklist

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

Affected package

remark-mdx

Steps to reproduce

I'm using remark to check md and mdx files.

// .remarkrc
{
"plugins": ["remark-mdx"]
}

Running:

remark . --ext md,mdx

If some markdown file has HTML comments, example:

# README

<!--
 Some comment
-->

I get the following error:

Actual behavior

I get the following error:

Expected behavior

No errors, HTML comments is valid on md files.

Runtime

[email protected]

Package manager

[email protected]

Operating system

Sequoia 15.2

Build and bundle tools

No response

[remcohaszing]

No errors, HTML comments is valid on md files.

Yes, but not in MDX. By using remark-mdx, you’re treating md files as MDX. You need to lint markdown and MDX files separately.

Related: unifiedjs/unified-engine#56

[tiagoporto]

Hi @remcohaszing, after reading the discussion my workaround was adding a new RF file.

.
├── packages
│   ├── .remarkrc (MDX Config)
│   ├── TODO.mdx
│   └── README.mdx
│
├── .remarkrc
└── README.md

Thank you

[wooorm]

Config files currently (and perhaps not badly) work the other way around: files are found first, from them config files are found.
Your root command, as in where you call remark, chooses which files to find. That is also where you can configure from.
Meaning, there is a place where you do remark glob/to/**/*.mdx (or: remark --ext mdx .) where you can do --use mdx as well.
And another remark glob/to/**/*.md (or: remark .) where you do not add --use mdx.
If you instead choose to do one command where you find both markdown and mdx at once, then the remaining solution is indeed different config files like what you show!

[github-actions]

Hi team! Could you describe why this has been marked as wontfix?

Thanks,
— bb