nuxt-modules_skill

This skill helps you build, test, and publish Nuxt modules using defineNuxtModule patterns, Kit utilities, and CI/CD workflows.

TypeScript

431

GitHub Stars

1

Bundled Files

2 months ago

Catalog Refreshed

4 months ago

First Indexed

Readme & install

Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.

Installation

Preview and clipboard use veilstrat where the catalogue uses aiagentskills.

npx veilstrat add skill onmax/nuxt-skills --skill nuxt-modules

SKILL.md2.4 KB

Overview

This skill helps you create, test, and publish Nuxt modules for both local projects and npm packages. I provide patterns for defineNuxtModule, Kit utilities, runtime and server extension placement, E2E testing guidance, and release/CI workflow templates. It accelerates module development and standardizes publishing steps.

How this skill works

I inspect your module type and suggest the appropriate structure and workflow: published npm modules, local modules in a modules/ directory, inline config-based hooks, runtime/runtime extensions (components, composables, plugins), and server extensions (API routes, middleware). I also guide you through testing (fixtures and E2E) and generating CI/CD templates for automated builds and releases.

When to use it

Creating a new Nuxt module package (npm scoped or unscoped)
Adding project-specific extensions in modules/ of an existing Nuxt app
Implementing runtime features like components, composables, or client plugins
Adding server-side routes, middleware, or server handlers in module runtime
Setting up E2E tests and release pipelines before publishing to npm
Scaffolding CI/CD workflows for automated builds, tests, and releases

Best practices

Use defineNuxtModule and Nuxt Kit utilities to keep module API consistent and typed
Separate src/module.ts (entry) from runtime/ assets (components, composables, plugins, server)
Provide a playground or dev mode for rapid iteration with npm run dev and dev:build
Include test fixtures and E2E tests for integration coverage before publishing
Automate releases with CI templates that run lint, tests, build, and npm publishing steps

Example use cases

Build and publish an @nuxtjs/ scoped module that adds auth middleware and composables
Create a local modules/ extension to inject shared components and a plugin across the project
Add server extensions inside module runtime to expose API endpoints or custom middleware
Run E2E tests with fixtures in test/fixtures to validate module behavior in a controlled playground
Configure CI workflow that builds the module, runs tests, and publishes a release tag to npm

FAQ

Put injected app code (components, composables, plugins) under runtime/ and server handlers under runtime/server/. Keep module entry logic in src/module.ts.

What commands speed up development?

Use npx nuxi init -t module to scaffold, then npm run dev for playground, npm run dev:build for build-watch, and npm run test for running tests.