BREAKING(core): merge FreshConfig and ResolvedFreshConfig

Author: iuioiua

docs/latest/concepts/plugins.md

@@ -133,9 +133,8 @@ This hook is run at the start of the Fresh
 [ahead-of-time build task](/docs/concepts/ahead-of-time-builds). It may be
 synchronous or asynchronous.
 
-The build start hook is called with the
-[`ResolvedFreshConfig`](https://deno.land/x/fresh/src/server/types.ts?s=ResolvedFreshConfig)
-object, which contains the full Fresh configuration.
+The build start hook is called with the `FreshConfig` object, which contains the
+full Fresh configuration.
 
 This hook may be used to generate precompiled static assets. Any files saved to
 the `static` subfolder of `config.build.outDir` (typically `_fresh`) will be

plugin-tailwindcss/src/compiler.ts

@@ -3,7 +3,7 @@ import postcss from "postcss";
 import autoprefixer from "autoprefixer";
 import * as path from "@std/path";
 import type { TailwindPluginOptions } from "./types.ts";
-import type { ResolvedFreshConfig } from "fresh";
+import type { FreshConfig } from "fresh";
 
 const CONFIG_EXTENSIONS = ["ts", "js", "mjs"];
 
@@ -37,7 +37,7 @@ async function findTailwindConfigFile(directory: string): Promise<string> {
 }
 
 export async function initTailwind(
-  config: ResolvedFreshConfig,
+  config: FreshConfig,
   options: TailwindPluginOptions,
 ): Promise<postcss.Processor> {
   const root = path.dirname(config.staticDir);

src/app.ts

@@ -13,11 +13,7 @@ import {
   type Router,
   UrlPatternRouter,
 } from "./router.ts";
-import {
-  type FreshConfig,
-  normalizeConfig,
-  type ResolvedFreshConfig,
-} from "./config.ts";
+import { type FreshConfig, normalizeConfig } from "./config.ts";
 import { type BuildCache, ProdBuildCache } from "./build_cache.ts";
 import type { ServerIslandRegistry } from "./context.ts";
 import { FinishSetup, ForgotBuild } from "./finish_setup.tsx";
@@ -73,9 +69,9 @@ export class App<State> {
   /**
    * The final resolved Fresh configuration.
    */
-  config: ResolvedFreshConfig;
+  config: FreshConfig;
 
-  constructor(config: FreshConfig = {}) {
+  constructor(config: Partial<FreshConfig> = {}) {
     this.config = normalizeConfig(config);
   }
 

src/build_cache.ts

@@ -1,5 +1,5 @@
 import * as path from "@std/path";
-import { getSnapshotPath, type ResolvedFreshConfig } from "./config.ts";
+import { type FreshConfig, getSnapshotPath } from "./config.ts";
 import { DENO_DEPLOYMENT_ID, setBuildId } from "./runtime/build_id.ts";
 import * as colors from "@std/fmt/colors";
 
@@ -29,7 +29,7 @@ export interface BuildCache {
 }
 
 export class ProdBuildCache implements BuildCache {
-  static async fromSnapshot(config: ResolvedFreshConfig, islandCount: number) {
+  static async fromSnapshot(config: FreshConfig, islandCount: number) {
     const snapshotPath = getSnapshotPath(config);
 
     const staticFiles = new Map<string, FileSnapshot>();
@@ -86,10 +86,10 @@ export class ProdBuildCache implements BuildCache {
 
   #islands: Map<string, string>;
   #fileInfo: Map<string, FileSnapshot>;
-  #config: ResolvedFreshConfig;
+  #config: FreshConfig;
 
   constructor(
-    config: ResolvedFreshConfig,
+    config: FreshConfig,
     islands: Map<string, string>,
     files: Map<string, FileSnapshot>,
     public hasSnapshot: boolean,

src/config.ts

@@ -2,25 +2,19 @@ import * as path from "@std/path";
 import type { Mode } from "./runtime/server/mod.ts";
 
 export interface FreshConfig {
-  root?: string;
+  root: string;
   /**
    * The directory to write generated files to when `dev.ts build` is run.
    * This can be an absolute path, a file URL or a relative path.
    */
-  buildOutDir?: string;
+  buildOutDir: string;
   /**
    * Serve fresh from a base path instead of from the root.
    *   "/foo/bar" -> http://localhost:8000/foo/bar
    * @default {undefined}
    */
-  basePath?: string;
-  staticDir?: string;
-}
-
-/**
- * The final resolved Fresh configuration where fields the user didn't specify are set to the default values.
- */
-export interface ResolvedFreshConfig extends Required<FreshConfig> {
+  basePath: string;
+  staticDir: string;
   /**
    * Tells you in which mode Fresh is currently running in.
    */
@@ -45,7 +39,9 @@ export function parseRootPath(root: string, cwd: string): string {
   return root;
 }
 
-export function normalizeConfig(options: FreshConfig): ResolvedFreshConfig {
+export function normalizeConfig(
+  options: Partial<FreshConfig>,
+): FreshConfig {
   const root = options.root
     ? parseRootPath(options.root, Deno.cwd())
     : Deno.cwd();
@@ -59,6 +55,6 @@ export function normalizeConfig(options: FreshConfig): ResolvedFreshConfig {
   };
 }
 
-export function getSnapshotPath(config: ResolvedFreshConfig): string {
+export function getSnapshotPath(config: FreshConfig): string {
   return path.join(config.buildOutDir, "snapshot.json");
 }

src/context.ts

@@ -7,7 +7,7 @@ import {
 } from "preact";
 import { renderToString } from "preact-render-to-string";
 import { SpanStatusCode } from "@opentelemetry/api";
-import type { ResolvedFreshConfig } from "./config.ts";
+import type { FreshConfig } from "./config.ts";
 import type { BuildCache } from "./build_cache.ts";
 import {
   FreshScripts,
@@ -32,7 +32,7 @@ export type ServerIslandRegistry = Map<ComponentType, Island>;
  */
 export interface FreshContext<State = unknown> {
   /** Reference to the resolved Fresh configuration */
-  readonly config: ResolvedFreshConfig;
+  readonly config: FreshConfig;
   readonly state: State;
   /** The original incoming `Request` object` */
   readonly req: Request;
@@ -90,7 +90,7 @@ export let getBuildCache: (ctx: FreshContext<unknown>) => BuildCache;
 
 export class FreshReqContext<State>
   implements FreshContext<State>, PageProps<unknown, State> {
-  config: ResolvedFreshConfig;
+  config: FreshConfig;
   url: URL;
   req: Request;
   params: Record<string, string>;
@@ -116,7 +116,7 @@ export class FreshReqContext<State>
     url: URL,
     info: Deno.ServeHandlerInfo,
     params: Record<string, string>,
-    config: ResolvedFreshConfig,
+    config: FreshConfig,
     next: FreshContext<State>["next"],
     islandRegistry: ServerIslandRegistry,
     buildCache: BuildCache,

src/dev/dev_build_cache.ts

@@ -1,7 +1,7 @@
 import type { BuildCache, StaticFile } from "../build_cache.ts";
 import * as path from "@std/path";
 import { SEPARATOR as WINDOWS_SEPARATOR } from "@std/path/windows/constants";
-import { getSnapshotPath, type ResolvedFreshConfig } from "../config.ts";
+import { type FreshConfig, getSnapshotPath } from "../config.ts";
 import type { BuildSnapshot } from "../build_cache.ts";
 import { encodeHex } from "@std/encoding/hex";
 import { crypto } from "@std/crypto";
@@ -36,7 +36,7 @@ export class MemoryBuildCache implements DevBuildCache {
   #ready = Promise.withResolvers<void>();
 
   constructor(
-    public config: ResolvedFreshConfig,
+    public config: FreshConfig,
     public buildId: string,
     public transformer: FreshFileTransformer,
     public target: string | string[],
@@ -160,7 +160,7 @@ export class DiskBuildCache implements DevBuildCache {
   #target: string | string[];
 
   constructor(
-    public config: ResolvedFreshConfig,
+    public config: FreshConfig,
     public buildId: string,
     transformer: FreshFileTransformer,
     target: string | string[],

src/mod.ts

@@ -13,7 +13,7 @@ export type { RouteConfig } from "./types.ts";
 export type { Middleware, MiddlewareFn } from "./middlewares/mod.ts";
 export { staticFiles } from "./middlewares/static_files.ts";
 export type { Mode } from "./runtime/server/mod.ts";
-export type { FreshConfig, ResolvedFreshConfig } from "./config.ts";
+export type { FreshConfig } from "./config.ts";
 export type { FreshContext, Island, PageProps } from "./context.ts";
 export { createDefine, type Define } from "./define.ts";
 export type { Method } from "./router.ts";

src/test_utils.ts

@@ -1,7 +1,7 @@
 import { FreshReqContext } from "./context.ts";
 import type { FsAdapter } from "./fs.ts";
 import { type BuildCache, ProdBuildCache } from "./build_cache.ts";
-import type { ResolvedFreshConfig } from "./config.ts";
+import type { FreshConfig } from "./config.ts";
 import type { WalkEntry } from "@std/fs/walk";
 import { DEFAULT_CONN_INFO } from "./app.ts";
 
@@ -51,7 +51,7 @@ export class FakeServer {
   }
 }
 
-const DEFAULT_CONFIG: ResolvedFreshConfig = {
+const DEFAULT_CONFIG: FreshConfig = {
   buildOutDir: "",
   mode: "production",
   basePath: "",
@@ -62,7 +62,7 @@ const DEFAULT_CONFIG: ResolvedFreshConfig = {
 export function serveMiddleware<T>(
   middleware: (ctx: FreshReqContext<T>) => Response | Promise<Response>,
   options: {
-    config?: ResolvedFreshConfig;
+    config?: FreshConfig;
     buildCache?: BuildCache;
     next?: () => Promise<Response>;
   } = {},

tests/islands_test.tsx

@@ -34,7 +34,7 @@ import { FakeServer } from "../src/test_utils.ts";
 
 await buildProd(allIslandApp);
 
-function testApp(config?: FreshConfig) {
+function testApp(config?: Partial<FreshConfig>) {
   const app = new App(config);
   setBuildCache(app, getBuildCache(allIslandApp));
   return app;