remark-lint rule to warn when block quotes are indented too much ortoo little.

• What is this?
• When should I use this?
• Presets
• Install
• Use
• API
  • unified().use(remarkLintBlockquoteIndentation[, options])
  • Options
• Recommendation
• Examples
• Compatibility
• Contribute
• License

This package checks the “indent” of block quotes: the> (greater than)markerand the spaces before content.

You can use this rule to check markdown code style.

This plugin is included in the following presets:

This package isESM only.In Node.js (version 16+),install withnpm:

npm install remark-lint-blockquote-indentation

In Deno withesm.sh:

importremarkLintBlockquoteIndentationfrom'https://esm.sh/remark-lint-blockquote-indentation@4'

In browsers withesm.sh:

<scripttype="module">importremarkLintBlockquoteIndentationfrom'https://esm.sh/remark-lint-blockquote-indentation@4?bundle'</script>

On the API:

importremarkLintfrom'remark-lint'importremarkLintBlockquoteIndentationfrom'remark-lint-blockquote-indentation'importremarkParsefrom'remark-parse'importremarkStringifyfrom'remark-stringify'import{read}from'to-vfile'import{unified}from'unified'import{reporter}from'vfile-reporter'constfile=awaitread('example.md')awaitunified().use(remarkParse).use(remarkLint).use(remarkLintBlockquoteIndentation).use(remarkStringify).process(file)console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-blockquote-indentation.

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

 … "remarkConfig": {   "plugins": [     …     "remark-lint",+    "remark-lint-blockquote-indentation",     …   ] } …

This package exports no identifiers.It exports theTypeScript typeOptions.The default export isremarkLintBlockquoteIndentation.

Warn when block quotes are indented too much or too little.

• options (Options, default:'consistent')— either a preferred indent or whether to detect the first styleand warn for further differences

Transform (Transformer fromunified).

Configuration (TypeScript type).

typeOptions=number|'consistent'

CommonMark specifies that when block quotes are used the> markers can befollowed by an optional space.No space at all arguably looks rather ugly:

>Mars and>Venus.

There is no specific handling of more that one space, so if 5 spaces wereused after>, then indented code kicks in:

>neptune()

Due to this, it’s recommended to configure this rule with2.

When configured with2.

>Mercury.Venus.>Earth.

No messages.

When configured with4.

>  Mercury.Venus.>  Earth.

No messages.

>␉Mercury.

No messages.

> Mercury.Venus.>  Earth.Mars.>Jupiter

5:5: Unexpected `4` spaces between block quote marker and content, expected `3` spaces, remove `1` space9:3: Unexpected `2` spaces between block quote marker and content, expected `3` spaces, add `1` space

When configured with'🌍'.

1:1: Unexpected value `🌍` for `options`, expected `number` or `'consistent'`

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

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

Seecontributing.md inremarkjs/.github for waysto get started.Seesupport.md for ways to get help.

This project has acode of conduct.By interacting with this repository, organization, or community you agree toabide by its terms.

MIT ©Titus Wormer