mirror of
https://github.com/nuxt/nuxt.git
synced 2025-01-19 01:45:53 +00:00
43 lines
1.4 KiB
Markdown
43 lines
1.4 KiB
Markdown
---
|
|
title: 'nuxi build-module'
|
|
description: 'Nuxt command to build your Nuxt module before publishing.'
|
|
links:
|
|
- label: Source
|
|
icon: i-simple-icons-github
|
|
to: https://github.com/nuxt/cli/blob/main/src/commands/build-module.ts
|
|
size: xs
|
|
---
|
|
|
|
<!--build-module-cmd-->
|
|
```bash [Terminal]
|
|
npx nuxi 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-->
|
|
Argument | Description
|
|
--- | ---
|
|
`ROOTDIR="."` | Specifies the working directory (default: `.`)
|
|
<!--/build-module-args-->
|
|
|
|
## Options
|
|
|
|
<!--build-module-opts-->
|
|
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
|
|
<!--/build-module-opts-->
|
|
|
|
::read-more{to="https://github.com/nuxt/module-builder" icon="i-simple-icons-github" color="gray" target="\_blank"}
|
|
Read more about `@nuxt/module-builder`.
|
|
::
|