Github Stars:
Last Commit: 
Created: 
Overview
The Nuxt Module Builder is a complete solution for building and shipping Nuxt modules. It is compatible with Nuxt 3 and Nuxt Kit and offers a unified build with unjs/unbuild. The module builder includes features such as automated build configuration using the last module spec, TypeScript and ESM (ECMAScript Modules) support, auto-generated CommonJS stubs, and auto-generated types and shims for @nuxt/schema.
Features
- Compatible with Nuxt 3 and Nuxt Kit: The module builder works seamlessly with the latest versions of Nuxt to ensure compatibility and smooth integration.
- Unified build with unjs/unbuild: The module builder utilizes the unjs/unbuild tool to provide a unified and streamlined build process for Nuxt modules.
- Automated build config using last module spec: The module builder automatically generates the build configuration using the latest module specification, reducing the manual setup required.
- TypeScript and ESM support: Nuxt module builder supports both TypeScript and ECMAScript Modules, providing flexibility and choice for developers.
- Auto-generated CommonJS stubs: The module builder generates CommonJS stubs automatically, making it easier to integrate with existing projects using CommonJS modules.
- Auto-generated types and shims for @nuxt/schema: The module builder generates types and shims specifically for the @nuxt/schema library, simplifying the development process.
Installation
To use the Nuxt Module Builder, follow these steps:
- Clone the repository.
- Enable Corepack using
corepack enable. - Install dependencies using
pnpm install. - Try building an example module using
pnpm example:build.
Summary
The Nuxt Module Builder is a powerful tool for building and shipping Nuxt modules. With its compatibility with Nuxt 3 and Nuxt Kit, automated build configuration, TypeScript and ESM support, and auto-generated stubs and types, it offers a complete solution for developers looking to create and distribute Nuxt modules. Its ease of installation and use make it a valuable asset for any Nuxt project.
