remark-lint-no-shell-dollars

    2.0.2 • Public • Published

    remark-lint-no-shell-dollars

    Build Coverage Downloads Size Sponsors Backers Chat

    Warn when shell code is prefixed by $ (dollar sign) characters.

    Ignores indented code blocks and fenced code blocks without language flag.

    Presets

    This rule is included in the following presets:

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

    Example

    ok.md
    In
    ```bash
    echo a
    ```
     
    ```sh
    echo a
    echo a > file
    ```
     
    ```zsh
    $ echo a
    a
    $ echo a > file
    ```
     
    Some empty code:
     
    ```command
    ```
     
    It’s fine to use dollars in non-shell code.
     
    ```js
    $('div').remove();
    ```
    Out

    No messages.

    not-ok.md
    In
    ```sh
    echo a
    ```
     
    ```bash
    echo a
    echo a > file
    ```
    Out
    1:1-3:4: Do not use dollar signs before shell commands
    5:1-8:4: Do not use dollar signs before shell commands

    Install

    npm:

    npm install remark-lint-no-shell-dollars

    Use

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

     …
     "remarkConfig": {
       "plugins": [
         …
         "lint",
    +    "lint-no-shell-dollars",
         …
       ]
     }
     …

    Or use it on the CLI directly

    remark -u lint -u lint-no-shell-dollars readme.md

    Or use this on the API:

     var remark = require('remark')
     var report = require('vfile-reporter')
     
     remark()
       .use(require('remark-lint'))
    +  .use(require('remark-lint-no-shell-dollars'))
       .process('_Emphasis_ and **importance**', function (err, file) {
         console.error(report(err || 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

    Install

    npm i remark-lint-no-shell-dollars

    DownloadsWeekly Downloads

    22,105

    Version

    2.0.2

    License

    MIT

    Unpacked Size

    6.69 kB

    Total Files

    3

    Last publish

    Collaborators

    • avatar
    • avatar