eslint-markdown

Appearance

no-shell-dollar

🔧 Fixable ⭐ CommonMark 🌟 GFM

🔗 Rule Source 🔗 Test Source

Disallow dollar signs before commands without showing output.

Rule Details ​

Shell examples often add $ before commands. This looks like a prompt but makes copied commands harder to run.

This rule reports $ only when each non-blank line is a command or a continued line. It reports nothing if the block also has output or other text.

A command may start with spaces or tabs. It must then have $ followed by at least one space or tab. Therefore, $npm install and a bare $ do not match.

An odd number of backslashes at the end of a line continues the command. The next line is part of the command and has no prompt to report. A blank line ends the continuation.

Examples ​

❌ Incorrect ​

Examples of incorrect code for this rule:

Default ​

md
<!-- eslint md/no-shell-dollar: 'error' -->

```sh

$ 
npm install
```

```sh

$ 
npm install

$ 
npm run build
```

```

$ 
ls
```

    
$ 
ls

```sh

$ 
npm install \
    --save-dev eslint
```

Differences from markdownlint rule MD014

Unlike markdownlint rule MD014, this rule recognizes commands continued with a backslash. It reports the $ in this block.

md
<!-- eslint md/no-shell-dollar: 'error' -->

```sh

$ 
npm install \
    --save-dev eslint
```

With { skipCode: ['console'] } Option ​

md
<!-- eslint md/no-shell-dollar: ['error', { skipCode: ['console'] }] -->

```sh

$ 
npm install
```

✅ Correct ​

Examples of correct code for this rule:

Default ​

md
<!-- eslint md/no-shell-dollar: 'error' -->

```sh
npm install
npm run build
```

```sh
$ npm --version
10.9.2
```

```sh
$npm install
```

```sh
echo $PATH
```

```sh
$ npm install \
    --save-dev eslint
added 1 package
```

With { skipCode: ['console'] } Option ​

md
<!-- eslint md/no-shell-dollar: ['error', { skipCode: ['console'] }] -->

```console
$ npm install
```

Options ​

js
'md/no-shell-dollar': ['error', {
  skipCode: [],
}]

skipCode ​

Type: string[] / Default: []

string[] allows dollar signs before commands only in code blocks for the specified languages. Matching is case-sensitive: sh and SH differ.

This option cannot skip indented code blocks or fenced code blocks without a language.

Fix ​

This rule removes the dollar sign and the whitespace that follows it, leaving the indentation of the line untouched.

Prior Art ​