-
Notifications
You must be signed in to change notification settings - Fork 23
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
feat: Upgrade to Remark v13 with plug-ins #159
Conversation
Upstream PR nodejs/node#35647 Need to figure out about the new requirement for |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM once necessary changes land in nodejs/node repo
@Trott should the |
Ideally it would be a peerDependency, right? |
Since it's only needed for testing, I added it as a devDependency when I (unintentionally) duplicated this work in #161. Feel free to do that if you want to get this unstalled.... |
Oh, I see you already have it as a devDependency. I think you need to also add |
@Trott how would you see that working upstream? Would you vendor the plug-in separately? |
Some of the plug-ins require v13, so this bumps all the outstanding ones and the CLI
It's there, just at the end instead of the front 😉 |
It wouldn't come with the plugin. People could choose to use it or not use it, depending on if they were using GFM in their markdown files or not. In the case of Node.js core, we're using it so we include it. But that happens where you install remark-lint, not in the plugin itself. See the changes to tools/node-lint-md-cli-rollup/package.json and tools/node-lint-md-cli-rollup/src/cli-entry.js in https://github.com/nodejs/node/pull/35905/files. |
Sounds, good. I know we had to use the frontmatter plug-in before for nodejs.org separately, but wasn't sure since there are rules were using seem to require the gmf plug-in (checkbox-style, etc...) |
I guess if there's a way to set GFM in the plugin, then great, but I don't know any way offhand, and we can always add it in later. But for now, it's on the consumer to know if they use/need GFM or not. I'm more than OK with that. |
Because this might be incompatible with existing setups, I'm going to be extra cautious and publish it as a semver-major (breaking) change. |
Some of the plug-ins require v13, so this bumps all the outstanding ones and the CLI