mirror of
https://github.com/remarkjs/remark-lint.git
synced 2024-10-27 11:47:47 +03:00
282d27606d
This commit rewrites most of the documentation per rule and preset, `remark-lint` itself, and `unified-lint-rule`. * Better and more readable automatic examples * Check and update all rule descriptions * Use middot (·) and line-feed (␊) for relevant examples * Unify descriptions of `'consistent`' * Add some more docs where needed Closes GH-158. |
||
|---|---|---|
| .. | ||
| index.js | ||
| package.json | ||
| readme.md | ||
remark-lint-no-shell-dollars
Warn when shell code is prefixed by dollar-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
valid.md
In
```sh
echo a
echo a > file
```
```zsh
$ echo a
a
$ echo a > file
```
It’s fine to use dollars in non-shell code.
```js
$('div').remove();
```
Out
No messages.
invalid.md
In
```bash
$ echo a
$ echo a > file
```
Out
1:1-4:4: Do not use dollar signs before shell-commands
Install
npm install remark-lint-no-shell-dollars
Usage
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));
});