nuxt-modules

Guide Nuxt module development with patterns for building, testing, and publishing.

26|2|Updated Jun 16, 2025
One-click install
npx skills add https://github.com/besidka/besidka --skill nuxt-modules-besidka
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: nuxt-modules
Source: https://github.com/besidka/besidka/tree/main/.ai/skills/nuxt-modules
Command: npx skills add https://github.com/besidka/besidka --skill nuxt-modules-besidka

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill helps Nuxt module developers scaffold and extend the Nuxt framework by providing guided patterns, essential utilities, and best practices for creating, testing, and releasing modules.

Core Features & Use Cases

  • Module anatomy: Learn the structure of a Nuxt module and how to organize code across runtime, server, and tooling.
  • defineNuxtModule patterns: Use Kit utilities and defineNuxtModule to create robust, extensible modules with hooks.
  • Testing & publishing: Guidance on E2E testing, CI/CD workflows, and releasing modules to npm.
  • Use Case: Build local modules for project-specific extensions or publish a reusable module for broader use.

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

Frequently Asked Questions about nuxt-modules

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I build and publish a Nuxt module from scratch?

To build a Nuxt module, use the nuxi init -t module command to scaffold the project, then structure your runtime and server code using defineNuxtModule before testing and publishing to npm via automated CI/CD workflows.

What is the defineNuxtModule pattern used for in Nuxt module development?

The defineNuxtModule pattern is used to create robust, extensible Nuxt modules by leveraging Kit utilities and hooks to seamlessly extend the core framework across runtime, server, and tooling environments.

How should I organize E2E testing for a custom Nuxt module?

Organize E2E testing for a Nuxt module by utilizing the scaffolded playground environment, running npm run test to validate module behavior, and integrating these checks into automated CI/CD workflows before release.

Can I create a local Nuxt module for project-specific extensions instead of publishing it?

Yes, you can create local Nuxt modules for project-specific extensions or build reusable modules for broader use, applying the same module anatomy, Kit utilities, and defineNuxtModule patterns without publishing to npm.

What's the best way to extend the Nuxt framework with server and runtime hooks?

The best way to extend the Nuxt framework is by using defineNuxtModule patterns with Kit utilities to register hooks, allowing you to inject custom logic across runtime, server, and build tooling layers.

Why does my Nuxt module require a specific frontmatter structure?

Your Nuxt module requires a specific frontmatter with name and description to enforce a structured operational body, ensuring the module adheres to framework conventions and integrates cleanly with deeper guidance references.