nuxt module

来源
使用命令行在 Nuxt 应用中搜索、添加和移除模块。

Nuxt 提供了一些实用工具，可无缝处理 Nuxt modules。

nuxt module add

Terminal
npx nuxt module add <MODULENAME...> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--skipInstall] [--skipConfig] [--dev] [--packageManager=<npm|pnpm|yarn|bun|deno|aube|nub>]

参数

参数描述
MODULENAME...指定要按名称安装的一个或多个模块，以空格分隔

选项

选项默认值描述
--cwd=<directory>.指定 Nuxt 项目的根目录
--logLevel=<silent|info|verbose>指定构建时日志级别
--skipInstall跳过 npm 安装
--skipConfig跳过 nuxt.config.ts 更新
--dev将模块作为开发依赖安装
--packageManager=<npm|pnpm|yarn|bun|deno|aube|nub>用于安装的软件包管理器

该命令可让你无需手动操作即可在应用中安装 Nuxt modules。

运行命令时，它将：

  • 使用你的软件包管理器将模块安装为依赖项
  • 将其添加到你的 package.json 文件中
  • 更新你的 nuxt.config 文件

示例：

安装 Pinia 模块

Terminal
npx nuxt module add pinia

不指定模块名称运行该命令，即可从与你的 Nuxt 版本兼容的模块中进行选择。

nuxt add 是相同的命令，同时也接受层。

nuxt module remove

Terminal
npx nuxt module remove [MODULENAME...] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--skipInstall] [--skipConfig]

参数

参数描述
MODULENAME...指定要按名称移除的一个或多个模块，以空格分隔

选项

选项默认值描述
--cwd=<directory>.指定 Nuxt 项目的根目录
--logLevel=<silent|info|verbose>指定构建时日志级别
--skipInstall跳过依赖卸载
--skipConfig跳过 nuxt.config.ts 更新

该命令会卸载软件包，并将其从你的 nuxt.config 中的 modules 数组移除。

示例：

Terminal
npx nuxt module remove pinia

不指定模块名称运行该命令，即可从项目当前使用的模块中进行选择。

nuxt module search

Terminal
npx nuxt module search <QUERY> [--cwd=<directory>] [--nuxtVersion=<3|4|4.2.0>] [--json]

参数

参数描述
QUERY要搜索的关键词

选项

选项默认值描述
--cwd=<directory>.指定 Nuxt 项目的根目录
--nuxtVersion=<3|4|4.2.0>按 Nuxt 版本筛选，仅列出兼容的模块（默认自动检测）
--json以 JSON 格式输出结果

该命令会搜索与你的查询匹配且兼容你的 Nuxt 版本的 Nuxt modules，并显示每个模块的描述，同时突出显示匹配的文本。

示例：

Terminal
npx nuxt module search pinia

使用 --json 可获取机器可读的 JSON 格式结果。