{"id":26259,"library":"remark-lint-no-heading-like-paragraph","title":"remark-lint-no-heading-like-paragraph","description":"A remark-lint rule that warns when a markdown paragraph starts with too many hash characters (#), making it resemble a heading but with more than the allowed maximum of six levels. Current stable version is 4.0.1, ESM-only, requires Node.js 16+. It is part of the unified/remark ecosystem and ships TypeScript types. Unlike general linting presets, this rule specifically targets invalid heading-like paragraphs, catching common typos where users accidentally add extra hashes (e.g., ####### Venus). No options are needed. Releases follow the main remark-lint monorepo.","status":"active","version":"4.0.1","language":"javascript","source_language":"en","source_url":"https://github.com/remarkjs/remark-lint#main","tags":["javascript","heading","lint","paragraph","remark","remark-lint","remark-lint-rule","rule","typescript"],"install":[{"cmd":"npm install remark-lint-no-heading-like-paragraph","lang":"bash","label":"npm"},{"cmd":"yarn add remark-lint-no-heading-like-paragraph","lang":"bash","label":"yarn"},{"cmd":"pnpm add remark-lint-no-heading-like-paragraph","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Unified is the core processor required for remark plugins.","package":"unified","optional":false},{"reason":"This rule requires remark-lint to be applied as a unified plugin.","package":"remark-lint","optional":false}],"imports":[{"note":"ESM-only since v4; require() will throw an error.","wrong":"const remarkLintNoHeadingLikeParagraph = require('remark-lint-no-heading-like-paragraph')","symbol":"default","correct":"import remarkLintNoHeadingLikeParagraph from 'remark-lint-no-heading-like-paragraph'"},{"note":"The package only has a default export, not a named export.","wrong":"import { remarkLintNoHeadingLikeParagraph } from 'remark-lint-no-heading-like-paragraph'","symbol":"remarkLintNoHeadingLikeParagraph","correct":"import remarkLintNoHeadingLikeParagraph from 'remark-lint-no-heading-like-paragraph'"},{"note":"No TypeScript types are exported from this package; types are inferred from unified and remark-lint.","wrong":"import type { remarkLintNoHeadingLikeParagraph } from 'remark-lint-no-heading-like-paragraph'","symbol":"type imports","correct":"import type { Transformer } from 'unified'"}],"quickstart":{"code":"import { unified } from 'unified';\nimport remarkParse from 'remark-parse';\nimport remarkStringify from 'remark-stringify';\nimport remarkLint from 'remark-lint';\nimport remarkLintNoHeadingLikeParagraph from 'remark-lint-no-heading-like-paragraph';\nimport { read } from 'to-vfile';\nimport { reporter } from 'vfile-reporter';\n\nconst file = await read('example.md');\n\nconst result = await unified()\n  .use(remarkParse)\n  .use(remarkLint)\n  .use(remarkLintNoHeadingLikeParagraph)\n  .use(remarkStringify)\n  .process(file);\n\nconsole.error(reporter(result));","lang":"typescript","description":"Shows how to use the rule with unified, remark-lint, and vfile-reporter to lint a markdown file."},"warnings":[{"fix":"Use import instead of require, or stick with v3 if CommonJS is needed.","message":"v4 is ESM-only; Node.js 16+ required.","severity":"breaking","affected_versions":">=4.0.0"},{"fix":"Upgrade to v4 and switch to ESM.","message":"v3 is no longer maintained.","severity":"deprecated","affected_versions":"<4.0.0"},{"fix":"This is by design; use other rules like remark-lint-heading-style for heading linting.","message":"The rule does not warn on headings with 1-6 hashes, only 7+.","severity":"gotcha","affected_versions":">=1.0.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Change to import statement: import remarkLintNoHeadingLikeParagraph from 'remark-lint-no-heading-like-paragraph'","cause":"Using require() to load this ESM-only package.","error":"Error [ERR_REQUIRE_ESM]: require() of ES Module"},{"fix":"Ensure you call .use(remarkLint) before .use(remarkLintNoHeadingLikeParagraph)","cause":"Forgetting to import remark-lint before this rule.","error":"TypeError: (intermediate value).use is not a function"},{"fix":"Run npm install remark-lint-no-heading-like-paragraph and ensure the import path is correct.","cause":"Package not installed or import path incorrect.","error":"Cannot find module 'remark-lint-no-heading-like-paragraph'"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}