Restore checkRelative to turn off the checks for relative URIs

Author: nodaguti

ReadMe.md

@@ -59,13 +59,19 @@ The default options are:
 {
   "rules": {
     "no-dead-link": {
+      checkRelative: true,
       "baseURI": null,
       "ignore": [],
     }
   }
 }
 ```
 
+### checkRelative
+
+This rule checks the availability of relative URIs by default.
+You can turn off the checks by passing `false` to this option.
+
 ### baseURI
 
 The base URI to be used for resolving relative URIs.
@@ -93,14 +99,10 @@ An array of URIs to be ignored. These URIs will be skipped from the availability
 Example:
 
 ```
-{
-  "rules": {
-    "no-dead-link": {
-      "ignore": [
-        "http://example.com/not-exist/index.html"
-      ]
-    }
-  }
+"no-dead-link": {
+  "ignore": [
+    "http://example.com/not-exist/index.html"
+  ]
 }
 ```
 

src/no-dead-link.js

@@ -4,6 +4,7 @@ import URL from 'url';
 import fs from 'fs-extra';
 
 const DEFAULT_OPTIONS = {
+  checkRelative: true, // {boolean} `false` disables the checks for relative URIs
   baseURI: null, // {String|null} a base URI to resolve relative URIs.
   ignore: [], // {Array<String>} URIs to be skipped from availability checks.
 };
@@ -130,6 +131,10 @@ function reporter(context, options = {}) {
     }
 
     if (isRelative(uri)) {
+      if (!opts.checkRelative) {
+        return;
+      }
+
       const filePath = getFilePath();
       const base = opts.baseURI || filePath;
       if (!base) {

test/no-dead-link.js

@@ -25,7 +25,6 @@ tester.run('no-dead-link', rule, {
       text:
         'should be able to check relative pathes when checkRelative is true: ![robot](index.html)',
       options: {
-        checkRelative: true,
         baseURI: 'https://example.com/',
       },
     },
@@ -36,6 +35,13 @@ tester.run('no-dead-link', rule, {
         ignore: ['https://example.com/404.html'],
       },
     },
+    {
+      text:
+        'should ignore relative URIs when `checkRelative` is false: [test](./a.md).',
+      options: {
+        checkRelative: false,
+      },
+    },
     {
       text: fs.readFileSync(path.join(__dirname, 'fixtures/a.md'), 'utf-8'),
       options: {