Add skipPathPatterns

Closes GH-18.

Author: wooorm

lib/index.js

@@ -24,6 +24,11 @@
  *   Path to Git root folder (default: local Git folder);
  *   if both `root` and `repository` are nullish, the Git root is detected;
  *   if `root` is not given but `repository` is, `file.cwd` is used.
+ * @property {ReadonlyArray<RegExp | string> | null | undefined} [skipPathPatterns]
+ *   List of patterns for *paths* that should be skipped;
+ *   each absolute local path + hash will be tested against each pattern and
+ *   will be ignored if `new RegExp(pattern).test(value) === true`;
+ *   example value are then `/Users/tilde/path/to/repo/readme.md#some-heading`.
  * @property {Readonly<UrlConfig> | null | undefined} [urlConfig]
  *   Config on how hosted Git works (default: detected from repo);
  *   `github.com`, `gitlab.com`, or `bitbucket.org` work automatically;
@@ -79,6 +84,8 @@
  *   Path to file.
  * @property {string | null | undefined} root
  *   Path to Git folder.
+ * @property {ReadonlyArray<RegExp>} skipPathPatterns
+ *   List of patterns for paths that should be skipped.
  * @property {Readonly<UrlConfig>} urlConfig
  *   Configuration.
  */
@@ -195,6 +202,11 @@ const readmeBasename = /^readme$/i
  */
 export default function remarkValidateLinks(options, fileSet) {
   const settings = options || {}
+  const skipPathPatterns = settings.skipPathPatterns
+    ? settings.skipPathPatterns.map(function (d) {
+        return typeof d === 'string' ? new RegExp(d) : d
+      })
+    : []
 
   // Attach a `completer`.
   if (fileSet) {
@@ -270,6 +282,7 @@ export default function remarkValidateLinks(options, fileSet) {
       base: absolute ? path.dirname(absolute) : file.cwd,
       path: absolute,
       root,
+      skipPathPatterns,
       urlConfig
     }
     /** @type {Set<string>} */
@@ -310,6 +323,15 @@ export default function remarkValidateLinks(options, fileSet) {
         if (info) {
           const fp = info.filePath
           const hash = info.hash
+          const together = fp + (hash ? '#' + hash : '')
+
+          if (
+            state.skipPathPatterns.some(function (skipPattern) {
+              return skipPattern.test(together)
+            })
+          ) {
+            return
+          }
 
           addReference(fp, '', node)
 
@@ -556,12 +578,14 @@ async function checkAll(files) {
  *   Landmarks.
  * @param {ReferenceInfo} reference
  *   Reference.
+ * @returns {undefined}
+ *   Nothing.
  */
 function warn(landmarks, reference) {
   const absolute = reference.file.path
     ? path.resolve(reference.file.cwd, reference.file.path)
     : ''
-  const base = absolute ? path.dirname(absolute) : null
+  const base = absolute ? path.dirname(absolute) : undefined
   const filePath = base
     ? path.relative(base, reference.reference.filePath)
     : reference.reference.filePath

readme.md

@@ -192,6 +192,12 @@ Configuration (TypeScript type).
   the Git root is detected;
   if `root` is not given but `repository` is,
   `file.cwd` is used
+* `skipPathPatterns`
+  (`Array<RegExp | string>`, optional)
+  — list of patterns for *paths* that should be skipped;
+  each absolute local path + hash will be tested against each pattern and
+  will be ignored if `new RegExp(pattern).test(value) === true`;
+  example value are then `/Users/tilde/path/to/repo/readme.md#some-heading`.
 * `urlConfig`
   ([`UrlConfig`][api-url-config], default: detected from repo)
   — config on how hosted Git works;

test/index.js

@@ -19,6 +19,7 @@ import remarkValidateLinks from 'remark-validate-links'
 import {remark} from 'remark'
 import stripAnsi from 'strip-ansi'
 import {read} from 'to-vfile'
+import {VFile} from 'vfile'
 import sort from './sort.js'
 
 const exec = promisify(execCallback)
@@ -93,6 +94,34 @@ test('remark-validate-links', async function (t) {
     assert.deepEqual(file.messages.map(String), [])
   })
 
+  await t.test('should support `skipUrlPatterns` (1)', async function () {
+    const file = await remark()
+      .use(remarkValidateLinks, {skipPathPatterns: ['#e']})
+      .use(sort)
+      .process('a [b](#c) [d](#e) f')
+
+    assert.deepEqual(file.messages.map(String), [
+      '1:3-1:10: Cannot find heading for `#c`'
+    ])
+  })
+
+  await t.test('should support `skipUrlPatterns` (2)', async function () {
+    const file = new VFile({
+      cwd: fileURLToPath(fakeBaseUrl),
+      path: 'example.md',
+      value: 'a [b](../../new/main/?filename=skeets/<your-path>.tweet) c'
+    })
+
+    await remark()
+      .use(remarkValidateLinks, {
+        skipPathPatterns: [/remark-validate-links[/\\]new[/\\]/]
+      })
+      .use(sort)
+      .process(file)
+
+    assert.deepEqual(file.messages.map(String), [])
+  })
+
   await t.test('should ignore invalid repositories', async function () {
     const result = await exec(
       [
@@ -1128,7 +1157,7 @@ test('remark-validate-links', async function (t) {
  * @returns {string}
  *   Clean error.
  */
-export function cleanError(value, max) {
+function cleanError(value, max) {
   return (
     value
       // Clean syscal errors