Template overrides

This page documents runtime template override directories, its configuration contract and the recommended usage pattern for application developers.

Purpose

Runtime template override directories helps keep the Nuxt module configuration, Feathers runtime, generated services, TypeScript client and CLI workflow aligned.

When to use this option

Use this page when you need to:

• configure runtime template override directories;
• document the decision in a starter or application;
• validate the setup with a CLI command;
• avoid drift between configuration, generated files and runtime behavior.

Configuration example

// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['nuxt-feathers-zod'],

  feathers: {
    templates: {
      dirs: ['feathers/templates'],
      strict: true,
      allow: [
        'server/**/*.ts',
        'client/**/*.ts',
        'types/**/*.d.ts',
      ],
    },
  }
})

CLI example

bunx nuxt-feathers-zod init templates --dir feathers/templates --force
bunx nuxt-feathers-zod templates list

Runtime example

const service = useService('messages')

const result = await service.find({
  query: {
    $limit: 10,
    $sort: { createdAt: -1 },
  },
})

Practical advice

• Keep runtime-affecting options explicit in nuxt.config.ts.
• Prefer CLI-generated services so manifests and generated types stay synchronized.
• Run bunx nuxt-feathers-zod doctor after structural changes.
• Use --dry before write operations on an existing project.