nuxt-modules
- Repo stars 673
- License MIT
- Author repo nuxt-skills
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
- 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
- Fluxly category
- DevOps
- Author-declared agents
- No explicit declaration found; this is not inferred or tested compatibility
- Static check
- 94 / 100 · heuristic scan, not runtime safety proof
- Author / version / license
- @onmax · MIT
- Fluxly token estimate
- Lean
- Fluxly setup estimate
- Plug-and-play
- External API key
- No requirement detected
- Detected OS requirements
- macOS · Linux · Windows
- Runtime requirements
- Unspecified
- Detected file/system behavior
-
- Read-only
- Detected network behavior
- Local-only
- Install commands
- None (reference only)
Profile is derived at build time from SKILL.md and install vectors. Subject to drift from author intent.
Heads up: 未限定 allowed-tools,默认拥有全部工具权限。
The current SKILL.md does not define a fixed output example. Quick Start
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
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…
Type · Location · Use Case Published · npm package · @nuxtjs/, nuxt- distribution Local · modules/ dir · Project-specific extensions
Project Structure
Module Guide Nuxt Kit Module Starter
# 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 tests
```
## Available 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](references/development.md) - if building module features, using defineNuxtModule, or working with Kit utilities
- [ ] [references/testing-and-publishing.md](references/testing-and-publishing.md) - if writing E2E tests, publishing to npm, or following best practices
- [ ] [references/ci-workflows.md](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
… Author text anchors workflow facts; Fluxly only indexes current sections, terms, files, and commands.
sections -> Quick Start → Available Guidance → Loading Files → Module Types → Project Structure → Resources
terms -> Related skills · [references/development.md](references/development.md) · [references/testing-and-publishing.md](references/testing-and-publishing.md) · [references/ci-workflows.md](references/ci-workflows.md) · Consider loading these reference files based on your task · DO NOT load all files at once.
files/cmd -> nuxt · vue · @nuxtjs/ · nuxt- · modules/ · nuxt.config.ts
body sha256 -> 741cc6060c4c
Decide Fit First
Design Intent
How To Use It
Boundaries And Review