nuxt-modules

Nuxt 模块开发

创建 Nuxt 模块以扩展框架功能的指南。

相关技能： nuxt（基础知识）、vue（运行时模式）

快速开始

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

可用指南

• references/development.md - 模块结构、defineNuxtModule、Kit 工具、钩子
• references/testing-and-publishing.md - 端到端测试、最佳实践、发布
• references/ci-workflows.md - 可直接复制的 CI/CD 工作流模板

加载文件

根据任务考虑加载以下参考文件：

• references/development.md - 如果要构建模块功能、使用 defineNuxtModule 或使用 Kit 工具
• references/testing-and-publishing.md - 如果要编写端到端测试、发布到 npm 或遵循最佳实践
• references/ci-workflows.md - 如果要为模块设置 CI/CD 工作流

请勿一次性加载所有文件。 只加载与你当前任务相关的文件。

模块类型

类型	位置	用例
已发布	npm 包	@nuxtjs/、nuxt- 分发方式
本地	modules/ 目录	项目专属扩展
内联	nuxt.config.ts	简单的一次性钩子

项目结构

my-module/
├── src/
│   ├── module.ts           # Entry point
│   └── runtime/            # Injected into user's app
│       ├── components/
│       ├── composables/
│       ├── plugins/
│       └── server/
├── playground/             # Dev testing
└── test/fixtures/          # E2E tests

资源

• 模块指南
• Nuxt Kit
• 模块起始模板