{"library":"remark-lint-heading-word-length","title":"remark-lint-heading-word-length","description":"A remark-lint rule that warns when headings contain too many or too few words. Version 3.0.0 is current; breaking change drops Node <20.18.0. Words are split on whitespace. Unlike the archived remark-lint-heading-length, this rule supports configurable min/max word counts. ESM-only. Part of the unified-utils monorepo with semantic-release.","language":"javascript","status":"active","last_verified":"Fri May 01","install":{"commands":["npm install remark-lint-heading-word-length"],"cli":null},"imports":["import lintHeadingWordLength from 'remark-lint-heading-word-length'","import lintHeadingWordLength from 'remark-lint-heading-word-length'","\"lint-heading-word-length\""],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"import { read } from 'to-vfile';\nimport { reporter } from 'vfile-reporter';\nimport { remark } from 'remark';\nimport remarkLint from 'remark-lint';\nimport lintHeadingWordLength from 'remark-lint-heading-word-length';\n\nconst file = await remark()\n  .use(remarkLint)\n  .use(lintHeadingWordLength, { minimumWords: 3, maximumWords: 12 })\n  .process(await read('example.md'));\n\nconsole.log(reporter(file));","lang":"typescript","description":"Loads a markdown file, lints headings for word count, and prints errors using vfile-reporter.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}