Neck Protection Mandate

    remark-lint-no-blockquote-without-marker
    TypeScript icon, indicating that this package has built-in type declarations

    5.1.1 • Public • Published

    remark-lint-no-blockquote-without-marker

    Build Coverage Downloads Size Sponsors Backers Chat

    remark-lint rule to warn when lines in block quotes start without >.

    Contents

    What is this?

    This package is a unified (remark) plugin, specifically a remark-lint rule. Lint rules check markdown code style.

    When should I use this?

    You can use this package to check that lines in block quotes start with >.

    Presets

    This rule is included in the following presets:

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

    Install

    This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

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

    In Deno with Skypack:

    import remarkLintNoBlockquoteWithoutMarker from 'https://cdn.skypack.dev/remark-lint-no-blockquote-without-marker@5?dts'

    In browsers with Skypack:

    <script type="module">
      import remarkLintNoBlockquoteWithoutMarker from 'https://cdn.skypack.dev/remark-lint-no-blockquote-without-marker@5?min'
    </script>

    Use

    On the API:

    import {read} from 'to-vfile'
    import {reporter} from 'vfile-reporter'
    import {remark} from 'remark'
    import remarkLint from 'remark-lint'
    import remarkLintNoBlockquoteWithoutMarker from 'remark-lint-no-blockquote-without-marker'
    
    main()
    
    async function main() {
      const file = await remark()
        .use(remarkLint)
        .use(remarkLintNoBlockquoteWithoutMarker)
        .process(await read('example.md'))
    
      console.error(reporter(file))
    }

    On the CLI:

    remark --use remark-lint --use remark-lint-no-blockquote-without-marker example.md

    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. The default export is remarkLintNoBlockquoteWithoutMarker.

    unified().use(remarkLintNoBlockquoteWithoutMarker[, config])

    This rule supports standard configuration that all remark lint rules accept (such as false to turn it off or [1, options] to configure it).

    There are no options.

    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
    > 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
    

    Compatibility

    Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

    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

    Install

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

    DownloadsWeekly Downloads

    94,079

    Version

    5.1.1

    License

    MIT

    Unpacked Size

    11 kB

    Total Files

    4

    Last publish

    Collaborators

    • johno
    • wooorm