@0x6b/textlint-rule-no-hr-before-heading

textlint-rule-no-hr-before-heading

textlint rule which detects and reports horizontal rules appearing immediately before headings in your markdown document.

While horizontal rules (---, ***, ___) before headings are syntactically valid in Markdown, they often create visual clutter. Markdown headings already provide clear visual separation, making horizontal rules redundant in this context.

Install

Install with pnpm:

pnpm add @0x6b/textlint-rule-no-hr-before-heading

Or with npm:

npm install @0x6b/textlint-rule-no-hr-before-heading

This module requires Node.js >= 20.0.0.

Usage

Via .textlintrc(recommended):

{
  "rules": {
    "@0x6b/no-hr-before-heading": true
  }
}

Via CLI:

textlint --rule @0x6b/no-hr-before-heading README.md

Examples

Invalid

---

# Heading

Some content

___

## Another Heading

Valid

# Heading

Some content

---

More content

## Another Heading

Fixable

This rule is automatically fixable using the --fix option. The horizontal rule and any whitespace between it and the heading will be removed.

Front Matter Support

This rule correctly handles YAML front matter in Markdown files. Front matter delimiters (---) are not treated as horizontal rules when properly formatted:

---
title: My Document
date: 2023-01-01
---

# Heading

This is valid and will not trigger the rule because textlint's markdown parser includes remark-frontmatter support by default, which correctly parses front matter as a special node type rather than as horizontal rules.

Build

Builds source codes for publish to the lib/ folder.

pnpm install && pnpm run build

Test

Run test code in test folder by textlint-tester.

pnpm test

References

• Creating textlint rules
• Markdown AST
• remark-frontmatter

License

MIT © 0x6b