Add url to vfile messages

Reviewed-by: JounQin <[email protected]> Reviewed-by: Titus Wormer <[email protected]> Reviewed-by: Christian Murphy <[email protected]> Closes GH-71.
remarkjs · Aug 25, 2022 · 53b0c24 · 53b0c24
1 parent 5a2641a
commit 53b0c24
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/lib/check/validate.js b/lib/check/validate.js
@@ -127,6 +127,11 @@ function warn(ctx, reference) {
   let index = -1
 
   while (++index < reference.nodes.length) {
-    reference.file.message(reason, reference.nodes[index], origin)
+    const message = reference.file.message(
+      reason,
+      reference.nodes[index],
+      origin
+    )
+    message.url = 'https://github.com/remarkjs/remark-validate-links#readme'
   }
 }
diff --git a/test/index.js b/test/index.js
@@ -41,6 +41,17 @@ test('remark-validate-links', async (t) => {
     ],
     'should work on the API'
   )
+  t.deepEqual(
+    vfile.messages.map((message) => message.url),
+    [
+      'https://github.com/remarkjs/remark-validate-links#readme',
+      'https://github.com/remarkjs/remark-validate-links#readme',
+      'https://github.com/remarkjs/remark-validate-links#readme',
+      'https://github.com/remarkjs/remark-validate-links#readme',
+      'https://github.com/remarkjs/remark-validate-links#readme'
+    ],
+    'should add message urls'
+  )
 
   const file = await remark()
     .use(links)