f354f46b3f
This PR deprecates declaring a middleware under `pages` in favour of the project root naming it after `middleware` instead of `_middleware`. This is in the context of having a simpler execution model for middleware and also ships some refactor work. There is a ton of a code to be simplified after this deprecation but I think it is best to do it progressively. With this PR, when in development, we will **fail** whenever we find a nested middleware but we do **not** include it in the compiler so if the project is using it, it will no longer work. For production we will **fail** too so it will not be possible to build and deploy a deprecated middleware. The error points to a page that should also be reviewed as part of **documentation**. Aside from the deprecation, this migrates all middleware tests to work with a single middleware. It also splits tests into multiple folders to make them easier to isolate and work with. Finally it ships some small code refactor and simplifications.
32 lines
1.1 KiB
TypeScript
32 lines
1.1 KiB
TypeScript
import { ensureLeadingSlash } from './ensure-leading-slash'
|
|
import { normalizePathSep } from './normalize-path-sep'
|
|
import { relative } from '../isomorphic/path'
|
|
import { removePagePathTail } from './remove-page-path-tail'
|
|
|
|
/**
|
|
* Given the absolute path to the pages folder, an absolute file path for a
|
|
* page and the page extensions, this function will return the page path
|
|
* relative to the pages folder. It doesn't consider index tail. Example:
|
|
* - `/Users/rick/my-project/pages/foo/bar/baz.js` -> `/foo/bar/baz`
|
|
*
|
|
* @param filepath Absolute path to the page.
|
|
* @param opts.pagesDir Absolute path to the pages folder.
|
|
* @param opts.extensions Extensions allowed for the page.
|
|
* @param opts.keepIndex When true the trailing `index` kept in the path.
|
|
*/
|
|
export function absolutePathToPage(
|
|
pagePath: string,
|
|
options: {
|
|
extensions: string[]
|
|
keepIndex?: boolean
|
|
pagesDir: string
|
|
}
|
|
) {
|
|
return removePagePathTail(
|
|
normalizePathSep(ensureLeadingSlash(relative(options.pagesDir, pagePath))),
|
|
{
|
|
extensions: options.extensions,
|
|
keepIndex: options.keepIndex,
|
|
}
|
|
)
|
|
}
|