+
Skip to content

feat(vite-plugin-nitro): make source root configurable/optional #1681

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.

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

Merged
merged 1 commit into from
Apr 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 24 additions & 0 deletions packages/vite-plugin-nitro/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ A lightweight [Vite](https://vite.dev) plugin for integrating with [Nitro](https
- Build-time Pre-rendering
- Static Site Generation
- API routes
- Sitemaps

## Install

Expand Down Expand Up @@ -87,6 +88,29 @@ export default defineEventHandler(() => ({ message: 'Hello World' }));

The API route can be accessed as `/api/v1/hello`.

## Custom Source Root Directory

By default, the `src` folder is used as the path for the discovery of server files and API routes. You can customize the folder with the `sourceRoot` option.

```ts
// vite.config.ts
import { defineConfig } from 'vite';
import nitro from '@analogjs/vite-plugin-nitro';

// https://vitejs.dev/config/
export default defineConfig({
plugins: [
nitro({
ssr: true,
entryServer: 'app/main.server.tsx',
sourceRoot: 'app',
}),
],
});
```

With this configuration, API routes are discovered under the `app/server/routes/api` directory. You can also make the it optional by setting the `sourceRoot` to `'.'`;

## Examples

React: https://github.com/brandonroberts/vite-nitro-react \
Expand Down
3 changes: 2 additions & 1 deletion packages/vite-plugin-nitro/src/lib/build-ssr.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@ import { Options } from './options.js';

export async function buildSSRApp(config: UserConfig, options?: Options) {
const workspaceRoot = options?.workspaceRoot ?? process.cwd();
const sourceRoot = options?.sourceRoot ?? 'src';
const rootDir = relative(workspaceRoot, config.root || '.') || '.';
const ssrBuildConfig = mergeConfig(config, {
build: {
ssr: true,
rollupOptions: {
input:
options?.entryServer ||
resolve(workspaceRoot, rootDir, 'src/main.server.ts'),
resolve(workspaceRoot, rootDir, `${sourceRoot}/main.server.ts`),
},
outDir:
options?.ssrBuildDir || resolve(workspaceRoot, 'dist', rootDir, 'ssr'),
Expand Down
7 changes: 7 additions & 0 deletions packages/vite-plugin-nitro/src/lib/options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ export interface Options {
prerender?: PrerenderOptions;
entryServer?: string;
index?: string;
/**
* Relative path to source files. Default is 'src'.
*/
sourceRoot?: string;
/**
* Absolute path to workspace root. Default is 'process.cwd()'
*/
workspaceRoot?: string;
/**
* Additional page paths to include
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ type ServerOptions = Options & { routeRules?: Record<string, any> | undefined };

export function devServerPlugin(options: ServerOptions): Plugin {
const workspaceRoot = options?.workspaceRoot || process.cwd();
const entryServer = options.entryServer || 'src/main.server.ts';
const sourceRoot = options?.sourceRoot ?? 'src';
const entryServer = options.entryServer || `${sourceRoot}/main.server.ts`;
const index = options.index || 'index.html';
let config: UserConfig;
let root: string;
Expand All @@ -49,7 +50,7 @@ export function devServerPlugin(options: ServerOptions): Plugin {

return async () => {
remove_html_middlewares(viteServer.middlewares);
registerDevServerMiddleware(root, viteServer);
registerDevServerMiddleware(root, sourceRoot, viteServer);

viteServer.middlewares.use(async (req, res) => {
let template = readFileSync(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@ import { normalizePath } from 'vite';

type GetHandlersArgs = {
workspaceRoot: string;
sourceRoot: string;
rootDir: string;
additionalPagesDirs?: string[];
hasAPIDir?: boolean;
};

export function getPageHandlers({
workspaceRoot,
sourceRoot,
rootDir,
additionalPagesDirs,
hasAPIDir,
Expand All @@ -21,7 +23,7 @@ export function getPageHandlers({

const endpointFiles: string[] = fg.sync(
[
`${root}/src/app/pages/**/*.server.ts`,
`${root}/${sourceRoot}/app/pages/**/*.server.ts`,
...(additionalPagesDirs || []).map(
(dir) => `${workspaceRoot}${dir}/**/*.server.ts`,
),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@ import fg from 'fast-glob';

export async function registerDevServerMiddleware(
root: string,
sourceRoot: string,
viteServer: ViteDevServer,
) {
const middlewareFiles = fg.sync([`${root}/src/server/middleware/**/*.ts`]);
const middlewareFiles = fg.sync([
`${root}/${sourceRoot}/server/middleware/**/*.ts`,
]);

middlewareFiles.forEach((file) => {
viteServer.middlewares.use(async (req, res, next) => {
Expand Down
25 changes: 17 additions & 8 deletions packages/vite-plugin-nitro/src/lib/vite-plugin-nitro.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ const __dirname = dirname(__filename);

export function nitro(options?: Options, nitroOptions?: NitroConfig): Plugin[] {
const workspaceRoot = options?.workspaceRoot ?? process.cwd();
const sourceRoot = options?.sourceRoot ?? 'src';
let isTest = process.env['NODE_ENV'] === 'test' || !!process.env['VITEST'];
const baseURL = process.env['NITRO_APP_BASE_URL'] || '';
const prefix = baseURL ? baseURL.substring(0, baseURL.length - 1) : '';
Expand Down Expand Up @@ -72,14 +73,15 @@ export function nitro(options?: Options, nitroOptions?: NitroConfig): Plugin[] {

const rootDir = relative(workspaceRoot, config.root || '.') || '.';
hasAPIDir = existsSync(
resolve(workspaceRoot, rootDir, 'src/server/routes/api'),
resolve(workspaceRoot, rootDir, `${sourceRoot}/server/routes/api`),
);
const buildPreset =
process.env['BUILD_PRESET'] ??
(nitroOptions?.preset as string | undefined);

const pageHandlers = getPageHandlers({
workspaceRoot,
sourceRoot,
rootDir,
additionalPagesDirs: options?.additionalPagesDirs,
hasAPIDir,
Expand Down Expand Up @@ -107,9 +109,9 @@ export function nitro(options?: Options, nitroOptions?: NitroConfig): Plugin[] {
preset: buildPreset,
compatibilityDate: '2024-11-19',
logLevel: nitroOptions?.logLevel || 0,
srcDir: normalizePath(`src/server`),
srcDir: normalizePath(`${sourceRoot}/server`),
scanDirs: [
normalizePath(`${rootDir}/src/server`),
normalizePath(`${rootDir}/${sourceRoot}/server`),
...(options?.additionalAPIDirs || []).map((dir) =>
normalizePath(`${workspaceRoot}${dir}`),
),
Expand Down Expand Up @@ -390,7 +392,11 @@ export function nitro(options?: Options, nitroOptions?: NitroConfig): Plugin[] {
rollupOptions: {
input:
options?.entryServer ||
resolve(workspaceRoot, rootDir, 'src/main.server.ts'),
resolve(
workspaceRoot,
rootDir,
`${sourceRoot}/main.server.ts`,
),
},
outDir:
options?.ssrBuildDir ||
Expand All @@ -402,10 +408,13 @@ export function nitro(options?: Options, nitroOptions?: NitroConfig): Plugin[] {
sharedPlugins: true,
buildApp: async (builder) => {
environmentBuild = true;
await Promise.all([
builder.build(builder.environments['client']),
builder.build(builder.environments['ssr']),
]);
const builds = [builder.build(builder.environments['client'])];

if (options?.ssr || nitroConfig.prerender?.routes?.length) {
builds.push(builder.build(builder.environments['ssr']));
}

await Promise.all(builds);
await buildServer(options, nitroConfig);

if (
Expand Down
点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载