# @adonisjs-community/modules 中文文档

规范地址：https://npmcn.com/package/%40adonisjs-community/modules/

版本：2\.0\.0
npm 元数据更新时间：2026-05-22T12:28:39.538Z
中文译文更新时间：2026-11-06T20:00:52.996Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40adonisjs-community/modules
原文对照：https://npmcn.com/package/%40adonisjs-community/modules/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：57.1 kB，60 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.0\.0
- 运行依赖：0 个
- peer 依赖：@adonisjs/core ^7\.0\.0-next\.23
- 首次发布：2025-06-08T13:28:57.394Z
- 最新版本发布：2026-05-22T12:28:39.407Z
- 近 30 天下载量：2410（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 1 个）

## 中文简介

> 一个简单和工学的方法 脚手架 你的AdonisJS项目!

## 安装

```sh
npm install @adonisjs-community/modules
```

也可以使用：`pnpm add @adonisjs-community/modules`、`yarn add @adonisjs-community/modules`、`bun add @adonisjs-community/modules`

## README

# 模块

> 一个简单和工学的方法 脚手架 你的AdonisJS项目!

## 导言

`@adonisjs-community/modules` 提供基于 `adonisjs/core` 命令,帮助您将您的 AdonisJS 项目快速切入模块 _(更准确地输入基于特征的子目录)_。 。 。 . 这使得您可以模块化地组织您的代码,从而更容易维护并缩放您的应用程序.

```
├── app
│  ├── auth
│  │  ├── controllers
│  │  ├── services
│  │  └── models
│  └── users
│     ├── exceptions
│     ├── factories
│     └── validators

```

## 安装

您可以使用下列命令在您的 AdonisJS 项目中安装模块 :

```bash
node ace add @adonisjs-community/modules
```

## 开始

安装后,您可以使用 `make:module` 命令 :

```bash
node ace make:module auth
```

这将创建一个命名的新模块 `auth` 输入 `/app` 目录,以及在您的软件包中注册路径解析度的新别名. json 文件:

```json
{
  "imports": {
    "...",
    "#auth/*": "./app/auth/*.js"
  }
}
```

## 就这样!

你现在可以重新使用 `@adonisjs/core` 财务报告和审定财务报表 `@adonisjs/lucid` `make` 带有旗帜的命令 `-m (--module)` 在模块中创建控制器、模型、视图等。 例如:

```bash
node ace make:controller sign_in -m=auth
node ace make:controller sign_in --module auth
```

此命令将创建一个名为的新控制器文件 `sign_in_controller.ts` 输入 `auth` 模块.

此时,您可以参考 [AdonisJS 命令文档](https://docs.adonisjs.com/guides/references/commands#makecontroller) 以便更多地了解可用的命令以及如何使用这些命令.

## 特殊性(`@adonisjs/lucid`(中文(简体) )

使用时 `@adonisjs/lucid` 命令,也可以指定要创建模型、迁移和工厂的模块.

因此,当生成一个模型时 `-m` 化名不会起作用,因为此化名已经用于指定代码mods是否为模型生成迁移.

最后一点要指出,产生的迁移将放在 `database/migrations` 目录而不是模块目录。 这是因为对应用的迁移是全球性的,而不是一个模块特有的. 因此,执行的顺序很重要,并且把它们放在一个单一的目录中可以让你更容易地管理它们.

## 许可证

模块是开源软件,根据 [麻省理工学院许可证](https://npmcn.com/package/%40adonisjs-community/modules/LICENSE.md)。 。 。 .

## 捐款

我们欢迎对模块一揽子计划的贡献! 如果您有想法、建议或改进意见,请随意提出问题或拉动请求.

## 常见问题

### @adonisjs-community/modules 是什么？

一个简单和工学的方法 脚手架 你的AdonisJS项目\!

### 如何安装 @adonisjs-community/modules？

在项目目录运行 npm install @adonisjs-community/modules，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@adonisjs/core（^7\.0\.0-next\.23）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @adonisjs-community/modules 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/adonisjs-community\_\_modules 是否存在。

### @adonisjs-community/modules 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @adonisjs-community/modules 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @adonisjs-community/modules 可以商用吗？

@adonisjs-community/modules 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @adonisjs-community/modules 的下载量有多少？

根据 npm 官方下载统计，@adonisjs-community/modules 在 2026/10/05 – 2026/11/03 这 30 天内被下载 2,410 次，日均约 80 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @adonisjs-community/modules 还在维护吗？

最新版本 2\.0\.0 发布于 2026/05/22（5 个月前）；至今共发布 3 个版本，其中过去 12 个月发布了 1 个；首次发布于 2025/06/08。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。