Nuxt/docs/3.api/4.commands/build-module.md
2024-12-18 10:29:56 +00:00

1.4 KiB

title description links
nuxi build-module Nuxt command to build your Nuxt module before publishing.
label icon to size
Source i-simple-icons-github https://github.com/nuxt/cli/blob/main/src/commands/build-module.ts xs
npx nuxi build-module [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--build] [--stub] [--sourcemap] [--prepare]

The build-module command runs @nuxt/module-builder to generate dist directory within your rootDir that contains the full build for your nuxt-module.

Arguments

Argument Description
ROOTDIR="." Specifies the working directory (default: .)

Options

Option Default Description
--cwd=<directory> Specify the working directory, this takes precedence over ROOTDIR (default: .)
--logLevel=<silent|info|verbose> Specify build-time log level
--build false Build module for distribution
--stub false Stub dist instead of actually building it for development
--sourcemap false Generate sourcemaps
--prepare false Prepare module for local development

::read-more{to="https://github.com/nuxt/module-builder" icon="i-simple-icons-github" color="gray" target="_blank"} Read more about @nuxt/module-builder. ::