模块

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

导言

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

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

安装

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

node ace add @adonisjs-community/modules

开始

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

node ace make:module auth

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

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

就这样!

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

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

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

此时,您可以参考 AdonisJS 命令文档 以便更多地了解可用的命令以及如何使用这些命令.

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

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

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

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

许可证

模块是开源软件,根据 麻省理工学院许可证。 。 。 .

捐款

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