feat: lint YAML comments in md files #139
Conversation
|
LGTM if we can get the changes into Node.js core to comply with this. I have opinions on both of the two ordering decisions, but I am much more invested in consistency, so I'm fine with however it ends up. |
I'm with you on that one, I think consistency is key. Do you want to share your thoughts nonetheless? I think we can achieve consistency with the same amount of work no matter which convention we choose to follow, so if someone wants to weigh in for one option or the other before I start working on it, that'd be awesome. If I had to come up with rules myself, I'd say we should list versions and changes from the oldest at the top to the newest at the bottom; since most of the docs uses the exact opposite, that's what I'm gonna follow (and I can see why that makes sense so I'm fine with it). |
I'm finding myself changing my mind, so now I'm just going to go with, "I don't care as long as it's consistent." |
|
OK, I'll wait for nodejs/node#35191 to land before starting working on PRs on node repo to avoid getting too much git conflicts. |
|
Makes sense to me. https://www.npmjs.com/package/semver might be useful if you run into any version comparisons that end up hitting any odd results |
|
I wonder if there's a way of checking if a given version number corresponds to a released version of Node.js. That could avoid that kind of mishaps nodejs/node#35454 (comment) But I don't think there is a reliable way of getting an updated list of Node.js releases, right? |
|
There is the index.json/tab or https://github.com/chicoxyzzy/node-releases which scraps it |
I think that would break at each new release: when the releaser replaces |
For the release being prepared your only option is going to be scanning the local files -- the releaser should add a changelog entry for the new release. The catch is that the local changelog will only be accurate for the release line being prepared (e.g. if the releaser is preparing a v10.x release only the v10 changelog will be accurate). index.json/tab or https://github.com/chicoxyzzy/node-releases will be accurate for any releases already made. |
aduh95
force-pushed
the
lint-yaml-comments
branch
from
a0101a6
to
98fae66
Compare
|
CI's green 🎉 I've given up the idea of validating version strings to raise flag when an unreleased version number is used; I couldn't find a way to read CHANGELOGs in an elegant way, I think it's fine to rely on the code review process to pick up that kind of mistakes. I think this is ready to land, please review. |
Refs: nodejs/remark-preset-lint-node#139 PR-URL: #35454 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Michael Dawson <midawson@redhat.com>
Refs: nodejs/remark-preset-lint-node#139 PR-URL: #35454 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Michael Dawson <midawson@redhat.com>
Refs: nodejs/remark-preset-lint-node#139 PR-URL: #35454 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Michael Dawson <midawson@redhat.com>
Refs: nodejs/remark-preset-lint-node#139 PR-URL: #35454 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Michael Dawson <midawson@redhat.com>
Refs: nodejs/remark-preset-lint-node#139 PR-URL: #35454 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Michael Dawson <midawson@redhat.com>
Refs: nodejs/remark-preset-lint-node#139 PR-URL: #35454 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Michael Dawson <midawson@redhat.com>
Refs: nodejs/remark-preset-lint-node#139 PR-URL: #35575 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ben Coe <bencoe@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
|
Landed and published as 1.17.0, discovered that was bad (left out the new file), and re-published as 1.17.1. |
Bump remark-lint-preset-node@1.16.0 to remark-lint-preset-node@1.17.1. Refs: nodejs/remark-preset-lint-node#139 PR-URL: #35668 Reviewed-By: Ben Coe <bencoe@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Refs: nodejs/remark-preset-lint-node#139 PR-URL: nodejs#35454 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Michael Dawson <midawson@redhat.com>
Refs: nodejs/remark-preset-lint-node#139 PR-URL: nodejs#35454 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Michael Dawson <midawson@redhat.com>
Refs: nodejs/remark-preset-lint-node#139 PR-URL: nodejs#35454 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Michael Dawson <midawson@redhat.com>
Refs: nodejs/remark-preset-lint-node#139 PR-URL: nodejs#35454 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Michael Dawson <midawson@redhat.com>
Refs: nodejs/remark-preset-lint-node#139 PR-URL: nodejs#35454 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Michael Dawson <midawson@redhat.com>
Refs: nodejs/remark-preset-lint-node#139 PR-URL: nodejs#35454 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Michael Dawson <midawson@redhat.com>
Refs: nodejs/remark-preset-lint-node#139 PR-URL: nodejs#35575 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ben Coe <bencoe@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Refs: nodejs/remark-preset-lint-node#139 PR-URL: #35454 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Michael Dawson <midawson@redhat.com>
Bump remark-lint-preset-node@1.16.0 to remark-lint-preset-node@1.17.1. Refs: nodejs/remark-preset-lint-node#139 PR-URL: #35668 Reviewed-By: Ben Coe <bencoe@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Refs: nodejs/remark-preset-lint-node#139 PR-URL: #35454 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Michael Dawson <midawson@redhat.com>
Bump remark-lint-preset-node@1.16.0 to remark-lint-preset-node@1.17.1. Refs: nodejs/remark-preset-lint-node#139 PR-URL: #35668 Reviewed-By: Ben Coe <bencoe@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Add a linter rule to validate YAML comments in markdown files.
The goal of this PR is to enforce a consistent order convention across the Node.js documentation.