remark-lint-no-file-name-articles - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "remark-lint-no-file-name-articles",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "remark-lint rule to warn when file name start with an article",
@@ -5,0 +5,0 @@ "license": "MIT",

readme.md

@@ -7,19 +7,22 @@ <!--This file is generated-->
 
-## Install
+## Presets
 
-```sh
-npm install --save remark-lint-no-file-name-articles
-```
+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) |  |
+
 ## Example
 
-When this rule is turned on, the following file
-`title.md` is ok:
+##### `title.md`
 
-```markdown
+###### Out
 
-```
+No messages.
 
-When turned on is passed in, the following error is given:
+##### `a-title.md`
 
+###### Out
+
 ```text
@@ -29,4 +32,6 @@ 1:1: Do not start file names with `a`
 
-When turned on is passed in, the following error is given:
+##### `the-title.md`
 
+###### Out
+
 ```text
@@ -36,4 +41,6 @@ 1:1: Do not start file names with `the`
 
-When turned on is passed in, the following error is given:
+##### `teh-title.md`
 
+###### Out
+
 ```text
@@ -43,4 +50,6 @@ 1:1: Do not start file names with `teh`
 
-When turned on is passed in, the following error is given:
+##### `an-article.md`
 
+###### Out
+
 ```text
@@ -50,4 +59,47 @@ 1:1: Do not start file names with `an`
 
+## Install
+
+```sh
+npm install remark-lint-no-file-name-articles
+```
+
+## Usage
+
+You probably want to use it on the CLI through a config file:
+
+```diff
+ ...
+ "remarkConfig": {
+   "plugins": [
+     ...
+     "lint",
++    "lint-no-file-name-articles",
+     ...
+   ]
+ }
+ ...
+```
+
+Or use it on the CLI directly
+
+```sh
+remark -u lint -u lint-no-file-name-articles 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-file-name-articles'))
+   .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

3411

increased by27.18%

Number of lines in readme file

101

increased by106.12%

No dependency changes