fix: cleaner code + better error messages

This commit is contained in:
2024-01-09 23:20:17 +01:00
parent fcd0340e57
commit 1ddcdc7b18
10 changed files with 94 additions and 56 deletions

View File

@ -1,4 +1,4 @@
const test = require("node:test")
const { test } = require("node:test")
const assert = require("node:assert/strict")
const { markdownlint } = require("markdownlint").promises
@ -14,33 +14,33 @@ test("ensure the rule validate correctly", async () => {
},
customRules: [relativeLinks],
})
assert.equal(lintResults["test/fixtures/Valid.md"].length, 0)
assert.equal(lintResults["test/fixtures/Invalid.md"].length, 3)
assert.equal(lintResults["test/fixtures/Valid.md"]?.length, 0)
assert.equal(lintResults["test/fixtures/Invalid.md"]?.length, 3)
assert.equal(
lintResults["test/fixtures/Invalid.md"][0]?.ruleDescription,
lintResults["test/fixtures/Invalid.md"]?.[0]?.ruleDescription,
"Relative links should be valid",
)
assert.equal(
lintResults["test/fixtures/Invalid.md"][0]?.errorDetail,
'Link "./basic.test.js" should exist in the file system',
lintResults["test/fixtures/Invalid.md"]?.[0]?.errorDetail,
'"./basic.test.js" should exist in the file system',
)
assert.equal(
lintResults["test/fixtures/Invalid.md"][1]?.ruleDescription,
lintResults["test/fixtures/Invalid.md"]?.[1]?.ruleDescription,
"Relative links should be valid",
)
assert.equal(
lintResults["test/fixtures/Invalid.md"][1]?.errorDetail,
'Link "../image.png" should exist in the file system',
lintResults["test/fixtures/Invalid.md"]?.[1]?.errorDetail,
'"../image.png" should exist in the file system',
)
assert.equal(
lintResults["test/fixtures/Invalid.md"][2]?.ruleDescription,
lintResults["test/fixtures/Invalid.md"]?.[2]?.ruleDescription,
"Relative links should be valid",
)
assert.equal(
lintResults["test/fixtures/Invalid.md"][2]?.errorDetail,
'Link "./Valid.md#not-existing-heading" should have a valid fragment',
lintResults["test/fixtures/Invalid.md"]?.[2]?.errorDetail,
'"./Valid.md#not-existing-heading" should have a valid fragment identifier',
)
})

View File

@ -1,4 +1,4 @@
const test = require("node:test")
const { test } = require("node:test")
const assert = require("node:assert/strict")
const {