Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

remark-lint-maximum-heading-length

Package Overview
Dependencies
Maintainers
2
Versions
13
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

remark-lint-maximum-heading-length

remark-lint rule to warn when headings are too long

  • 3.0.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
75K
decreased by-11.29%
Maintainers
2
Weekly downloads
 
Created
Source

remark-lint-maximum-heading-length

Build Coverage Downloads Size Sponsors Backers Chat

Warn when headings are too long.

Options: number, default: 60.

Ignores Markdown syntax, only checks the plain text content.

Presets

This rule is included in the following presets:

PresetSetting
remark-preset-lint-markdown-style-guide

Example

not-ok.md

When configured with 40.

In
# Alpha bravo charlie delta echo foxtrot golf hotel
Out
1:1-1:52: Use headings shorter than `40`
ok.md
In
# Alpha bravo charlie delta echo foxtrot golf hotel

# ![Alpha bravo charlie delta echo foxtrot golf hotel](http://example.com/nato.png)
Out

No messages.

Install

This package is ESM only: Node 12+ is needed to use it and it must be importeded instead of requiredd.

npm:

npm install remark-lint-maximum-heading-length

This package exports no identifiers. The default export is remarkLintMaximumHeadingLength.

Use

You probably want to use it on the CLI through a config file:

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

Or use it on the CLI directly

remark -u lint -u lint-maximum-heading-length readme.md

Or use this on the API:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintMaximumHeadingLength from 'remark-lint-maximum-heading-length'

 remark()
   .use(remarkLint)
+  .use(remarkLintMaximumHeadingLength)
   .process('_Emphasis_ and **importance**')
   .then((file) => {
     console.error(reporter(file))
   })

Contribute

See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help.

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

License

MIT © Titus Wormer

Keywords

FAQs

Package last updated on 12 Aug 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc