Back to Nuxt

nuxt build-module

docs/4.api/4.commands/build-module.md

4.4.41.9 KB
Original Source
<!--build-module-cmd-->
bash
npx nuxt build-module [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--build] [--stub] [--sourcemap] [--prepare]
<!--/build-module-cmd-->

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

<!--build-module-args-->
ArgumentDescription
ROOTDIR="."Specifies the working directory (default: .)
<!--/build-module-args-->

Options

<!--build-module-opts-->
OptionDefaultDescription
--cwd=<directory>Specify the working directory, this takes precedence over ROOTDIR (default: .)
--logLevel=<silent|info|verbose>Specify build-time log level
--buildfalseBuild module for distribution
--stubfalseStub dist instead of actually building it for development
--sourcemapfalseGenerate sourcemaps
--preparefalsePrepare module for local development
<!--/build-module-opts-->

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