New Rule: no-heading-like-paragraph

[Gaic4o]

Rule details

This rule should report when the first line of a paragraph starts with seven or more hash characters (#) followed by a space or tab. CommonMark ATX headings support one to six hash characters. Therefore, content such as ####### Installation is parsed as a regular paragraph rather than a heading.

What type of rule is this?

Warns about a potential problem

Example code

// The following code should trigger a warning
####### Installation

######## Configuration

Prior Art

remark-lint already provides a rule with the same purpose:

remark-lint-no-heading-like-paragraph

This rule also warns about paragraphs that start with seven or more hash characters and appear to be intended as headings.

Participation

• I am willing to submit a pull request to implement this rule.

AI acknowledgment

• I did not use AI to generate this issue report.
• (If the above is not checked) I have reviewed the AI-generated content before submitting.

Additional comments

No response

Disclosure: I'm a participant of open source contribution program OSSCA

[DMartens]

I am unsure how applicable this rule is as I never saw a case for this in the wild.
Searching for the pattern in public repositories I could not find a match.
Would like another team member opinion on this.

[lumirlumir]

I’m personally a soft +1 on this suggestion.

Since we’ve generally accepted rule addition requests from markdownlint and remark-lint that aren’t about stylistic choices in this repo, I think this rule could be a nice addition.

For example, I had a similar opinion on #419 (comment) regarding how useful the rule would be, but it was ultimately accepted.

[lumirlumir]

Could I get a few more opinions on this? @eslint/eslint-team

[nzakas]

In the interest of Remark-lint compat, I'm in favor. 👍