The complete solution to build and ship Nuxt modules.
- Compatible with Nuxt 3 and Nuxt Kit
- Unified build with unjs/unbuild
- Automated build config using last module spec
- Typescript and ESM support
- Auto generated CommonJS stubs
- Auto generated types and shims for
@nuxt/schema
We recommend to checkout the Nuxt modules author guide before starting with the module-builder.
For a user to use a module generated from module-builder, it's recommended they have:
- Node.js >= 16.x. Latest Node LTS preferred
- Nuxt 3 or Nuxt Bridge. Nuxt 2 is functional but not advised
Get started with our module starter:
npx nuxi init -t module my-module
The module builder requires a special project structure. You can check out the module template.
The entrypoint for module definition.
A default export using defineNuxtModule
and ModuleOptions
type export is expected.
You could also optionally export ModuleHooks
or ModuleRuntimeHooks
to annotate any custom hooks the module uses.
import { defineNuxtModule } from '@nuxt/kit'
export interface ModuleOptions {
apiKey: string
}
export interface ModuleHooks {
'my-module:init': any
}
export interface ModuleRuntimeHooks {
'my-module:runtime-hook': any
}
export interface ModuleRuntimeConfig {
PRIVATE_NAME: string
}
export interface ModulePublicRuntimeConfig {
NAME: string
}
export default defineNuxtModule<ModuleOptions>({
meta: {
name: 'my-module',
configKey: 'myModule'
},
defaults: {
apiKey: 'test'
},
async setup (moduleOptions, nuxt) {
// Write module logic in setup function
}
})
Any runtime file and code that we need to provide by module including plugins, composables and server api, should be in this directory.
Each file will be transformed individually using unjs/mkdist to dist/runtime/
.
A minimum package.json
should look like this:
{
"name": "my-module",
"license": "MIT",
"version": "1.0.0",
"exports": {
".": {
"types": "./dist/types.d.ts",
"import": "./dist/module.mjs",
"require": "./dist/module.cjs"
}
},
"main": "./dist/module.cjs",
"types": "./dist/types.d.ts",
"files": [
"dist"
],
"scripts": {
"prepack": "nuxt-module-build"
},
"dependencies": {
"@nuxt/kit": "npm:@nuxt/kit-edge@latest"
},
"devDependencies": {
"@nuxt/module-builder": "latest"
}
}
Module builder generates dist files in dist/
directory:
module.mjs
: Module entrypoint build fromsrc/module
module.json
: Module meta extracted frommodule.mjs
+package.json
module.cjs
: ESM proxy to allow require module in CommonJS contexttypes.d.ts
: Exported types in addition to shims fornuxt.config
auto completion.runtime/*
: Individually transformed files using unjs/mkdist- Javascript and
.ts
files will be transformed to.js
with extracted types on.d.ts
file with same name .vue
files will be transformed with extracted.d.ts
file- Other files will be copied as is
- Javascript and
- Clone repository
- Enable Corepack using
corepack enable
- Install dependencies using
pnpm install
- Try building example module using
pnpm example:build
MIT - Made with 💚