chore: initial commit

test/basic.test.js

@@ -0,0 +1,24 @@
+const tap = require('tap')
+const { markdownlint } = require('markdownlint').promises
+
+const relativeLinks = require('../src/index.js')
+
+tap.test('ensure we validate correctly', async (t) => {
+  const lintResults = await markdownlint({
+    files: ['test/fixtures/Valid.md', 'test/fixtures/Invalid.md'],
+    config: {
+      'relative-links': true
+    },
+    customRules: [relativeLinks]
+  })
+  t.equal(lintResults['test/fixtures/Valid.md'].length, 0)
+  t.equal(lintResults['test/fixtures/Invalid.md'].length, 1)
+  t.equal(
+    lintResults['test/fixtures/Invalid.md'][0].ruleDescription,
+    'Relative links should be valid'
+  )
+  t.equal(
+    lintResults['test/fixtures/Invalid.md'][0].errorDetail,
+    'Link "./basic.test.js" is dead'
+  )
+})

test/fixtures/Invalid.md

@@ -0,0 +1,3 @@
+# Invalid
+
+[basic.js](./basic.test.js)

test/fixtures/Valid.md

@@ -0,0 +1,3 @@
+# Valid
+
+[basic.js](../basic.test.js)