eslint / eslint/markdown

New Rule: no-heading-like-paragraph

Open
#700 5 comments 0 reactions 1 assignee Claimed by @Gaic4o View on GitHub
accepted feature
Dominant language
JavaScript
Stars
581
Forks
92
Avg merge
1d 4h
Merged PRs (30d)
11

Description

### 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

```markdown
// 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`](https://github.com/remarkjs/remark-lint/tree/main/packages/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

- [x] I am willing to submit a pull request to implement this rule.

### AI acknowledgment

- [x] 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](https://github.com/eslint-ossca)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.