nuxt-modules

nuxt-modules is a development guide for building Nuxt modules that extend framework functionality. It covers the full lifecycle: published npm modules (the @nuxtjs/ and nuxt- families), local project modules in a modules/ directory, runtime extensions such as components, composables, and plugins, server extensions like API routes and middleware, and the release and publishing process including CI/CD workflow setup. Core building blocks include defineNuxtModule patterns, Nuxt Kit utilities, hooks, E2E testing, and release automation.

Getting started is scaffolded with npx nuxi init -t module my-module, followed by a playground dev server, a watch-mode build, and a test runner. The recommended project structure centers on a src/module.ts entry point and a src/runtime/ directory holding components, composables, plugins, and server code that gets injected into the user's app, alongside a playground/ for dev testing and test/fixtures/ for E2E tests.

The guidance is split across focused reference files that should be loaded only as needed: a development reference for module anatomy, defineNuxtModule, and Kit utilities; a testing-and-publishing reference for E2E tests, best practices, releasing, and npm publishing; and a CI-workflows reference with copy-paste CI/CD templates. The skill explicitly advises against loading all references at once, instead selecting the file relevant to the current task.

Use it when creating any kind of Nuxt module, whether a distributable npm package, a project-specific local extension, or a simple inline hook in nuxt.config.ts, or when setting up testing, releasing, or CI/CD for a module. It positions itself alongside related nuxt (basics) and vue (runtime patterns) skills, and links to the official Module Guide, Nuxt Kit docs, and module starter for deeper reference.