Add new rule: remark-lint-consistent-linebreaks

[remcohaszing]

Initial checklist

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

Problem

Commonmark supports two ways to add a linebreak.

Using two spaces at the end of a line:

foo··
bar

Using a backslash at the end of a line:

foo\
bar

It would be nice if remark could enforce consistency.

Solution

Add a new rule: remark-lint-consistent-linebreaks

This rule enforces one style or the other, defaulting to \.

Alternatives

People shouldn’t use line breaks in the first place, but since they do, let’s prefer the visible one over the invisible one 🤷

[wooorm]

Good idea!
I think it should be called remark-lint-hard-break-style:

• The word “hard break” is more often used to differentiate from a soft line break, it’s also used for the existing rule remark-lint-hard-break-spaces
• linebreak is used for the existing rule remark-lint-linebreak-style, which checks for CRLF/LF
• the word “consistent” is used in this project as an option, which means that the first used style is chosen, and later uses should be the same. This is typically the default.

I think it should have the options:

• 'consistent' (default)
• 'escape' (accepting e.g. a\(?:\r|\r\n|\n)b)
• 'trailing' (accepting e.g. a␠␠(?:\r|\r\n|\n)b)

[github-actions]

Hi! This was marked as ready to be worked on! Note that while this is ready to be worked on, nothing is said about priority: it may take a while for this to be solved.

Is this something you can and want to work on?

Team: please use the area/* (to describe the scope of the change), platform/* (if this is related to a specific one), and semver/* and type/* labels to annotate this. If this is first-timers friendly, add good first issue and if this could use help, add help wanted.