remark-lint-rule-style - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

index.js

@@ -7,12 +7,11 @@ /**
  * @fileoverview
- *   Warn when the horizontal rules violate a given or detected style.
+ *   Warn when the thematic breaks (horizontal rules) violate a given or
+ *   detected style.
  *
- *   Options: `string`, either a valid markdown rule, or `'consistent'`,
+ *   Options: `string`, either a valid thematic breaks, or `'consistent'`,
  *   default: `'consistent'`.
  *
- *   `'consistent'` detects the first used rule style and warns when subsequent
- *   rules use different styles.
+ *   `'consistent'` detects the first used thematic break style and warns when
+ *   subsequent rules use different styles.
  *
- *   Note: horizontal rules are also called “thematic break”.
- *
  *   ## Fix
@@ -30,3 +29,3 @@ *
  *
- *   See [Using remark to fix your markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown)
+ *   See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown)
  *   on how to automatically fix warnings for this rule.
@@ -33,0 +32,0 @@ *

package.json

 {
   "name": "remark-lint-rule-style",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "remark-lint rule to warn when horizontal rules violate a given style",
@@ -17,5 +17,5 @@ "license": "MIT",
   "bugs": "https://github.com/remarkjs/remark-lint/issues",
-  "author": "Titus Wormer <[e-mail]> (http://wooorm.com)",
+  "author": "Titus Wormer <[e-mail]> (https://wooorm.com)",
   "contributors": [
-    "Titus Wormer <[e-mail]> (http://wooorm.com)"
+    "Titus Wormer <[e-mail]> (https://wooorm.com)"
   ],
@@ -22,0 +22,0 @@ "files": [

readme.md

@@ -5,12 +5,19 @@ <!--This file is generated-->
 
-Warn when the horizontal rules violate a given or detected style.
+[![Build][build-badge]][build]
+[![Coverage][coverage-badge]][coverage]
+[![Downloads][downloads-badge]][downloads]
+[![Size][size-badge]][size]
+[![Sponsors][sponsors-badge]][collective]
+[![Backers][backers-badge]][collective]
+[![Chat][chat-badge]][chat]
 
-Options: `string`, either a valid markdown rule, or `'consistent'`,
+Warn when the thematic breaks (horizontal rules) violate a given or
+detected style.
+
+Options: `string`, either a valid thematic breaks, or `'consistent'`,
 default: `'consistent'`.
 
-`'consistent'` detects the first used rule style and warns when subsequent
-rules use different styles.
+`'consistent'` detects the first used thematic break style and warns when
+subsequent rules use different styles.
 
-Note: horizontal rules are also called “thematic break”.
-
 ## Fix
@@ -28,3 +35,3 @@
 
-See [Using remark to fix your markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown)
+See [Using remark to fix your Markdown](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown)
 on how to automatically fix warnings for this rule.
@@ -103,2 +110,4 @@
 
+[npm][]:
+
 ```sh
@@ -108,3 +117,3 @@ npm install remark-lint-rule-style
 
-## Usage
+## Use
 
@@ -146,4 +155,54 @@ You probably want to use it on the CLI through a config file:
 
+## Contribute
+
+See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways
+to get started.
+See [`support.md`][support] for ways to get help.
+
+This project has a [Code of Conduct][coc].
+By interacting with this repository, organisation, or community you agree to
+abide by its terms.
+
 ## License
 
-[MIT](https://github.com/remarkjs/remark-lint/blob/master/LICENSE) © [Titus Wormer](http://wooorm.com)
+[MIT][license] © [Titus Wormer][author]
+
+[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg
+
+[build]: https://travis-ci.org/remarkjs/remark-lint
+
+[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg
+
+[coverage]: https://codecov.io/github/remarkjs/remark-lint
+
+[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-rule-style.svg
+
+[downloads]: https://www.npmjs.com/package/remark-lint-rule-style
+
+[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-rule-style.svg
+
+[size]: https://bundlephobia.com/result?p=remark-lint-rule-style
+
+[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
+
+[backers-badge]: https://opencollective.com/unified/backers/badge.svg
+
+[collective]: https://opencollective.com/unified
+
+[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg
+
+[chat]: https://spectrum.chat/unified/remark
+
+[npm]: https://docs.npmjs.com/cli/install
+
+[health]: https://github.com/remarkjs/.github
+
+[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md
+
+[support]: https://github.com/remarkjs/.github/blob/master/support.md
+
+[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md
+
+[license]: https://github.com/remarkjs/remark-lint/blob/master/license
+
+[author]: https://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

8384

increased by26.51%

Number of lines in readme file

204

increased by40.69%

Worsened metrics

Lines of code

89

decreased by-1.11%

No dependency changes