Nuxt Modules

1---2name: nuxt-modules3description: "Use when creating Nuxt modules: (1) Published npm modules (@nuxtjs/, nuxt-), (2) Local project modules (modules/ directory), (3) Runtime extensions (components, composables, plugins), (4) Server extensions (API routes, middleware), (5) Releasing/publishing modules to npm, (6) Setting up CI/CD workflows for modules. Provides defineNuxtModule patterns, Kit utilities, hooks, E2E testing, and release automation."4license: MIT5---6 7# Nuxt Module Development8 9Guide for creating Nuxt modules that extend framework functionality.10 11**Related skills:** `nuxt` (basics), `vue` (runtime patterns)12 13## Quick Start14 15```bash16npx nuxi init -t module my-module17cd my-module && npm install18npm run dev        # Start playground19npm run dev:build  # Build in watch mode20npm run test       # Run tests21```22 23## Available Guidance24 25- **[references/development.md](references/development.md)** - Module anatomy, defineNuxtModule, Kit utilities, hooks26- **[references/testing-and-publishing.md](references/testing-and-publishing.md)** - E2E testing, best practices, releasing, publishing27- **[references/ci-workflows.md](references/ci-workflows.md)** - Copy-paste CI/CD workflow templates28 29## Loading Files30 31**Consider loading these reference files based on your task:**32 33- [ ] [references/development.md](references/development.md) - if building module features, using defineNuxtModule, or working with Kit utilities34- [ ] [references/testing-and-publishing.md](references/testing-and-publishing.md) - if writing E2E tests, publishing to npm, or following best practices35- [ ] [references/ci-workflows.md](references/ci-workflows.md) - if setting up CI/CD workflows for your module36 37**DO NOT load all files at once.** Load only what's relevant to your current task.38 39## Module Types40 41| Type      | Location         | Use Case                         |42| --------- | ---------------- | -------------------------------- |43| Published | npm package      | `@nuxtjs/`, `nuxt-` distribution |44| Local     | `modules/` dir   | Project-specific extensions      |45| Inline    | `nuxt.config.ts` | Simple one-off hooks             |46 47## Project Structure48 49```50my-module/51├── src/52│   ├── module.ts           # Entry point53│   └── runtime/            # Injected into user's app54│       ├── components/55│       ├── composables/56│       ├── plugins/57│       └── server/58├── playground/             # Dev testing59└── test/fixtures/          # E2E tests60```61 62## Resources63 64- [Module Guide](https://nuxt.com/docs/guide/going-further/modules)65- [Nuxt Kit](https://nuxt.com/docs/api/kit)66- [Module Starter](https://github.com/nuxt/starter/tree/module)