remarkjs/remark-lint
1
1
Fork 0
mirror of https://github.com/remarkjs/remark-lint.git synced 2024-09-19 07:37:57 +03:00
Code Issues Projects Releases Wiki Activity
bd95e6e736
remark-lint/packages/remark-lint-no-blockquote-without-marker
History
Masafumi Koba 359cd0828e
Add repository.directory field to package.jsons 
This change updates the `repository` field in all `package.json`s to add a `directory`.
This also modifies the scripts to get the repository URLs.

Closes GH-268.
Closes GH-269.

Reviewed-by: Titus Wormer <tituswormer@gmail.com>
2021-08-16 11:10:08 +02:00
..
index.js Add JSDoc based types 2021-08-12 14:01:59 +02:00
package.json Add repository.directory field to package.jsons 2021-08-16 11:10:08 +02:00
readme.md Add JSDoc based types 2021-08-12 14:01:59 +02:00
tsconfig.json Add JSDoc based types 2021-08-12 14:01:59 +02:00

readme.md

remark-lint-no-blockquote-without-marker

Build Coverage Downloads Size Sponsors Backers Chat

Warn when blank lines without > (greater than) markers are found in a block quote.

Fix

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

See Using remark to fix your Markdown on how to automatically fix warnings for this rule.

Presets

This rule is included in the following presets:

Preset Setting
remark-preset-lint-markdown-style-guide
remark-preset-lint-recommended

Example

ok.md
In
> Foo…
> …bar…
> …baz.
Out

No messages.

ok-tabs.md
In

Note: » represents a tab.

>»Foo…
>»…bar…
>»…baz.
Out

No messages.

not-ok.md
In
> Foo…
…bar…
> …baz.
Out
2:1: Missing marker in block quote
not-ok-tabs.md
In

Note: » represents a tab.

>»Foo…
»…bar…
…baz.
Out
2:1: Missing marker in block quote
3:1: Missing marker in block quote

Install

This package is ESM only: Node 12+ is needed to use it and it must be importeded instead of requiredd.

npm:

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

This package exports no identifiers. The default export is remarkLintNoBlockquoteWithoutMarker.

Use

You probably want to use it on the CLI through a config file:

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

Or use it on the CLI directly

remark -u lint -u lint-no-blockquote-without-marker readme.md

Or use this on the API:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintNoBlockquoteWithoutMarker from 'remark-lint-no-blockquote-without-marker'

 remark()
   .use(remarkLint)
+  .use(remarkLintNoBlockquoteWithoutMarker)
   .process('_Emphasis_ and **importance**')
   .then((file) => {
     console.error(reporter(file))
   })

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