remark-lint-no-paragraph-content-indent

remark-lint-no-paragraph-content-indent

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

Contents

• What is this?
• When should I use this?
• Presets
• Install
• Use
• API
  • unified().use(remarkLintNoParagraphContentIndent)
• Recommendation
• Examples
• Compatibility
• Contribute
• License

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@5'

In browsers with esm.sh:

<script type="module">
  import remarkLintNoParagraphContentIndent from 'https://esm.sh/remark-lint-no-paragraph-content-indent@5?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

Mercury.

Venus and
**Earth**.

* Mars and
  Jupiter.

> Saturn and
> Uranus.

Out

No messages.

not-ok.md

In

␠Mercury.

Venus and
␠␠**Earth**.

* Mars and
  ␠␠Jupiter.

> Saturn and
> ␠Uranus.

* Neptune
and
  ␠␠Pluto.

> Ceres
and
> ␠Makemake.

Out

1:2: Unexpected `1` extra space before content line, remove `1` space
4:3: Unexpected `2` extra spaces before content line, remove `2` spaces
7:5: Unexpected `2` extra spaces before content line, remove `2` spaces
10:4: Unexpected `1` extra space before content line, remove `1` space
14:5: Unexpected `2` extra spaces before content line, remove `2` spaces
18:4: Unexpected `1` extra space before content line, remove `1` space

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@5, compatible with Node.js 16.

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