feat: validate link in image src

This commit is contained in:
Divlo 2023-01-02 19:45:46 +01:00
parent 4adef29333
commit 5dab1976d3
No known key found for this signature in database
GPG Key ID: 8F9478F220CE65E9
5 changed files with 43 additions and 14 deletions

View File

@ -56,23 +56,38 @@ const customRule = {
filterTokens(params, 'inline', (token) => { filterTokens(params, 'inline', (token) => {
token.children.forEach((child) => { token.children.forEach((child) => {
const { lineNumber, type, attrs } = child const { lineNumber, type, attrs } = child
/** @type {string | null} */
let hrefSrc = null
if (type === 'link_open') { if (type === 'link_open') {
attrs.forEach((attr) => { attrs.forEach((attr) => {
if (attr[0] === 'href') { if (attr[0] === 'href') {
const href = attr[1] hrefSrc = attr[1]
const url = new URL(href, pathToFileURL(params.name))
url.hash = ''
const isRelative =
href.startsWith('./') ||
href.startsWith('../') ||
!EXTERNAL_PROTOCOLS.has(url.protocol)
if (isRelative && !fs.existsSync(url.pathname)) {
const detail = `Link "${href}" is dead`
addError(onError, lineNumber, detail)
}
} }
}) })
} }
if (type === 'image') {
attrs.forEach((attr) => {
if (attr[0] === 'src') {
hrefSrc = attr[1]
}
})
}
if (hrefSrc != null) {
const url = new URL(hrefSrc, pathToFileURL(params.name))
url.hash = ''
const isRelative =
hrefSrc.startsWith('./') ||
hrefSrc.startsWith('../') ||
!EXTERNAL_PROTOCOLS.has(url.protocol)
if (isRelative && !fs.existsSync(url.pathname)) {
const detail = `Link "${hrefSrc}" is dead`
addError(onError, lineNumber, detail)
}
}
}) })
}) })
} }

View File

@ -12,13 +12,23 @@ tap.test('ensure we validate correctly', async (t) => {
customRules: [relativeLinks] customRules: [relativeLinks]
}) })
t.equal(lintResults['test/fixtures/Valid.md'].length, 0) 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'].length, 2)
t.equal( t.equal(
lintResults['test/fixtures/Invalid.md'][0].ruleDescription, lintResults['test/fixtures/Invalid.md'][0]?.ruleDescription,
'Relative links should be valid' 'Relative links should be valid'
) )
t.equal( t.equal(
lintResults['test/fixtures/Invalid.md'][0].errorDetail, lintResults['test/fixtures/Invalid.md'][0]?.errorDetail,
'Link "./basic.test.js" is dead' 'Link "./basic.test.js" is dead'
) )
t.equal(
lintResults['test/fixtures/Invalid.md'][1]?.ruleDescription,
'Relative links should be valid'
)
t.equal(
lintResults['test/fixtures/Invalid.md'][1]?.errorDetail,
'Link "../image.png" is dead'
)
}) })

View File

@ -1,3 +1,5 @@
# Invalid # Invalid
[basic.js](./basic.test.js) [basic.js](./basic.test.js)
![Image](../image.png)

View File

@ -1,3 +1,5 @@
# Valid # Valid
[basic.js](../basic.test.js) [basic.js](../basic.test.js)
![Image](./image.png)

BIN
test/fixtures/image.png vendored Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 95 B