remark-lint-no-table-indentation - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

index.js

@@ -21,5 +21,5 @@ /**
  *
- *      | A     | B     |
- *      | ----- | ----- |
- *      | Alpha | Bravo |
+ *   ···| A     | B     |
+ *   ···| ----- | ----- |
+ *   ···| Alpha | Bravo |
  *
@@ -26,0 +26,0 @@ * @example {"name": "invalid.md", "label": "output"}

package.json

 {
   "name": "remark-lint-no-table-indentation",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "remark-lint rule to warn when tables are indented",
@@ -5,0 +5,0 @@ "license": "MIT",

readme.md

@@ -7,13 +7,16 @@ <!--This file is generated-->
 
-## Install
+## Presets
 
-```sh
-npm install --save remark-lint-no-table-indentation
-```
+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
-`valid.md` is ok:
+##### `valid.md`
 
+###### In
+
 ```markdown
@@ -27,13 +30,22 @@ Paragraph.
 
-When this rule is turned on, the following file
-`invalid.md` is **not** ok:
+###### Out
 
+No messages.
+
+##### `invalid.md`
+
+###### In
+
+Note: `·` represents a space.
+
 ```markdown
 Paragraph.
 
-   | A     | B     |
-   | ----- | ----- |
-   | Alpha | Bravo |
+···| A     | B     |
+···| ----- | ----- |
+···| Alpha | Bravo |
 ```
 
+###### Out
+
 ```text
@@ -44,4 +56,47 @@ 3:1-3:21: Do not indent table rows
 
+## Install
+
+```sh
+npm install remark-lint-no-table-indentation
+```
+
+## Usage
+
+You probably want to use it on the CLI through a config file:
+
+```diff
+ ...
+ "remarkConfig": {
+   "plugins": [
+     ...
+     "lint",
++    "lint-no-table-indentation",
+     ...
+   ]
+ }
+ ...
+```
+
+Or use it on the CLI directly
+
+```sh
+remark -u lint -u lint-no-table-indentation 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-table-indentation'))
+   .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)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3691

increased by31.12%

Number of lines in readme file

100

increased by122.22%

No dependency changes