nuxt-modules

onmax 的头像作者 onmax

创建Nuxt模块时使用:(1) 发布的npm模块(@nuxtjs/,nuxt-),(2) 本地项目模块(modules/目录),(3) 运行时扩展(组件,composables,插件),(4) 服务器扩展(API路由,中间件),(5) 将模块发布到npm,(6) 为模块设置CI/CD工作流。提供defineNuxtModule模式,Kit工具,钩子,E2E测试和发布自动化。

📖 中文导读:创建Nuxt模块时使用:(1) 发布的npm模块(@nuxtjs/,nuxt-),(2) 本地项目模块(modules/目录),(3) 运行时扩展(组件,composables,插件),(4) 服务器扩展(API路由,中间件),(5) 将模块发布到npm,(6) 为模块设置CI/CD工作流。提供defineNuxtModule模式,Kit工具,钩子,E2E测试和发布自动化。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: nuxt-modules description: "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." license: MIT

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

Load based on context:

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