meeko routes

meeko routes performs the discovery step of meeko check without checking anything: it reads app/pages, server/api, server/rpc, server/socket, components and auto-import folders from the project and its layers, then writes the manifests and declarations used by the editor, href() and the api, rpc and socket clients. Since 1.7, it prepares .meeko/ like meeko check: it also writes Vite entry points, .meeko/types/services.d.ts, page contracts and tsconfig.*.json, so tsc -p .meeko/tsconfig.server.json works afterward. It prints the path of each file written.

It is the quick way to make a new page or endpoint available to types, for example in a script or your own watcher, without waiting for TypeScript.

Usage#

meeko routes .

C:\proyectos\tienda\.meeko\types\routes.d.ts
C:\proyectos\tienda\.meeko\manifests\routes.json
C:\proyectos\tienda\.meeko\types\server-contracts.d.ts
C:\proyectos\tienda\.meeko\manifests\server.json
C:\proyectos\tienda\.meeko\types\app\app.d.meeko.ts
C:\proyectos\tienda\.meeko\types\app\components\Greeting.d.meeko.ts
C:\proyectos\tienda\.meeko\types\app\layouts\default.d.meeko.ts
C:\proyectos\tienda\.meeko\types\app\pages\index.d.meeko.ts
C:\proyectos\tienda\.meeko\generated\page-contracts.server.ts
C:\proyectos\tienda\.meeko\types\services.d.ts
C:\proyectos\tienda\.meeko\types\autoimports\client.d.ts
C:\proyectos\tienda\.meeko\types\autoimports\server.d.ts
C:\proyectos\tienda\.meeko\types\autoimports\shared.d.ts
C:\proyectos\tienda\.meeko\tsconfig.app.json
C:\proyectos\tienda\.meeko\tsconfig.server.json
C:\proyectos\tienda\.meeko\tsconfig.shared.json

Type#

meeko routes <directorio>

Parameters#

Result#

It exits with code 0, or with 1 and a message if discovery fails: two routes resolving to the same URL, an API contract without response, a nonexistent named layout or middleware, a computed render…

Examples#

After creating a page, before using it in <MeekoLink>#

mkdir -p app/pages/blog
printf '<template><h1>Blog</h1></template>\n' > app/pages/blog/index.meeko
meeko routes .

to="/blog" stops producing TS2345 in the editor as soon as routes.d.ts includes the route.

An invalid API contract#

meeko routes .

C:/proyectos/tienda/server/api/health.get.ts: la API requiere un schema público response

Server discovery requires a response imported from shared/; meeko dev, meeko check and meeko build give the same error because they share discovery.

Common mistakes#

Omitting the directory#

meeko routes

Falta el directorio de routes, with usage and code 1.

meeko routes .

Expecting routes to perform the checks of meeko check#

meeko routes . && echo "no type errors"

meeko routes only prepares .meeko/: it does not run TypeScript or check components, so it exits with 0 even with type errors. Since 1.7, it prepares the same files as meeko check, and npx tsc -p .meeko/tsconfig.server.json works afterward; through 1.6, it did not write tsconfig.*.json or services.d.ts, and tsc failed with TS5058. To check, use meeko check (or meeko check-app for components only).

meeko check .

The path of a subfolder#

meeko routes app

ENOENT: no such file or directory, scandir '…\app\app\pages': the path must be the project root.

meeko routes .

Notes#

• Without running TypeScript. It only reads and writes files; it does not check types or page prop contracts. Use meeko check for that.
• Executes configuration. It loads meeko.config.ts and its modules' setup functions, like dev and check, but does not read the project's .env.
• What it does not list. It also writes, without listing them, Vite entry points (entry-client.ts, entry-server.ts, entry-node.ts), clients in .meeko/generated/ (clients.client.ts, clients.server.ts, socket-contracts.ts), <script server> blocks in .meeko/routes/ and .meeko/types/virtual-pages.d.ts. Through 1.6, it did not write entry points, tsconfig.*.json, page contracts or services.d.ts.
• Orphaned components. Component declarations are recorded in .meeko/manifests/component-types.json; regeneration deletes only managed declarations whose component no longer exists.
• Windows and POSIX. Printed paths are absolute and use the system separator; server discovery errors use /.

Related#

• meeko checkChecks an entire project, or a single .meeko component, with Meeko and TypeScript diagnostics, and generates .meeko/ types.
• meeko typesGenerates a component's .d.meeko.ts declaration and those of its imported components in .meeko/types/, so TypeScript can check their props.
• RouteIdID de cualquier ruta de la aplicación, como "/users/[id]":
• ConfigurationMeeko as a full-stack framework
• Auto-imports and TypeScriptMeeko as a full-stack framework