# remark-lint-maximum-heading-length

> remark-lint rule to warn when headings are too long

Latest version **4.1.1** (published 2025-01-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install remark-lint-maximum-heading-length
pnpm add remark-lint-maximum-heading-length
yarn add remark-lint-maximum-heading-length
bun add remark-lint-maximum-heading-length
```

## Health

**Score 45/100 (D)** — status: stable.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 4.1.1 |
| Published | 2025-01-27 |
| First published | 2017-02-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 6 |
| Unpacked size | 15.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1043 |
| Author | Titus Wormer |
| Maintainers | johno, wooorm, remcohaszing |
| Keywords | heading, length, lint, remark, remark-lint, remark-lint-rule, rule |

## Links

- npm: https://www.npmjs.com/package/remark-lint-maximum-heading-length
- Repository: https://github.com/remarkjs/remark-lint.git#main
- Homepage: https://github.com/remarkjs/remark-lint/tree/main#readme
- Issues: https://github.com/remarkjs/remark-lint/issues
- Funding: https://opencollective.com/unified
- npm.io page: https://npm.io/package/remark-lint-maximum-heading-length

## Dependencies (6)

- [@types/mdast](https://npm.io/package/@types/mdast.md) ^4.0.0
- [mdast-util-mdx](https://npm.io/package/mdast-util-mdx.md) ^3.0.0
- [unified-lint-rule](https://npm.io/package/unified-lint-rule.md) ^3.0.0
- [unist-util-position](https://npm.io/package/unist-util-position.md) ^5.0.0
- [mdast-util-to-string](https://npm.io/package/mdast-util-to-string.md) ^4.0.0
- [unist-util-visit-parents](https://npm.io/package/unist-util-visit-parents.md) ^6.0.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 4.1.1 (latest) — 2025-01-27
- 4.1.0 — 2025-01-27
- 4.0.0 — 2024-04-09
- 3.1.2 — 2023-05-16
- 3.1.1 — 2021-12-03
- 3.1.0 — 2021-09-18
- 3.0.1 — 2021-08-17
- 3.0.0 — 2021-08-12
- 2.0.1 — 2020-07-02
- 2.0.0 — 2020-03-30
- 1.0.4 — 2020-03-24
- 1.0.3 — 2019-06-20
- 1.0.2 — 2018-06-04
- 1.0.1 — 2017-08-17
- 1.0.0 — 2017-02-23

## README

<!--This file is generated-->

# remark-lint-maximum-heading-length

[![Build][badge-build-image]][badge-build-url]
[![Coverage][badge-coverage-image]][badge-coverage-url]
[![Downloads][badge-downloads-image]][badge-downloads-url]
[![Size][badge-size-image]][badge-size-url]
[![Sponsors][badge-funding-sponsors-image]][badge-funding-url]
[![Backers][badge-funding-backers-image]][badge-funding-url]
[![Chat][badge-chat-image]][badge-chat-url]

[`remark-lint`][github-remark-lint] rule to warn when headings are too long.

## Contents

* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Presets](#presets)
* [Install](#install)
* [Use](#use)
* [API](#api)
  * [`unified().use(remarkLintMaximumHeadingLength[, options])`](#unifieduseremarklintmaximumheadinglength-options)
  * [`Options`](#options)
* [Recommendation](#recommendation)
* [Examples](#examples)
* [Compatibility](#compatibility)
* [Contribute](#contribute)
* [License](#license)

## What is this?

This package checks the length of heading text.

## When should I use this?

You can use this package to check that heading text is within reason.

## Presets

This plugin is included in the following presets:

| Preset | Options |
| - | - |
| [`remark-preset-lint-markdown-style-guide`](https://github.com/remarkjs/remark-lint/tree/main/packages/remark-preset-lint-markdown-style-guide) | |

## Install

This package is [ESM only][github-gist-esm].
In Node.js (version 16+),
install with [npm][npm-install]:

```sh
npm install remark-lint-maximum-heading-length
```

In Deno with [`esm.sh`][esm-sh]:

```js
import remarkLintMaximumHeadingLength from 'https://esm.sh/remark-lint-maximum-heading-length@4'
```

In browsers with [`esm.sh`][esm-sh]:

```html
<script type="module">
  import remarkLintMaximumHeadingLength from 'https://esm.sh/remark-lint-maximum-heading-length@4?bundle'
</script>
```

## Use

On the API:

```js
import remarkLint from 'remark-lint'
import remarkLintMaximumHeadingLength from 'remark-lint-maximum-heading-length'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'

const file = await read('example.md')

await unified()
  .use(remarkParse)
  .use(remarkLint)
  .use(remarkLintMaximumHeadingLength)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))
```

On the CLI:

```sh
remark --frail --use remark-lint --use remark-lint-maximum-heading-length .
```

On the CLI in a config file (here a `package.json`):

```diff
 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-maximum-heading-length",
     …
   ]
 }
 …
