Nuxt Modules

by onmax008232b5d7a5MIT719 starsListed Oct 8, 2026Updated Oct 8, 2026Repository updated 2 days ago

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.

Instructions onlySoftware Development DevOps & Cloud

AI-generated overview

Guides creation of Nuxt modules, covering module anatomy, Kit utilities, hooks, E2E testing, publishing and CI workflows.

What it does: This skill provides guidance for building Nuxt modules that extend framework functionality, including published npm modules, local project modules, runtime extensions and server extensions. It points to reference files covering defineNuxtModule patterns, Kit utilities, hooks, E2E testing, best practices, npm releasing and copy-paste CI/CD workflow templates. It also outlines module types, project structure and quick-start commands.
When to use it: Use it when creating a Nuxt module, whether published to npm or local to a project. It also applies when adding runtime or server extensions, writing E2E tests, publishing a module, or setting up CI/CD workflows for a module.
Requirements: Instructions only; no scripts are shipped. Following the quick-start commands assumes Node.js, npm and network access for npx nuxi init and dependency installation.

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-modulecd my-module && npm installnpm run dev        # Start playgroundnpm run dev:build  # Build in watch modenpm run test       # Run tests

npx nuxi init -t module my-modulecd my-module && npm installnpm run dev        # Start playgroundnpm run dev:build  # Build in watch modenpm run test       # Run tests

Available Guidance

references/development.md [blocked] - Module anatomy, defineNuxtModule, Kit utilities, hooks
references/testing-and-publishing.md [blocked] - E2E testing, best practices, releasing, publishing
references/ci-workflows.md [blocked] - Copy-paste CI/CD workflow templates

Loading Files

Consider loading these reference files based on your task:

references/development.md [blocked] - if building module features, using defineNuxtModule, or working with Kit utilities
references/testing-and-publishing.md [blocked] - if writing E2E tests, publishing to npm, or following best practices
references/ci-workflows.md [blocked] - 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

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

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

Source and attribution

Source:onmax/nuxt-skillsinskills/nuxt-modulesat commit008232b

License: MIT

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal

Type	Location	Use Case
Published	npm package	`@nuxtjs/`, `nuxt-` distribution
Local	`modules/` dir	Project-specific extensions
Inline	`nuxt.config.ts`	Simple one-off hooks

Nuxt Modules

Nuxt Module Development

Quick Start

Available Guidance

Loading Files

Module Types

Project Structure

Resources

Source and attribution

More from onmax/nuxt-skills

Vue

Nuxt Ui

Nuxt I18n

More in Software Development

Playground

M5 Onboard

Cardputer Buddy

Web Design Guidelines

Vercel React Native Skills

Vercel React Best Practices