Rule for ordering reference links

[nschonni]

This is more style over function, but got the idea from @aduh95 in #139

Basic premise would be to flag:

Lorem impsom [Link A][], [Link B][]

[Link B]: http://example.com/bar
[Link A]: http://example.com/foo

Would flag that the Link A reference is before the Link B reference in the bottom.

Reasoning is, some pages the reference section gets quite large, and an alphabetical list is easier to visually parse when looking for one to update.

[aduh95]

Something like this has been implemented in node core in nodejs/node#35244. However, the checkLinks.js script doesn't check documentation files (but instead, all the other markdown files that are not cover make lint-md).

If nodejs/node#35191 lands, that would change, enforcing de facto the ordering of references for the docs, so I'm not sure it's worth investing time making a lint rule on top of it.

[nschonni]

@aduh95 interesting, thanks! It would be interesting to find/write a remark-lint rule though, because then other repos that use this preset could take advantage as well

[Trott]

Is this fixed by #188 or are they different things?

[aduh95]

Yes, #188 do enforce ordering of reference links, and would typically flag the example in the OP as invalid.
Closing, @nschonni please reopen if you meant something else.