defineMeekoConfig

defineMeekoConfig(config) declara la configuración del proyecto en meeko.config.ts. En ejecución devuelve el mismo objeto; su papel es dar tipos, completado y documentación a cada clave y conservar los literales (const T), para que server.adapter siga discriminado y las opciones de cada adaptador se comprueben. Desde 1.8 también tipa y documenta la clave de cada módulo de modules sin importar nada (véase modules).

meeko dev, meeko build, meeko check, el plugin de Vite y el servidor de lenguaje leen el export por defecto de meeko.config.ts. Cada clave tiene su página en el grupo «Configuración» de esta referencia.

Uso#

// 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,
});

Tipo#

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
}

Parámetros#

Cada módulo de modules añade su propia clave (su meta.configKey), con sus opciones: i18n para @meekojs/i18n, ui para @meekojs/ui. Meeko la tipa con .meeko/types/config.d.ts, que generan meeko dev, meeko check y el editor de un workspace de confianza; meeko check comprueba meeko.config.ts con esos tipos desde 1.8.

Valor devuelto#

El mismo objeto, con su tipo literal. Cambiar meeko.config.ts exige reiniciar meeko dev.

Ejemplos#

Layers, módulos y autoimports#

// 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" },
});

Un sitio estático con 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" },
});

Errores comunes#

server sin adapter#

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

meeko check da TS2322: Type '{ port: number; }' is not assignable to type 'MeekoServerConfig | undefined'. con Property 'adapter' is missing, y la carga de la configuración falla con meeko.config.ts: server.adapter debe ser "node", "cloudflare", "deno", "bun" o "static".

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

Un adaptador que no existe#

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

meeko check da TS2322: Type '"vercel"' is not assignable to type '"bun" | "cloudflare" | "deno" | "node" | "static"'. y la misma parada al cargar la configuración.

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

Una clave mal escrita#

defineMeekoConfig acepta claves que no conoce, porque los módulos añaden las suyas (meta.configKey), también sin aumentar MeekoConfig: rechazarlas en los tipos rompería configuraciones válidas de 1.x. La opción mal escrita se ignora, y desde 1.7 la carga de los módulos (meeko dev, meeko build, meeko check) lo avisa con la clave más parecida; desde 1.8, la clave de un módulo instalado que falta en modules es el aviso MEEK127, que nombra la entrada que falta: [meeko] Aviso: meeko.config.ts tiene la clave desconocida "sitmap", que Meeko ignora. ¿Quisiste decir "sitemap"?. Hasta 1.6 no había ningún aviso.

export default defineMeekoConfig({ sitmap: true });

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

Notas#

• Dónde se ejecuta. En Node, al cargar la configuración: nunca en el navegador ni en el servidor de producción, que recibe sólo lo que el build escribe en el manifiesto. No importes código de la aplicación en meeko.config.ts.
• Variables de entorno. meeko dev, build, start, preview y check leen el .env del proyecto antes de cargar la configuración; MEEKO_PORT y MEEKO_HOST sustituyen a server.port y server.host.
• Secretos. La configuración acaba en el build: los secretos se leen en el servidor, en server/runtime.ts, no aquí.
• Sitemap. Las URL de sitemap.xml son absolutas: con sitemap y sin site ni MEEKO_PUBLIC_ORIGIN, meeko build se detiene antes de compilar. meeko check no lo comprueba.
• Sin defineMeekoConfig. Un objeto exportado sin ella también se carga, pero sin tipos ni completado.

Relacionado#

• defineMeekoModuleDeclara un módulo de Meeko, que configura el proyecto desde código al cargar la configuración, con sus opciones combinadas y el objeto meeko.
• serverEl adaptador de meeko build (node, bun, deno, cloudflare o static) con sus opciones y, desde 1.7, la CSP y las cabeceras de las respuestas en los adaptadores con servidor.
• layersCarpetas del proyecto que aportan páginas, componentes, autoimports, layouts y plugins a la aplicación, en el orden escrito.
• modulesNombres de los módulos creados con defineMeekoModule que configuran el proyecto desde código; las opciones de cada uno van en su clave (meta.configKey).
• importsCarpetas de autoimports además de las de por defecto, cada una con el ámbito de la carpeta que la contiene, app, shared o server.
• themeEl tema claro, oscuro o propio de la aplicación sin parpadeo, con la elección en una cookie, el tema en html desde el primer byte y useTheme en los componentes.
• devtoolsMonta el panel de Meeko DevTools dentro de la página en meeko dev, sin código de la aplicación, en la esquina elegida.
• ConfiguraciónMeeko como framework full-stack
• LayersMeeko como framework full-stack