Skip to content

fix(eslint): support pageExtensions in no-html-link-for-pages rule #92417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Ankitajainkuniya wants to merge 1 commit into
base: canary
Choose a base branch
from
+38 −21
Open

fix(eslint): support pageExtensions in no-html-link-for-pages rule #92417

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions packages/eslint-plugin-next/src/rules/no-html-link-for-pages.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,11 @@ export default defineRule({
return {}
}

const pageUrls = cachedGetUrlFromPagesDirectories('/', foundPagesDirs)
const appDirUrls = cachedGetUrlFromAppDirectory('/', foundAppDirs)
const settings = context.settings || {}
const pageExtensions = settings.next?.pageExtensions || undefined

const pageUrls = cachedGetUrlFromPagesDirectories('/', foundPagesDirs, pageExtensions)
const appDirUrls = cachedGetUrlFromAppDirectory('/', foundAppDirs, pageExtensions)
const allUrlRegex = [...pageUrls, ...appDirUrls]

return {
Expand Down
52 changes: 33 additions & 19 deletions packages/eslint-plugin-next/src/utils/url.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,34 @@ import * as fs from 'fs'
// Prevent multiple blocking IO requests that have already been calculated.
const fsReadDirSyncCache = {}

const DEFAULT_PAGE_EXTENSIONS = ['tsx', 'ts', 'jsx', 'js']

/**
* Build a regex to match page file extensions, supporting custom pageExtensions.
*/
function buildExtensionRegex(pageExtensions: string[] = DEFAULT_PAGE_EXTENSIONS): RegExp {
const escaped = pageExtensions.map((ext) => ext.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'))
return new RegExp(`\\.(${escaped.join('|')})$`)
}

/**
* Recursively parse directory for page URLs.
*/
function parseUrlForPages(urlprefix: string, directory: string) {
function parseUrlForPages(urlprefix: string, directory: string, pageExtensions?: string[]) {
fsReadDirSyncCache[directory] ??= fs.readdirSync(directory, {
withFileTypes: true,
})
const extRegex = buildExtensionRegex(pageExtensions)
const res = []
fsReadDirSyncCache[directory].forEach((dirent) => {
// TODO: this should account for all page extensions
// not just js(x) and ts(x)
if (/(\.(j|t)sx?)$/.test(dirent.name)) {
if (/^index(\.(j|t)sx?)$/.test(dirent.name)) {
if (extRegex.test(dirent.name)) {
const indexRegex = new RegExp(`^index(\\.(${(pageExtensions || DEFAULT_PAGE_EXTENSIONS).join('|')}))$`)
if (indexRegex.test(dirent.name)) {
res.push(
`${urlprefix}${dirent.name.replace(/^index(\.(j|t)sx?)$/, '')}`
`${urlprefix}${dirent.name.replace(indexRegex, '')}`
)
}
res.push(`${urlprefix}${dirent.name.replace(/(\.(j|t)sx?)$/, '')}`)
res.push(`${urlprefix}${dirent.name.replace(extRegex, '')}`)
} else {
const dirPath = path.join(directory, dirent.name)
if (dirent.isDirectory() && !dirent.isSymbolicLink()) {
Expand All @@ -36,19 +46,21 @@ function parseUrlForPages(urlprefix: string, directory: string) {
/**
* Recursively parse app directory for URLs.
*/
function parseUrlForAppDir(urlprefix: string, directory: string) {
Copy link
Copy Markdown
Contributor

@vercel vercel bot Apr 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Recursive calls in parseUrlForPages and parseUrlForAppDir do not pass the pageExtensions parameter, causing subdirectories to fall back to default extensions and miss pages with custom extensions like .mdx.

Fix on Vercel

function parseUrlForAppDir(urlprefix: string, directory: string, pageExtensions?: string[]) {
fsReadDirSyncCache[directory] ??= fs.readdirSync(directory, {
withFileTypes: true,
})
const extRegex = buildExtensionRegex(pageExtensions)
const exts = (pageExtensions || DEFAULT_PAGE_EXTENSIONS).join('|')
const res = []
fsReadDirSyncCache[directory].forEach((dirent) => {
// TODO: this should account for all page extensions
// not just js(x) and ts(x)
if (/(\.(j|t)sx?)$/.test(dirent.name)) {
if (/^page(\.(j|t)sx?)$/.test(dirent.name)) {
res.push(`${urlprefix}${dirent.name.replace(/^page(\.(j|t)sx?)$/, '')}`)
} else if (!/^layout(\.(j|t)sx?)$/.test(dirent.name)) {
res.push(`${urlprefix}${dirent.name.replace(/(\.(j|t)sx?)$/, '')}`)
if (extRegex.test(dirent.name)) {
const pageRegex = new RegExp(`^page(\\.(${exts}))$`)
const layoutRegex = new RegExp(`^layout(\\.(${exts}))$`)
if (pageRegex.test(dirent.name)) {
res.push(`${urlprefix}${dirent.name.replace(pageRegex, '')}`)
} else if (!layoutRegex.test(dirent.name)) {
res.push(`${urlprefix}${dirent.name.replace(extRegex, '')}`)
}
} else {
const dirPath = path.join(directory, dirent.name)
Expand Down Expand Up @@ -136,13 +148,14 @@ export function normalizeAppPath(route: string) {
*/
export function getUrlFromPagesDirectories(
urlPrefix: string,
directories: string[]
directories: string[],
pageExtensions?: string[]
) {
return Array.from(
// De-duplicate similar pages across multiple directories.
new Set(
directories
.flatMap((directory) => parseUrlForPages(urlPrefix, directory))
.flatMap((directory) => parseUrlForPages(urlPrefix, directory, pageExtensions))
.map(
// Since the URLs are normalized we add `^` and `$` to the RegExp to make sure they match exactly.
(url) => `^${normalizeURL(url)}$`
Expand All @@ -156,13 +169,14 @@ export function getUrlFromPagesDirectories(

export function getUrlFromAppDirectory(
urlPrefix: string,
directories: string[]
directories: string[],
pageExtensions?: string[]
) {
return Array.from(
// De-duplicate similar pages across multiple directories.
new Set(
directories
.map((directory) => parseUrlForAppDir(urlPrefix, directory))
.map((directory) => parseUrlForAppDir(urlPrefix, directory, pageExtensions))
.flat()
.map(
// Since the URLs are normalized we add `^` and `$` to the RegExp to make sure they match exactly.
Expand Down
Loading