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

remark-lint-no-blockquote-without-marker

Package Overview
Dependencies
Maintainers
3
Versions
14
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

remark-lint-no-blockquote-without-marker

remark-lint rule to warn when blank lines without markers (`>`) are found in a block quote

  • 6.0.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
3
Created
Source

remark-lint-no-blockquote-without-marker

Build Coverage Downloads Size Sponsors Backers Chat

remark-lint rule to warn for lazy lines in block quotes.

Contents

What is this?

This package checks the style of block quotes.

When should I use this?

You can use this package to check that the style of block quotes is consistent.

Presets

This plugin is included in the following presets:

PresetOptions
remark-preset-lint-markdown-style-guide
remark-preset-lint-recommended

Install

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

npm install remark-lint-no-blockquote-without-marker

In Deno with esm.sh:

import remarkLintNoBlockquoteWithoutMarker from 'https://esm.sh/remark-lint-no-blockquote-without-marker@6'

In browsers with esm.sh:

<script type="module">
  import remarkLintNoBlockquoteWithoutMarker from 'https://esm.sh/remark-lint-no-blockquote-without-marker@6?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintNoBlockquoteWithoutMarker from 'remark-lint-no-blockquote-without-marker'
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(remarkLintNoBlockquoteWithoutMarker)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-no-blockquote-without-marker .

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-no-blockquote-without-marker",
     …
   ]
 }
 …

API

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

unified().use(remarkLintNoBlockquoteWithoutMarker)

Warn for lazy lines in block quotes.

Parameters

There are no options.

Returns

Transform (Transformer from unified).

Recommendation

Rules around lazy lines are not straightforward and visually confusing, so it’s recommended to start each line with a >.

Fix

remark-stringify adds > markers to every line in a block quote.

Examples

ok.md
In
> Mercury,
> Venus,
> and Earth.

Mars.
Out

No messages.

ok-tabs.md
In
>␉Mercury,
>␉Venus,
>␉and Earth.
Out

No messages.

not-ok.md
In
> Mercury,
Venus,
> and Earth.
Out
2:1: Unexpected `0` block quote markers before paragraph line, expected `1` marker, add `1` marker
not-ok-tabs.md
In
>␉Mercury,
␉Venus,
and Earth.
Out
2:2: Unexpected `0` block quote markers before paragraph line, expected `1` marker, add `1` marker
3:1: Unexpected `0` block quote markers before paragraph line, expected `1` marker, add `1` marker
containers.md
In
* > Mercury and
Venus.

> * Mercury and
  Venus.

* > * Mercury and
    Venus.

> * > Mercury and
      Venus.

***

> * > Mercury and
>     Venus.
Out
2:1: Unexpected `0` block quote markers before paragraph line, expected `1` marker, add `1` marker
5:3: Unexpected `0` block quote markers before paragraph line, expected `1` marker, add `1` marker
8:5: Unexpected `0` block quote markers before paragraph line, expected `1` marker, add `1` marker
11:7: Unexpected `0` block quote markers before paragraph line, expected `2` markers, add `2` markers
16:7: Unexpected `1` block quote marker before paragraph line, expected `2` markers, add `1` marker

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-blockquote-without-marker@6, 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

Keywords

FAQs

Package last updated on 09 Apr 2024

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