File size: 4,672 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 |
import { fileExists } from '../../lib/file-exists'
import { getPagePaths } from '../../shared/lib/page-path/get-page-paths'
import { nonNullable } from '../../lib/non-nullable'
import { join, sep, normalize } from 'path'
import { promises as fsPromises } from 'fs'
import { warn } from '../../build/output/log'
import { cyan } from '../../lib/picocolors'
import { isMetadataRouteFile } from '../../lib/metadata/is-metadata-route'
import type { PageExtensions } from '../../build/page-extensions-type'
async function isTrueCasePagePath(pagePath: string, pagesDir: string) {
const pageSegments = normalize(pagePath).split(sep).filter(Boolean)
const segmentExistsPromises = pageSegments.map(async (segment, i) => {
const segmentParentDir = join(pagesDir, ...pageSegments.slice(0, i))
const parentDirEntries = await fsPromises.readdir(segmentParentDir)
return parentDirEntries.includes(segment)
})
return (await Promise.all(segmentExistsPromises)).every(Boolean)
}
/**
* Finds a page file with the given parameters. If the page is duplicated with
* multiple extensions it will throw, otherwise it will return the *relative*
* path to the page file or null if it is not found.
*
* @param pagesDir Absolute path to the pages folder with trailing `/pages`.
* @param normalizedPagePath The page normalized (it will be denormalized).
* @param pageExtensions Array of page extensions.
*/
export async function findPageFile(
pagesDir: string,
normalizedPagePath: string,
pageExtensions: PageExtensions,
isAppDir: boolean
): Promise<string | null> {
const pagePaths = getPagePaths(normalizedPagePath, pageExtensions, isAppDir)
const [existingPath, ...others] = (
await Promise.all(
pagePaths.map(async (path) => {
const filePath = join(pagesDir, path)
try {
return (await fileExists(filePath)) ? path : null
} catch (err: any) {
if (!err?.code?.includes('ENOTDIR')) throw err
}
return null
})
)
).filter(nonNullable)
if (!existingPath) {
return null
}
if (!(await isTrueCasePagePath(existingPath, pagesDir))) {
return null
}
if (others.length > 0) {
warn(
`Duplicate page detected. ${cyan(join('pages', existingPath))} and ${cyan(
join('pages', others[0])
)} both resolve to ${cyan(normalizedPagePath)}.`
)
}
return existingPath
}
/**
*
* createValidFileMatcher receives configured page extensions and return helpers to determine:
* `isLayoutsLeafPage`: if a file is a valid page file or routes file under app directory
* `isTrackedFiles`: if it's a tracked file for webpack watcher
*
*/
export function createValidFileMatcher(
pageExtensions: PageExtensions,
appDirPath: string | undefined
) {
const getExtensionRegexString = (extensions: string[]) =>
`(?:${extensions.join('|')})`
const validExtensionFileRegex = new RegExp(
'\\.' + getExtensionRegexString(pageExtensions) + '$'
)
const leafOnlyPageFileRegex = new RegExp(
`(^(page|route)|[\\\\/](page|route))\\.${getExtensionRegexString(
pageExtensions
)}$`
)
const rootNotFoundFileRegex = new RegExp(
`^not-found\\.${getExtensionRegexString(pageExtensions)}$`
)
/** TODO-METADATA: support other metadata routes
* regex for:
*
* /robots.txt|<ext>
* /sitemap.xml|<ext>
* /favicon.ico
* /manifest.json|<ext>
* <route>/icon.png|jpg|<ext>
* <route>/apple-touch-icon.png|jpg|<ext>
*
*/
/**
* Match the file if it's a metadata route file, static: if the file is a static metadata file.
* It needs to be a file which doesn't match the custom metadata routes e.g. `app/robots.txt/route.js`
*/
function isMetadataFile(filePath: string) {
const appDirRelativePath = appDirPath
? filePath.replace(appDirPath, '')
: filePath
return isMetadataRouteFile(appDirRelativePath, pageExtensions, true)
}
// Determine if the file is leaf node page file or route file under layouts,
// 'page.<extension>' | 'route.<extension>'
function isAppRouterPage(filePath: string) {
return leafOnlyPageFileRegex.test(filePath) || isMetadataFile(filePath)
}
function isPageFile(filePath: string) {
return validExtensionFileRegex.test(filePath) || isMetadataFile(filePath)
}
function isRootNotFound(filePath: string) {
if (!appDirPath) {
return false
}
if (!filePath.startsWith(appDirPath + sep)) {
return false
}
const rest = filePath.slice(appDirPath.length + 1)
return rootNotFoundFileRegex.test(rest)
}
return {
isPageFile,
isAppRouterPage,
isMetadataFile,
isRootNotFound,
}
}
|