mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-11 08:33:53 +00:00
feat(nuxi): nuxi build-module
command (#7610)
Co-authored-by: Pooya Parsa <pooya@pi0.io>
This commit is contained in:
parent
bdb6e3298f
commit
8f7a7ec06e
16
docs/content/3.api/5.commands/build-module.md
Normal file
16
docs/content/3.api/5.commands/build-module.md
Normal file
@ -0,0 +1,16 @@
|
||||
# `nuxi build-module`
|
||||
|
||||
```{bash}
|
||||
npx nuxi build-module [--stub] [rootDir]
|
||||
```
|
||||
|
||||
The `build-module` command runs `@nuxt/module-builder` to generate `dist` directory within your `rootDir` that contains the full build for your **nuxt-module**.
|
||||
|
||||
Option | Default | Description
|
||||
-------------------------|-----------------|------------------
|
||||
`rootDir` | `.` | The root directory of the module to bundle.
|
||||
`--stub` | `false` | Stub out your module for development using [jiti](https://github.com/unjs/jiti#jiti). (**note:** This is mainly for development purposes.)
|
||||
|
||||
::alert
|
||||
This command is only available when you are using `@nuxt/module-builder` to build your module. Please see [this readme](https://github.com/nuxt/module-builder#-nuxt-module-builder) for more information.
|
||||
::
|
33
packages/nuxi/src/commands/build-module.ts
Normal file
33
packages/nuxi/src/commands/build-module.ts
Normal file
@ -0,0 +1,33 @@
|
||||
import { execa } from 'execa'
|
||||
import consola from 'consola'
|
||||
import { resolve } from 'pathe'
|
||||
import { tryResolveModule } from '../utils/cjs'
|
||||
import { defineNuxtCommand } from './index'
|
||||
|
||||
const MODULE_BUILDER_PKG = '@nuxt/module-builder'
|
||||
|
||||
export default defineNuxtCommand({
|
||||
meta: {
|
||||
name: 'build-module',
|
||||
usage: 'npx nuxi build-module [--stub] [rootDir]',
|
||||
description: `Helper command for using ${MODULE_BUILDER_PKG}`
|
||||
},
|
||||
async invoke (args) {
|
||||
// Find local installed version
|
||||
const rootDir = resolve(args._[0] || '.')
|
||||
const hasLocal = tryResolveModule(`${MODULE_BUILDER_PKG}/package.json`, rootDir)
|
||||
|
||||
const execArgs = Object.entries({
|
||||
'--stub': args.stub
|
||||
}).filter(([, value]) => value).map(([key]) => key)
|
||||
|
||||
let cmd = 'nuxt-module-build'
|
||||
if (!hasLocal) {
|
||||
consola.warn(`Cannot find locally installed version of \`${MODULE_BUILDER_PKG}\` (>=0.2.0). Falling back to \`npx ${MODULE_BUILDER_PKG}\``)
|
||||
cmd = 'npx'
|
||||
execArgs.unshift(MODULE_BUILDER_PKG)
|
||||
}
|
||||
|
||||
await execa(cmd, execArgs, { preferLocal: true, stdio: 'inherit', cwd: rootDir })
|
||||
}
|
||||
})
|
@ -5,6 +5,7 @@ const _rDefault = (r: any) => r.default || r
|
||||
export const commands = {
|
||||
dev: () => import('./dev').then(_rDefault),
|
||||
build: () => import('./build').then(_rDefault),
|
||||
'build-module': () => import('./build-module').then(_rDefault),
|
||||
cleanup: () => import('./cleanup').then(_rDefault),
|
||||
clean: () => import('./cleanup').then(_rDefault),
|
||||
preview: () => import('./preview').then(_rDefault),
|
||||
|
Loading…
Reference in New Issue
Block a user