Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 2.84 KB

README.md

File metadata and controls

58 lines (40 loc) · 2.84 KB

📦 Nuxt Module Builder

npm version License npm downloads Volta board

The complete solution to build and ship Nuxt modules.

Features

  • Builds modules for Nuxt 3 and later, with no configuration for the module starter layout
  • Builds with tsdown through the builder() plugin: bundles the module entry, and transpiles the runtime directory file by file
  • Generates declarations against the module's own .nuxt, for .ts and .vue files alike
  • Writes the type shims that give nuxt.config autocompletion for the module's options and hooks
  • Lets a playground run the module's sources while package.json publishes dist, and checks the published paths before every build

Quick start

Create a module from the module starter:

npm create nuxt -- -t module my-module

Building a module requires Node ^22.18.0 || ^24.11.0 || >=26.0.0, with tsdown and typescript installed alongside @nuxt/module-builder. Apps that install a built module need Nuxt 3 or later.

Documentation

For writing the module itself, read the Nuxt Module Author Guide.

💻 Development

See CONTRIBUTING.md for setup, the architecture and the tests.

License

MIT - Made with 💚