How to use
- Copy the installation command and review the source package before installing it in your own agent environment.
- Check the source document for required tools, credentials and supported hosts.
- Describe your input and desired deliverable; review the output against the source material.
npx skills add https://github.com/onmax/nuxt-skills --skill nuxt-modulesBefore you start
- Installation does not include a model subscription, API allowance or permission to access your files.
- Repository stars and installation counts describe activity, not an independent quality or security test.
Original skill document
Rendered from the source repository. Headings, examples, code, tables, links, and referenced images are preserved.
Nuxt Module Development
Guide for creating Nuxt modules that extend framework functionality.
Related skills: nuxt (basics), vue (runtime patterns)
Quick Start
bash
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 testsAvailable Guidance
- [references/development.md](references/development.md) - Module anatomy, defineNuxtModule, Kit utilities, hooks
- [references/testing-and-publishing.md](references/testing-and-publishing.md) - E2E testing, best practices, releasing, publishing
- [references/ci-workflows.md](references/ci-workflows.md) - Copy-paste CI/CD workflow templates
Loading Files
Consider loading these reference files based on your task:
- [ ] references/development.md - if building module features, using defineNuxtModule, or working with Kit utilities
- [ ] references/testing-and-publishing.md - if writing E2E tests, publishing to npm, or following best practices
- [ ] references/ci-workflows.md - if setting up CI/CD workflows for your module
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
