@jacare/meta

File-based routing and app conventions for Jacaré.

Install

npm install @jacare/meta

npm: https://www.npmjs.com/package/@jacare/meta

Usage

// vite.config.js
import { jacare } from '@jacare/vite-plugin'
import { jacareMeta } from '@jacare/meta/vite'

export default {
  plugins: [jacareMeta(), jacare()],
}

// src/nav.js
import { createJacareAppFromRoutes } from '@jacare/meta'
import { routeLoaders } from 'virtual:jacare-routes'
import Shell from './shell.jcr'
import NotFound from './pages/not-found.jcr'

export const nav = createJacareAppFromRoutes({
  layout: Shell,
  missing: NotFound,
  routeLoaders,
})

File conventions

| File | Route | |------|-------| | src/pages/index.jcr | / | | src/pages/about.jcr | /about | | src/pages/tutorial/[slug].jcr | /tutorial/:slug |

API

• jacareMeta() — Vite plugin (@jacare/meta/vite), generates virtual:jacare-routes (invalidates on page add/remove/change in dev)
• createJacareAppFromRoutes() — wraps createNav with routeLoaders from the virtual module (@jacare/meta)
• createJacareApp() — wraps createNav when you already have screens (does not scan pagesDir)
• discoverRoutes() — scan pages directory at build time (@jacare/meta/vite)
• defineJacareConfig() — typed config helper

Links

• npm — @jacare/meta
• Repository
• Related: @jacare/core · @jacare/vite-plugin · @jacare/cli
• Jacaré Lab