markdown-body entry-content container-lg" itemprop="text">

remark-lint rule to warn when headings have too many or too few words

remark-lint-heading-word-length

This is a remark-lint rule to warn when headings have too many or too few words. Headings are split into words by the regular expression \s.

This package is a spiritual fork of the archived remark-lint-heading-length package, which has a couple of flaws.

Install
Usage
API
- Options
Examples
- ok.md
- not-ok.md
Related
Appendix
- Published Package Details
- License
Contributing and Support
- Contributors

Install

Due to the nature of the unified ecosystem, this package is ESM only and cannot be require'd.

To install:

npm install --save-dev remark-lint-heading-word-length

Usage

For maximum flexibility, there are several ways this plugin can be invoked.

Via API

import { read } from 'to-vfile';
import { reporter } from 'vfile-reporter';
import { remark } from 'remark';
import remarkLint from 'remark-lint';
import lintHeadingWordLength from 'remark-lint-heading-word-length';

const file = await remark()
  .use(remarkLint)
  .use(lintHeadingWordLength)
  .process(await read('example.md'));

console.log(reporter(file));

Via remark-cli

remark --use remark-lint --use lint-heading-word-length README.md

Via unified configuration

In package.json:

  /* … */
  "remarkConfig": {
    "plugins": [
      "remark-lint-heading-word-length"
      /* … */
    ]
  },
  /* … */

In .remarkrc.js:

module.exports = {
  plugins: [
    // …
    'lint-heading-word-length'
  ]
};

In .remarkrc.mjs:

import lintHeadingWordLength from 'remark-lint-heading-word-length';

export default {
  plugins: [
    // …
    lintHeadingWordLength
  ]
};

API

Detailed interface information can be found under docs/.

Options

This rule supports standard configuration that all remark lint rules accept (such as false to turn it off or [1, options] to configure it).

Additionally, this plugin recognizes the following options:

`minimumWords`

Valid values: false | number
Default: 1

The minimum number of words required in a heading.

Set to false to prevent minimum word length checks.

`maximumWords`

Valid values: false | number
Default: 10

The maximum number of words allowed in a heading.

Set to false (or Infinity) to prevent maximum word length checks.

Examples

`ok.md`

In

# `options.optionA`

# This right here is essentially a ten (10) word heading

Out

No messages.

`not-ok.md`

In

# This right here is a ten + one (11) word heading

#

Out

1:1-1:51: Heading must have at most 10 words (current length: 11)
3:1-3:2: Heading must have at least 1 word (current length: 0)

remark-lint-heading-length — archived predecessor to this package with a couple flaws.
remark-lint-maximum-heading-length — warn when headings are too long (too many characters).

Appendix

Further documentation can be found under docs/.

Published Package Details

This is an ESM-only package built by Babel for use in Node.js versions that are not end-of-life. For TypeScript users, this package supports both "Node10" and "Node16" module resolution strategies.

Expand details

That means ESM source will load this package via import { ... } from ... or await import(...) and CJS source will load this package via dynamic import(). This has several benefits, the foremost being: less code shipped/smaller package size, avoiding dual package hazard entirely, distributables are not packed/bundled/uglified, and a drastically less complex build process.

The glaring downside, which may or may not be relevant, is that CJS consumers cannot require() this package and can only use import() in an asynchronous context. This means, in effect, CJS consumers may not be able to use this package at all.

Each entry point (i.e. ENTRY) in package.json's exports[ENTRY] object includes one or more export conditions. These entries may or may not include: an exports[ENTRY].types condition pointing to a type declaration file for TypeScript and IDEs, a exports[ENTRY].module condition pointing to (usually ESM) source for Webpack/Rollup, a exports[ENTRY].node and/or exports[ENTRY].default condition pointing to (usually CJS2) source for Node.js require/import and for browsers and other environments, and other conditions not enumerated here. Check the package.json file to see which export conditions are supported.

Note that, regardless of the { "type": "..." } specified in package.json, any JavaScript files written in ESM syntax (including distributables) will always have the .mjs extension. Note also that package.json may include the sideEffects key, which is almost always false for optimal tree shaking where appropriate.

License

See LICENSE.

Contributing and Support

New issues and pull requests are always welcome and greatly appreciated! 🤩 Just as well, you can star 🌟 this project to let me know you found it useful! ✊🏿 Or buy me a beer, I'd appreciate it. Thank you!

See CONTRIBUTING.md and SUPPORT.md for more information.

Contributors

See the table of contributors.

티스토리 수익 글 보기

티스토리 수익 글 보기