努克斯模块
- 作者仓库星标 673
- 许可证 MIT
- 作者仓库 nuxt-skills
- 领域
- 运维部署
- 作者声明的智能体
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 94 / 100 · 启发式扫描,不代表运行安全
- 运行环境证据
- 未执行;当前没有隔离运行测试证据
- 作者 / 版本 / 许可证
- @onmax · MIT
- 上下文用量评级
- 低消耗
- 接入复杂程度
- 即装即用
- 是否需要外部接口密钥
- 不需要
- 兼容的系统
- macOS · Linux · Windows
- 运行环境要求
- 未检出明确要求
- 检测到的文件与系统行为
-
- 只读
- 网络行为
- 仅限本地
- 安装命令数
- 无(仅作为资料)
需要注意: 未声明工具权限范围;实际权限由运行环境决定。
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
# 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
│ └── runtime/ # Injected into user's app
│ ├── components/
│ ├── composables/
│ ├── plugins/
│ └── server/
├── playground/ # Dev testing
└── test/fixtures/ # E2E tests
```
## Resources
- [Module Guide](https://nuxt.com/docs/guide/going-further/modules)
- [Nuxt Kit](https://nuxt.com/docs/api/kit)
- [Module Starter](https://github.com/nuxt/starter/tree/module)
章节与文件索引
按说明文件中的顺序排列。
可用的指导
加载文件
模块类型
资源
文件/命令 -> nuxt · vue · @nuxtjs/ · nuxt- · modules/ · nuxt.config.ts
内容校验值 -> 741cc6060c4c
当前原文的自动摘译,尚未人工审校。
可用的指导
references/development.md - 模块剖析、defineNuxtModule、套件实用程序、钩子references/testing-and-publishing.md - E2E 测试、最佳实践、发布、发布references/ci-workflows.md - 复制粘贴 CI/CD 工作流程模板
加载文件
考虑根据您的任务加载这些参考文件:[]references/development.md - 如果构建模块功能、使用defineNuxtModule或使用Kit实用程序[]references/testing-and-publishing.md -如果编写E2E测试、发布到npm或遵循最佳实践[]references/ci-workflows.md -如果为模块设置CI/CD工作流程请勿一次加载所有文件。仅加载与您当前任务相关的内容。
模块类型
类型·位置·用例发布·npm包·
@nuxtjs/,nuxt-分布本地·modules/目录·项目特定扩展内联·nuxt.config.ts·简单的一次性挂钩资源
模块指南 Nuxt 套件模块入门