File size: 4,392 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 |
import { defineRule } from '../utils/define-rule'
import * as path from 'path'
import * as fs from 'fs'
import { getRootDirs } from '../utils/get-root-dirs'
import {
getUrlFromPagesDirectories,
normalizeURL,
execOnce,
getUrlFromAppDirectory,
} from '../utils/url'
const pagesDirWarning = execOnce((pagesDirs) => {
console.warn(
`Pages directory cannot be found at ${pagesDirs.join(' or ')}. ` +
'If using a custom path, please configure with the `no-html-link-for-pages` rule in your eslint config file.'
)
})
// Cache for fs.existsSync lookup.
// Prevent multiple blocking IO requests that have already been calculated.
const fsExistsSyncCache = {}
const memoize = <T = any>(fn: (...args: any[]) => T) => {
const cache = {}
return (...args: any[]): T => {
const key = JSON.stringify(args)
if (cache[key] === undefined) {
cache[key] = fn(...args)
}
return cache[key]
}
}
const cachedGetUrlFromPagesDirectories = memoize(getUrlFromPagesDirectories)
const cachedGetUrlFromAppDirectory = memoize(getUrlFromAppDirectory)
const url = 'https://nextjs.org/docs/messages/no-html-link-for-pages'
export = defineRule({
meta: {
docs: {
description:
'Prevent usage of `<a>` elements to navigate to internal Next.js pages.',
category: 'HTML',
recommended: true,
url,
},
type: 'problem',
schema: [
{
oneOf: [
{
type: 'string',
},
{
type: 'array',
uniqueItems: true,
items: {
type: 'string',
},
},
],
},
],
},
/**
* Creates an ESLint rule listener.
*/
create(context) {
const ruleOptions: (string | string[])[] = context.options
const [customPagesDirectory] = ruleOptions
const rootDirs = getRootDirs(context)
const pagesDirs = (
customPagesDirectory
? [customPagesDirectory]
: rootDirs.map((dir) => [
path.join(dir, 'pages'),
path.join(dir, 'src', 'pages'),
])
).flat()
const foundPagesDirs = pagesDirs.filter((dir) => {
if (fsExistsSyncCache[dir] === undefined) {
fsExistsSyncCache[dir] = fs.existsSync(dir)
}
return fsExistsSyncCache[dir]
})
const appDirs = rootDirs
.map((dir) => [path.join(dir, 'app'), path.join(dir, 'src', 'app')])
.flat()
const foundAppDirs = appDirs.filter((dir) => {
if (fsExistsSyncCache[dir] === undefined) {
fsExistsSyncCache[dir] = fs.existsSync(dir)
}
return fsExistsSyncCache[dir]
})
// warn if there are no pages and app directories
if (foundPagesDirs.length === 0 && foundAppDirs.length === 0) {
pagesDirWarning(pagesDirs)
return {}
}
const pageUrls = cachedGetUrlFromPagesDirectories('/', foundPagesDirs)
const appDirUrls = cachedGetUrlFromAppDirectory('/', foundAppDirs)
const allUrlRegex = [...pageUrls, ...appDirUrls]
return {
JSXOpeningElement(node) {
if (node.name.name !== 'a') {
return
}
if (node.attributes.length === 0) {
return
}
const target = node.attributes.find(
(attr) => attr.type === 'JSXAttribute' && attr.name.name === 'target'
)
if (target && target.value.value === '_blank') {
return
}
const href = node.attributes.find(
(attr) => attr.type === 'JSXAttribute' && attr.name.name === 'href'
)
if (!href || (href.value && href.value.type !== 'Literal')) {
return
}
const hasDownloadAttr = node.attributes.find(
(attr) =>
attr.type === 'JSXAttribute' && attr.name.name === 'download'
)
if (hasDownloadAttr) {
return
}
const hrefPath = normalizeURL(href.value.value)
// Outgoing links are ignored
if (/^(https?:\/\/|\/\/)/.test(hrefPath)) {
return
}
allUrlRegex.forEach((foundUrl) => {
if (foundUrl.test(normalizeURL(hrefPath))) {
context.report({
node,
message: `Do not use an \`<a>\` element to navigate to \`${hrefPath}\`. Use \`<Link />\` from \`next/link\` instead. See: ${url}`,
})
}
})
},
}
},
})
|