remark-lint-no-shell-dollars

2018-11-13 admin

remark-lint-no-shell-dollars是什么

什么是remark-lint-no-shell-dollars,remark-lint rule to warn when shell code is prefixed by dollars

remark-lint-no-shell-dollars使用教程帮助文档

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
$ echo a
a
$ echo a > file

Some empty code:

It’s fine to use dollars in non-shell code.

$('div').remove();

###### Out

No messages.

##### `invalid.md`

###### In

```source-gfm
```bash
$ echo a
$ echo a > file

###### Out

1:1-4:4: Do not use dollar signs before shell-commands


## Install

```source-shell
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));
   });

License

MIT © Titus Wormer

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处。

转载请注明:文章转载自 JavaScript中文网 [https://www.javascriptcn.com]

本文地址:https://www.javascriptcn.com/read-45338.html

文章标题:remark-lint-no-shell-dollars

回到顶部