Skip to content

README.md

Latest commit

 

History

History
109 lines (81 loc) · 1.98 KB

README.md

File metadata and controls

109 lines (81 loc) · 1.98 KB
Raw
id MDS036
name max-section-length
status ready
description Section length must not exceed per-level or per-heading limits.

MDS036: max-section-length

Section length must not exceed per-level or per-heading limits.

  • ID: MDS036
  • Name: max-section-length
  • Status: ready
  • Default: disabled
  • Fixable: no
  • Implementation: source
  • Category: heading

A section spans from its heading line up to (but not including) the next heading line of any level, or the end of file. Nested subsections are measured separately from their parent, so the limit applies to the content written directly under each heading.

Settings

Setting Type Default Description
max int 0 Default line limit; zero disables the global rule.
per-level map {} Map from heading level (1-6) to line limit.
per-heading list [] Regex patterns with per-heading line limits.

Lookup order for a heading: per-heading (first matching regex wins), then per-level, then max. A resolved limit of zero disables the check for that heading.

Config

Enable with a default limit:

rules:
  max-section-length:
    max: 100

Per-level and per-heading overrides:

rules:
  max-section-length:
    max: 100
    per-level:
      1: 200
      2: 80
    per-heading:
      - pattern: "^Changelog$"
        max: 500

Disable:

rules:
  max-section-length: false

Examples

Good

# Title

Short section within the limit.

## Subsection

Also short. Each section is bounded by the next heading of any level.

## Another

Stays under the limit.

Bad

# Too Long

line a
line b
line c
line d