```

## API

This package exports no identifiers.
It exports the [TypeScript][typescript] type
[`Options`][api-options].
The default export is
[`remarkLintMaximumHeadingLength`][api-remark-lint-maximum-heading-length].

### `unified().use(remarkLintMaximumHeadingLength[, options])`

Warn when headings are too long.

###### Parameters

* `options` ([`Options`][api-options] or `number`, optional)
  — configuration

###### Returns

Transform ([`Transformer` from `unified`][github-unified-transformer]).

### `Options`

Configuration (TypeScript type).

###### Properties

* `size` (`number`, default: `60`)
  — preferred max size
* `stringLength` (`(value: string) => number`, optional)
  — function to detect text size

## Recommendation

While this rule is sometimes annoying,
reasonable size headings do help SEO purposes (bots prefer reasonable
headings),
visual users (headings are typically displayed quite large),
and users of screen readers (who use “jump to heading” features that read
every heading out loud to navigate within a page).

To better represent how long headings “look”,
you can pass a `stringLength` function.

## Examples

##### `ok.md`

###### In

```markdown
# Mercury is the first planet from the Sun
```

###### Out

No messages.

##### `not-ok.md`

When configured with `30`.

###### In

```markdown
# Mercury is the first planet from the Sun
```

###### Out

```text
1:1-1:43: Unexpected `40` characters in heading, expected at most `30` characters
```

##### `string-length-default.md`

When configured with `30`.

###### In

```markdown
# 水星是太陽系的八大行星中最小和最靠近太陽的行星
```

###### Out

No messages.

##### `string-length-custom.md`

When configured with `{ size: 30, stringLength: [Function: stringWidth] }`.

###### In

```markdown
# 水星是太陽系的八大行星中最小和最靠近太陽的行星
```

###### Out

```text
1:1-1:26: Unexpected `46` characters in heading, expected at most `30` characters
```

##### `mdx.mdx`

When configured with `30`.

###### In

> 👉 **Note**: this example uses
> MDX ([`remark-mdx`][github-remark-mdx]).

```mdx
<h1>Mercury is the first planet from the Sun</h1>
```

###### Out

```text
1:1-1:50: Unexpected `40` characters in heading, expected at most `30` characters
```

##### `not-ok.md`

When configured with `'🌍'`.

###### Out

```text
1:1: Unexpected value `🌍` for `size`, expected `number`
```

## Compatibility

Projects maintained by the unified collective are compatible with maintained
versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line,
`remark-lint-maximum-heading-length@4`,
compatible with Node.js 16.

## Contribute

See [`contributing.md`][github-dotfiles-contributing] in [`remarkjs/.github`][github-dotfiles-health] for ways
to get started.
See [`support.md`][github-dotfiles-support] for ways to get help.

This project has a [code of conduct][github-dotfiles-coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.

## License

[MIT][file-license] © [Titus Wormer][author]

[api-options]: #options

[api-remark-lint-maximum-heading-length]: #unifieduseremarklintmaximumheadinglength-options

[author]: https://wooorm.com

[badge-build-image]: https://github.com/remarkjs/remark-lint/workflows/main/badge.svg

[badge-build-url]: https://github.com/remarkjs/remark-lint/actions

[badge-chat-image]: https://img.shields.io/badge/chat-discussions-success.svg

[badge-chat-url]: https://github.com/remarkjs/remark/discussions

[badge-coverage-image]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg

[badge-coverage-url]: https://codecov.io/github/remarkjs/remark-lint

[badge-downloads-image]: https://img.shields.io/npm/dm/remark-lint-maximum-heading-length.svg

[badge-downloads-url]: https://www.npmjs.com/package/remark-lint-maximum-heading-length

[badge-funding-backers-image]: https://opencollective.com/unified/backers/badge.svg

[badge-funding-sponsors-image]: https://opencollective.com/unified/sponsors/badge.svg

[badge-funding-url]: https://opencollective.com/unified

[badge-size-image]: https://img.shields.io/bundlejs/size/remark-lint-maximum-heading-length

[badge-size-url]: https://bundlejs.com/?q=remark-lint-maximum-heading-length

[esm-sh]: https://esm.sh

[file-license]: https://github.com/remarkjs/remark-lint/blob/main/license

[github-dotfiles-coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md

[github-dotfiles-contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md

[github-dotfiles-health]: https://github.com/remarkjs/.github

[github-dotfiles-support]: https://github.com/remarkjs/.github/blob/main/support.md

[github-gist-esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[github-remark-lint]: https://github.com/remarkjs/remark-lint

[github-remark-mdx]: https://mdxjs.com/packages/remark-mdx/

[github-unified-transformer]: https://github.com/unifiedjs/unified#transformer

[npm-install]: https://docs.npmjs.com/cli/install

[typescript]: https://www.typescriptlang.org

---
_Source: https://npm.io/package/remark-lint-maximum-heading-length · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._