defineMeekoConfig

defineMeekoConfig(config) declares project configuration in meeko.config.ts. At runtime it returns the same object; its role is to provide types, completion and documentation for each key and preserve literals (const T), so server.adapter stays discriminated and each adapter's options are checked. Since 1.8, it also types and documents each module key in modules without importing anything (see modules).

meeko dev, meeko build, meeko check, the Vite plugin and the language server read the default export of meeko.config.ts. Each key has its own page in this reference's “Configuration” group.

Usage#

// meeko.config.ts
import { defineMeekoConfig } from "@meekojs/meeko/framework";

export default defineMeekoConfig({
  server: { adapter: "node", port: 4173 },
  site: "https://example.com",
  sitemap: true,
  theme: true,
});

Type#

function defineMeekoConfig<const T extends MeekoConfig>(config: T & MeekoConfig): T

interface MeekoConfig {
	readonly viewTransitions?: boolean
	readonly components?: {
		readonly dirs?: readonly {
			readonly path: string
			readonly prefix?: string
		}[]
	}
	readonly layers?: readonly string[]
	readonly extends?: readonly string[]
	readonly modules?: readonly MeekoModuleEntry[]
	readonly imports?: {
		readonly appDirs?: readonly string[]
		readonly sharedDirs?: readonly string[]
		readonly serverDirs?: readonly string[]
	}
	readonly alias?: Readonly<Record<string, string | false>>
	readonly server?: MeekoServerConfig
	readonly css?: { readonly scopeAttribute?: 'all' | 'matched' }
	readonly document?: DocumentConfig
	readonly dev?: {
		readonly serverLogs?: boolean
	}
	readonly devtools?: boolean | MeekoDevtoolsConfig
	readonly site?: string
	readonly sitemap?: boolean | SitemapConfig
	readonly robots?: boolean | RobotsConfig
	readonly theme?: boolean | ThemeConfig
}

Parameters#

Each module in modules adds its own key (its meta.configKey) with its options: i18n for @meekojs/i18n, ui for @meekojs/ui. Meeko types it through .meeko/types/config.d.ts, generated by meeko dev, meeko check and the editor in a trusted workspace; meeko check checks meeko.config.ts with these types since 1.8.

Return value#

The same object with its literal type. Changing meeko.config.ts requires restarting meeko dev.

Examples#

Layers, modules and auto-imports#

// meeko.config.ts
import { defineMeekoConfig } from "@meekojs/meeko/framework";

export default defineMeekoConfig({
  layers: ["./layers/base"],
  modules: ["@acme/seo", "./modules/accent"],
  accent: { initial: "teal" },
  imports: {
    appDirs: ["app/services"],
    sharedDirs: ["shared/validators"],
    serverDirs: ["server/services", "server/repositories"],
  },
  alias: { "#emails": "./server/emails" },
});

A static site with CSP#

// meeko.config.ts
import { defineMeekoConfig } from "@meekojs/meeko/framework";

export default defineMeekoConfig({
  server: {
    adapter: "static",
    contentSecurityPolicy: { "default-src": ["'self'"], "img-src": ["'self'", "data:"] },
  },
  site: "https://docs.example.com",
  sitemap: { exclude: ["/borradores/*"] },
  robots: { disallow: ["/borradores/"] },
});

Cloudflare Workers#

// meeko.config.ts
import { defineMeekoConfig } from "@meekojs/meeko/framework";

export default defineMeekoConfig({
  server: { adapter: "cloudflare" },
  css: { scopeAttribute: "matched" },
  document: { lang: "es" },
});

Common mistakes#

server without adapter#

export default defineMeekoConfig({ server: { port: 3000 } });

meeko check reports TS2322: Type '{ port: number; }' is not assignable to type 'MeekoServerConfig | undefined'. with Property 'adapter' is missing, and configuration loading fails with meeko.config.ts: server.adapter debe ser "node", "cloudflare", "deno", "bun" o "static".

export default defineMeekoConfig({ server: { adapter: "node", port: 3000 } });

An adapter that does not exist#

export default defineMeekoConfig({ server: { adapter: "vercel" } });

meeko check reports TS2322: Type '"vercel"' is not assignable to type '"bun" | "cloudflare" | "deno" | "node" | "static"'. and the same failure when loading configuration.

export default defineMeekoConfig({ server: { adapter: "node" } });

A misspelled key#

defineMeekoConfig accepts unknown keys because modules add their own (meta.configKey), even without augmenting MeekoConfig: rejecting them in types would break valid 1.x configurations. The misspelled option is ignored, and since 1.7, module loading (meeko dev, meeko build, meeko check) warns with the most similar key; since 1.8, a key for an installed module missing from modules produces warning MEEK127, naming the missing entry: [meeko] Aviso: meeko.config.ts tiene la clave desconocida "sitmap", que Meeko ignora. ¿Quisiste decir "sitemap"?. Through 1.6, there was no warning.

export default defineMeekoConfig({ sitmap: true });

export default defineMeekoConfig({ site: "https://example.com", sitemap: true });

Notes#

• Where it runs. In Node, when loading configuration: never in the browser or production server, which receives only what the build writes in the manifest. Do not import application code in meeko.config.ts.
• Environment variables. meeko dev, build, start, preview and check read the project's .env before loading configuration; MEEKO_PORT and MEEKO_HOST override server.port and server.host.
• Secrets. Configuration ends up in the build: read secrets on the server, in server/runtime.ts, not here.
• Sitemap. sitemap.xml URLs are absolute: with sitemap and without site or MEEKO_PUBLIC_ORIGIN, meeko build stops before compiling. meeko check does not check this.
• Without defineMeekoConfig. An object exported without it also loads, but without types or completion.

Related#

• defineMeekoModuleDeclares a Meeko module that configures the project from code when loading configuration, with merged options and the meeko object.
• serverThe meeko build adapter (node, bun, deno, cloudflare or static) and its options, plus, since 1.7, response CSP and headers for server adapters.
• layersProject folders that contribute pages, components, auto-imports, layouts and plugins to the application, in the listed order.
• modulesNames of modules created with defineMeekoModule that configure the project through code; each module's options go under its key (meta.configKey).
• importsAuto-import folders in addition to the defaults, each with the scope of its containing folder, app, shared or server.
• themeFlicker-free light, dark or custom application themes, with the choice in a cookie, the theme on html from the first byte and useTheme in components.
• devtoolsMounts the Meeko DevTools panel inside the page in meeko dev, without application code, in the chosen corner.
• ConfigurationMeeko as a full-stack framework
• LayersMeeko as a full-stack framework