Nuxt Module Development
Guide for creating Nuxt modules that extend framework functionality.
Related skills: nuxt (basics), vue (runtime patterns)
Quick Start
npx nuxi init -t module my-module
cd my-module && npm install
npm run dev # Start playground
npm run dev:build # Build in watch mode
npm run test # Run tests
Available Guidance
Loading Files
Consider loading these reference files based on your task:
DO NOT load all files at once. Load only what's relevant to your current task.
Module Types
| Type |
Location |
Use Case |
| Published |
npm package |
@nuxtjs/, nuxt- distribution |
| Local |
modules/ dir |
Project-specific extensions |
| Inline |
nuxt.config.ts |
Simple one-off hooks |
Project Structure
my-module/
āāā src/
ā āāā module.ts # Entry point
ā āāā runtime/ # Injected into user's app
ā āāā components/
ā āāā composables/
ā āāā plugins/
ā āāā server/
āāā playground/ # Dev testing
āāā test/fixtures/ # E2E tests
Resources