remark-lint-no-literal-urls - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

index.js

@@ -12,3 +12,2 @@ /**
  *   <http://foo.bar/baz>
- *   <mailto:[e-mail]>
  *
@@ -19,4 +18,2 @@ * @example {"name": "invalid.md", "label": "input"}
  *
- *   mailto:[e-mail]
- *
  * @example {"name": "invalid.md", "label": "output"}
@@ -23,0 +20,0 @@ *

package.json

 {
   "name": "remark-lint-no-literal-urls",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "remark-lint rule to warn when URLs without angle-brackets are used",
@@ -5,0 +5,0 @@ "license": "MIT",

readme.md

@@ -7,27 +7,35 @@ <!--This file is generated-->
 
-## Install
+## Presets
 
-```sh
-npm install --save remark-lint-no-literal-urls
-```
+This rule is included in the following presets:
 
+| Preset | Setting |
+| ------ | ------- |
+| [`remark-preset-lint-markdown-style-guide`](https://github.com/wooorm/remark-lint/tree/master/packages/remark-preset-lint-markdown-style-guide) |  |
+| [`remark-preset-lint-recommended`](https://github.com/wooorm/remark-lint/tree/master/packages/remark-preset-lint-recommended) |  |
+
 ## Example
 
-When this rule is turned on, the following file
-`valid.md` is ok:
+##### `valid.md`
 
+###### In
+
 ```markdown
 <http://foo.bar/baz>
-<mailto:[e-mail]>
 ```
 
-When this rule is turned on, the following file
-`invalid.md` is **not** ok:
+###### Out
 
+No messages.
+
+##### `invalid.md`
+
+###### In
+
 ```markdown
 http://foo.bar/baz
-
-mailto:[e-mail]
 ```
 
+###### Out
+
 ```text
@@ -37,4 +45,47 @@ 1:1-1:19: Don’t use literal URLs without angle brackets
 
+## Install
+
+```sh
+npm install remark-lint-no-literal-urls
+```
+
+## Usage
+
+You probably want to use it on the CLI through a config file:
+
+```diff
+ ...
+ "remarkConfig": {
+   "plugins": [
+     ...
+     "lint",
++    "lint-no-literal-urls",
+     ...
+   ]
+ }
+ ...
+```
+
+Or use it on the CLI directly
+
+```sh
+remark -u lint -u lint-no-literal-urls readme.md
+```
+
+Or use this on the API:
+
+```diff
+ var remark = require('remark');
+ var report = require('vfile-reporter');
+
+ remark()
+   .use(require('remark-lint'))
++  .use(require('remark-lint-no-literal-urls'))
+   .process('_Emphasis_ and **importance**', function (err, file) {
+     console.error(report(err || file));
+   });
+```
+
 ## License
 
 [MIT](https://github.com/wooorm/remark-lint/blob/master/LICENSE) © [Titus Wormer](http://wooorm.com)

No alert changes

Improved metrics

Total package byte prevSize

3790

28.74%

Number of lines in readme file

90

130.77%

Worsened metrics

Lines of code

50

-5.66%

No dependency changes