{"library":"remark-lint-maximum-heading-length","title":"remark-lint-maximum-heading-length","description":"remark-lint rule to warn when headings are too long. Current stable version is 4.1.1 (ESM-only, requires Node.js 16+). Part of the unified/remark ecosystem, this rule enforces a maximum heading length (default 60 characters) and is included in some presets like remark-preset-lint-markdown-style-guide. Provides an optional stringLength function for custom text measurement (e.g., to count display width). Active development with regular releases coordinated across the remark-lint monorepo.","language":"javascript","status":"active","last_verified":"Fri May 01","install":{"commands":["npm install remark-lint-maximum-heading-length"],"cli":null},"imports":["import remarkLintMaximumHeadingLength from 'remark-lint-maximum-heading-length'","import type { Options } from 'remark-lint-maximum-heading-length'"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"import remarkLint from 'remark-lint'\nimport remarkLintMaximumHeadingLength from 'remark-lint-maximum-heading-length'\nimport remarkParse from 'remark-parse'\nimport remarkStringify from 'remark-stringify'\nimport { read } from 'to-vfile'\nimport { unified } from 'unified'\nimport { reporter } from 'vfile-reporter'\n\nconst file = await read('example.md')\n\nawait unified()\n  .use(remarkParse)\n  .use(remarkLint)\n  .use(remarkLintMaximumHeadingLength, { size: 80 })\n  .use(remarkStringify)\n  .process(file)\n\nconsole.error(reporter(file))","lang":"typescript","description":"Shows how to use the rule with unified, specifying a custom max heading length of 80 characters.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}