remark-lint rule to warn when every line in shell code is preceded by $s.

• What is this?
• When should I use this?
• Presets
• Install
• Use
• API
  • unified().use(remarkLintNoShellDollars)
• Recommendation
• Examples
• Compatibility
• Contribute
• License

This package checks for $ markers prefixing shell code, which are hard to copy/paste.

You can use this package to check shell code blocks.

This plugin is included in the following presets:

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

npm install remark-lint-no-shell-dollars

In Deno with esm.sh:

import remarkLintNoShellDollars from 'https://esm.sh/remark-lint-no-shell-dollars@4'

In browsers with esm.sh:

<script type="module">
  import remarkLintNoShellDollars from 'https://esm.sh/remark-lint-no-shell-dollars@4?bundle'
</script>

On the API:

import remarkLint from 'remark-lint'
import remarkLintNoShellDollars from 'remark-lint-no-shell-dollars'
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(remarkLintNoShellDollars)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-no-shell-dollars .

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

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

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

Warn when every line in shell code is preceded by $s.

There are no options.

Transform (Transformer from unified).

Dollars make copy/pasting hard. Either put dollars in front of some lines (commands) and don’t put them in front of other lines (output), or use different code blocks for commands and output.

```bash
echo "Mercury and Venus"
```

```sh
echo "Mercury and Venus"
echo "Earth and Mars" > file
```

Mixed dollars for input lines and without for output is also OK:

```zsh
$ echo "Mercury and Venus"
Mercury and Venus
$ echo "Earth and Mars" > file
```

```command
```

```js
$('div').remove()
```

No messages.

```sh
$ echo "Mercury and Venus"
```

```bash
$ echo "Mercury and Venus"
$ echo "Earth and Mars" > file
```

1:1-3:4: Unexpected shell code with every line prefixed by `$`, expected different code for input and output
5:1-8:4: Unexpected shell code with every line prefixed by `$`, expected different code for input and output

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-shell-dollars@4, compatible with Node.js 16.

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.

MIT © Titus Wormer