About nuxt-modules
A reference skill for developers building Nuxt modules that extend framework functionality. It organizes guidance on module structure, development, testing, publishing, and CI workflows.
Key features
- 01Module anatomy and Kit utilities
- 02Development and hook guidance
- 03E2E testing and publishing
- 04CI workflow templates
Use cases
- 01Creating a published or local module
- 02Implementing module features with Nuxt Kit
- 03Setting up tests or CI for a module
Install
Copy the command and run it in a terminal.
$
npx skills add https:/After installing, type/nuxt-modulesin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
references/ci-workflows.mddevelopment.mdtesting-and-publishing.mdDetails
From the project READMENuxt 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
- references/development.md - Module anatomy, defineNuxtModule, Kit utilities, hooks
- references/testing-and-publishing.md - E2E testing, best practices, releasing, publishing
- 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
Resources
Comments
Markdown supported