unified

Project: remarkjs/remark-lint

Package: remark-lint-no-paragraph-content-indent@4.1.1

  1. Dependents: 0
  2. remark-lint rule to warn when the content in paragraphs are indented
  1. remark 214
  2. lint 80
  3. rule 75
  4. remark-lint-rule 68
  5. content 20
  6. indent 8
  7. paragraph 4

remark-lint-no-paragraph-content-indent

Build Coverage Downloads Size Sponsors Backers Chat

remark-lint rule to warn when text in paragraphs is indented.

Contents

What is this?

This package checks that text in paragraphs is not indented.

When should I use this?

You can use this package to check that paragraphs are consistent.

Presets

This plugin is not included in presets maintained here.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install remark-lint-no-paragraph-content-indent

In Deno with esm.sh:

import remarkLintNoParagraphContentIndent from 'https://esm.sh/remark-lint-no-paragraph-content-indent@4'

In browsers with esm.sh:

<script type="module">
  import remarkLintNoParagraphContentIndent from 'https://esm.sh/remark-lint-no-paragraph-content-indent@4?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintNoParagraphContentIndent from 'remark-lint-no-paragraph-content-indent'
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(remarkLintNoParagraphContentIndent)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-no-paragraph-content-indent .

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-no-paragraph-content-indent",
     …
   ]
 }
 …

API

This package exports no identifiers. It exports no additional TypeScript types. The default export is remarkLintNoParagraphContentIndent.

unified().use(remarkLintNoParagraphContentIndent)

Warn when text in paragraphs is indented.

Parameters

There are no options.

Returns

Transform (Transformer from unified).

Recommendation

Indenting further lines in a paragraph has no effect. So it’s recommended to turn this rule on.

Examples

ok.md
In
Alpha

Bravo
Charlie.
**Delta**.

*   Echo
    Foxtrot.

> Golf
> Hotel.

`india()`
juliett.

-   `kilo()`
    lima.

-   `mike()` - november.

![image]() text

![image reference][] text

[![][text]][text]
Out

No messages.

not-ok.md
In
␠Alpha

Bravo
␠Charlie.

*   Delta
    ␠Echo.

> Foxtrot
> ␠Golf.

`hotel()`
␠india.

-   `juliett()`
    ␠kilo.

␠![lima]() mike

* november
oscar
  ␠papa.
Out
1:2: Expected no indentation in paragraph content
4:2: Expected no indentation in paragraph content
7:6: Expected no indentation in paragraph content
10:4: Expected no indentation in paragraph content
13:2: Expected no indentation in paragraph content
16:6: Expected no indentation in paragraph content
18:2: Expected no indentation in paragraph content
22:4: Expected no indentation in paragraph content

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-no-paragraph-content-indent@4, compatible with Node.js 12.

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