Skip to content

Refactor ViteConfigWithSSR type #4952

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
Oct 3, 2022
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
5 changes: 5 additions & 0 deletions .changeset/moody-gifts-press.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'astro': patch
---

Refactor ViteConfigWithSSR type
5 changes: 2 additions & 3 deletions packages/astro/src/@types/astro.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ import type { SerializedSSRManifest } from '../core/app/types';
import type { PageBuildData } from '../core/build/types';
import type { AstroConfigSchema } from '../core/config';
import type { AstroCookies } from '../core/cookies';
import type { ViteConfigWithSSR } from '../core/create-vite';
import type { AstroComponentFactory, Metadata } from '../runtime/server';
export type {
MarkdownHeading,
Expand Down Expand Up @@ -1161,10 +1160,10 @@ export interface AstroIntegration {
'astro:build:ssr'?: (options: { manifest: SerializedSSRManifest }) => void | Promise<void>;
'astro:build:start'?: (options: { buildConfig: BuildConfig }) => void | Promise<void>;
'astro:build:setup'?: (options: {
vite: ViteConfigWithSSR;
vite: vite.InlineConfig;
pages: Map<string, PageBuildData>;
target: 'client' | 'server';
updateConfig: (newConfig: ViteConfigWithSSR) => void;
updateConfig: (newConfig: vite.InlineConfig) => void;
}) => void | Promise<void>;
'astro:build:generated'?: (options: { dir: URL }) => void | Promise<void>;
'astro:build:done'?: (options: {
Expand Down
5 changes: 3 additions & 2 deletions packages/astro/src/core/build/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,14 @@ import type { LogOptions } from '../logger/core';
import fs from 'fs';
import * as colors from 'kleur/colors';
import { performance } from 'perf_hooks';
import * as vite from 'vite';
import {
runHookBuildDone,
runHookBuildStart,
runHookConfigDone,
runHookConfigSetup,
} from '../../integrations/index.js';
import { createVite, ViteConfigWithSSR } from '../create-vite.js';
import { createVite } from '../create-vite.js';
import { fixViteErrorMessage } from '../errors.js';
import { debug, info, levels, timerMessage } from '../logger/core.js';
import { apply as applyPolyfill } from '../polyfill.js';
Expand Down Expand Up @@ -84,7 +85,7 @@ class AstroBuilder {
}

/** Run the build logic. build() is marked private because usage should go through ".run()" */
private async build({ viteConfig }: { viteConfig: ViteConfigWithSSR }) {
private async build({ viteConfig }: { viteConfig: vite.InlineConfig }) {
const buildConfig: BuildConfig = {
client: new URL('./client/', this.settings.config.outDir),
server: new URL('./server/', this.settings.config.outDir),
Expand Down
7 changes: 3 additions & 4 deletions packages/astro/src/core/build/static-build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import { prependForwardSlash } from '../../core/path.js';
import { emptyDir, isModeServerWithNoAdapter, removeDir } from '../../core/util.js';
import { runHookBuildSetup } from '../../integrations/index.js';
import { PAGE_SCRIPT_ID } from '../../vite-plugin-scripts/index.js';
import type { ViteConfigWithSSR } from '../create-vite';
import { info } from '../logger/core.js';
import { getOutDirWithinCwd } from './common.js';
import { generatePages } from './generate.js';
Expand Down Expand Up @@ -114,7 +113,7 @@ async function ssrBuild(opts: StaticBuildOptions, internals: BuildInternals, inp
const ssr = settings.config.output === 'server';
const out = ssr ? opts.buildConfig.server : getOutDirWithinCwd(settings.config.outDir);

const viteBuildConfig: ViteConfigWithSSR = {
const viteBuildConfig: vite.InlineConfig = {
...viteConfig,
mode: viteConfig.mode || 'production',
logLevel: opts.viteConfig.logLevel ?? 'error',
Expand Down Expand Up @@ -192,7 +191,7 @@ async function clientBuild(

info(opts.logging, null, `\n${bgGreen(black(' building client '))}`);

const viteBuildConfig = {
const viteBuildConfig: vite.InlineConfig = {
...viteConfig,
mode: viteConfig.mode || 'production',
logLevel: 'info',
Expand Down Expand Up @@ -226,7 +225,7 @@ async function clientBuild(
],
envPrefix: 'PUBLIC_',
base: settings.config.base,
} as ViteConfigWithSSR;
} ;

await runHookBuildSetup({
config: settings.config,
Expand Down
4 changes: 2 additions & 2 deletions packages/astro/src/core/build/types.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import type { InlineConfig } from 'vite';
import type {
AstroSettings,
BuildConfig,
Expand All @@ -7,7 +8,6 @@ import type {
RuntimeMode,
SSRLoadedRenderer,
} from '../../@types/astro';
import type { ViteConfigWithSSR } from '../create-vite';
import type { LogOptions } from '../logger/core';
import type { RouteCache } from '../render/route-cache';

Expand All @@ -34,7 +34,7 @@ export interface StaticBuildOptions {
origin: string;
pageNames: string[];
routeCache: RouteCache;
viteConfig: ViteConfigWithSSR;
viteConfig: InlineConfig;
}

export interface SingleFileBuiltModule {
Expand Down
9 changes: 3 additions & 6 deletions packages/astro/src/core/create-vite.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,6 @@ import astroScriptsPageSSRPlugin from '../vite-plugin-scripts/page-ssr.js';
import { createCustomViteLogger } from './errors.js';
import { resolveDependency } from './util.js';

// note: ssr is still an experimental API hence the type omission from `vite`
export type ViteConfigWithSSR = vite.InlineConfig & { ssr?: vite.SSROptions };

interface CreateViteOptions {
settings: AstroSettings;
logging: LogOptions;
Expand Down Expand Up @@ -58,12 +55,12 @@ function getSsrNoExternalDeps(projectRoot: URL): string[] {

/** Return a common starting point for all Vite actions */
export async function createVite(
commandConfig: ViteConfigWithSSR,
commandConfig: vite.InlineConfig,
{ settings, logging, mode }: CreateViteOptions
): Promise<ViteConfigWithSSR> {
): Promise<vite.InlineConfig> {
const thirdPartyAstroPackages = await getAstroPackages(settings);
// Start with the Vite configuration that Astro core needs
const commonConfig: ViteConfigWithSSR = {
const commonConfig: vite.InlineConfig = {
cacheDir: fileURLToPath(new URL('./node_modules/.vite/', settings.config.root)), // using local caches allows Astro to be used in monorepos, etc.
clearScreen: false, // we want to control the output, not Vite
logLevel: 'warn', // log warnings and errors only
Expand Down
5 changes: 2 additions & 3 deletions packages/astro/src/integrations/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { bold } from 'kleur/colors';
import type { AddressInfo } from 'net';
import type { ViteDevServer } from 'vite';
import type { InlineConfig, ViteDevServer } from 'vite';
import {
AstroConfig,
AstroRenderer,
Expand All @@ -12,7 +12,6 @@ import {
import type { SerializedSSRManifest } from '../core/app/types';
import type { PageBuildData } from '../core/build/types';
import { mergeConfig } from '../core/config/config.js';
import type { ViteConfigWithSSR } from '../core/create-vite.js';
import { info, LogOptions } from '../core/logger/core.js';

async function withTakingALongTimeMsg<T>({
Expand Down Expand Up @@ -224,7 +223,7 @@ export async function runHookBuildSetup({
logging,
}: {
config: AstroConfig;
vite: ViteConfigWithSSR;
vite: InlineConfig;
pages: Map<string, PageBuildData>;
target: 'server' | 'client';
logging: LogOptions;
Expand Down