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

Comparing version 1.0.2 to 1.0.3

index.js

@@ -7,3 +7,6 @@ /**
  * @fileoverview
- *   Warn when URLs without angle-brackets are used.
+ *   Warn for literal URLs in text.
+ *   URLs are treated as links in some Markdown vendors, but not in others.
+ *   To make sure they are always linked, wrap them in `<` (less-than) and `>`
+ *   (greater-than).
  *
@@ -13,5 +16,6 @@ *   ## Fix
  *   [`remark-stringify`](https://github.com/remarkjs/remark/tree/master/packages/remark-stringify)
- *   never creates literal URLs and always uses angle-brackets.
+ *   never creates literal URLs and always uses `<` (less-than) and `>`
+ *   (greater-than).
  *
- *   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.
@@ -18,0 +22,0 @@ *

package.json

 {
   "name": "remark-lint-no-literal-urls",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "remark-lint rule to warn when URLs without angle-brackets are used",
@@ -15,5 +15,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)"
   ],
@@ -20,0 +20,0 @@ "files": [

readme.md

@@ -5,10 +5,22 @@ <!--This file is generated-->
 
-Warn when URLs without angle-brackets are used.
+[![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]
 
+Warn for literal URLs in text.
+URLs are treated as links in some Markdown vendors, but not in others.
+To make sure they are always linked, wrap them in `<` (less-than) and `>`
+(greater-than).
+
 ## Fix
 
 [`remark-stringify`](https://github.com/remarkjs/remark/tree/master/packages/remark-stringify)
-never creates literal URLs and always uses angle-brackets.
+never creates literal URLs and always uses `<` (less-than) and `>`
+(greater-than).
 
-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.
@@ -55,2 +67,4 @@
 
+[npm][]:
+
 ```sh
@@ -60,3 +74,3 @@ npm install remark-lint-no-literal-urls
 
-## Usage
+## Use
 
@@ -98,4 +112,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-no-literal-urls.svg
+
+[downloads]: https://www.npmjs.com/package/remark-lint-no-literal-urls
+
+[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-literal-urls.svg
+
+[size]: https://bundlephobia.com/result?p=remark-lint-no-literal-urls
+
+[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

No alert changes

Improved metrics

Total package byte prevSize

6605

increased by49.91%

Lines of code

58

increased by7.41%

Number of lines in readme file

162

increased by65.31%

No dependency changes