Skip to content

feat: env suffix for plugins/middlewares/tasks #2922

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

Draft
wants to merge 4 commits into
base: v2
Choose a base branch
from
Draft

feat: env suffix for plugins/middlewares/tasks #2922

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
762c4ad
feat: return `method` and `env` from `scanDir`
sandros94 Dec 5, 2024
d666dff
Revert "feat: return `method` and `env` from `scanDir`"
sandros94 Dec 5, 2024
087ef5c
feat: utility to extract method/env
sandros94 Dec 5, 2024
6673d1b
chore: apply automated updates
autofix-ci[bot] Dec 5, 2024
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
47 changes: 33 additions & 14 deletions src/core/scan.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ import { withBase, withLeadingSlash, withoutTrailingSlash } from "ufo";
export const GLOB_SCAN_PATTERN = "**/*.{js,mjs,cjs,ts,mts,cts,tsx,jsx}";
type FileInfo = { path: string; fullPath: string };

const suffixRegex =
/(\.(?<method>connect|delete|get|head|options|patch|post|put|trace))?(\.(?<env>dev|prod|prerender))?$/;
const methodSuffixRegex =
/(\.(?<method>connect|delete|get|head|options|patch|post|put|trace))?/;
const envSuffixRegex = /(\.(?<env>dev|prod|prerender))?$/;

// prettier-ignore
type MatchedMethodSuffix = "connect" | "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
Expand Down Expand Up @@ -79,9 +80,11 @@ export async function scanHandlers(nitro: Nitro) {
export async function scanMiddleware(nitro: Nitro) {
const files = await scanFiles(nitro, "middleware");
return files.map((file) => {
const { env } = extractSuffix(file.path);
return {
middleware: true,
handler: file.fullPath,
env,
};
});
}
Expand All @@ -101,16 +104,8 @@ export async function scanServerRoutes(
.replace(/\[([^/\]]+)]/g, ":$1");
route = withLeadingSlash(withoutTrailingSlash(withBase(route, prefix)));

const suffixMatch = route.match(suffixRegex);
let method: MatchedMethodSuffix | undefined;
let env: MatchedEnvSuffix | undefined;
if (suffixMatch?.index && suffixMatch?.index >= 0) {
route = route.slice(0, suffixMatch.index);
method = suffixMatch.groups?.method as MatchedMethodSuffix | undefined;
env = suffixMatch.groups?.env as MatchedEnvSuffix | undefined;
}

route = route.replace(/\/index$/, "") || "/";
const { path, method, env } = extractSuffix(route, true);
route = path.replace(/\/index$/, "") || "/";

return {
handler: file.fullPath,
Expand All @@ -131,11 +126,12 @@ export async function scanPlugins(nitro: Nitro) {
export async function scanTasks(nitro: Nitro) {
const files = await scanFiles(nitro, "tasks");
return files.map((f) => {
const name = f.path
const { path, env } = extractSuffix(f.path);
const name = path
.replace(/\/index$/, "")
.replace(/\.[A-Za-z]+$/, "")
.replace(/\//g, ":");
return { name, handler: f.fullPath };
return { name, handler: f.fullPath, env };
});
}

Expand Down Expand Up @@ -171,3 +167,26 @@ async function scanDir(
})
.sort((a, b) => a.path.localeCompare(b.path));
}

function extractSuffix(path: string): { path: string; env?: MatchedEnvSuffix };
function extractSuffix(
path: string,
includeMethod: true
): { path: string; method?: MatchedMethodSuffix; env?: MatchedEnvSuffix };
function extractSuffix(path: string, includeMethod: boolean = false) {
const regex = includeMethod
? new RegExp(methodSuffixRegex.source + envSuffixRegex.source)
: envSuffixRegex;

const suffixMatch = path.match(regex);
let method: MatchedMethodSuffix | undefined;
let env: MatchedEnvSuffix | undefined;

if (suffixMatch?.index && suffixMatch?.index >= 0) {
path = path.slice(0, suffixMatch.index);
method = suffixMatch.groups?.method as MatchedMethodSuffix | undefined;
env = suffixMatch.groups?.env as MatchedEnvSuffix | undefined;
}

return { path, method, env };
}
Loading