简介

Ace 是 AdonisJS 用于创建和运行控制台命令的命令行框架。Ace 的入口文件存储在项目根目录中，您可以按如下方式执行它。

node ace

由于 node 二进制文件不能直接运行 TypeScript 源代码，我们必须将 ace 文件保持为纯 JavaScript 并使用 .js 扩展名。

在底层，ace.js 文件将 TS Node 注册为 ESM 模块加载器钩子 来执行 TypeScript 代码并导入 bin/console.ts 文件。

帮助和列出命令

您可以通过运行 ace 入口文件而不带任何参数或使用 list 命令来查看可用命令列表。

node ace

# 与上面相同
node ace list

您可以通过输入命令名称加上 --help 标志来查看单个命令的帮助。

node ace make:controller --help

TIP

帮助屏幕的输出按照 docopt 标准格式化。

启用/禁用颜色

Ace 会检测其运行的 CLI 环境，如果终端不支持颜色，则会禁用彩色输出。但是，您可以使用 --ansi 标志手动启用或禁用颜色。

# 禁用颜色
node ace list --no-ansi

# 强制启用颜色
node ace list --ansi

创建命令别名

命令别名提供了一个便利层，用于为常用命令定义别名。例如，如果您经常创建单数资源控制器，可以在 adonisrc.ts 文件中为其创建别名。

{
  commandsAliases: {
    resource: 'make:controller --resource --singular'
  }
}

定义别名后，您可以使用别名来运行命令。

node ace resource admin

别名扩展如何工作？

• 每次运行命令时，Ace 都会检查 commandsAliases 对象中的别名。

• 如果存在别名，第一段（空格之前）将用于查找命令。

• 如果命令存在，别名值的其余段将附加到命令名称后。

  例如，如果您运行以下命令

  node ace resource admin --help

  它将扩展为

  make:controller --resource --singular admin --help

以编程方式运行命令

您可以使用 ace 服务以编程方式执行命令。ace 服务在应用程序启动后可用。

ace.exec 方法接受命令名称作为第一个参数，命令行参数数组作为第二个参数。例如：

import ace from '@adonisjs/core/services/ace'

const command = await ace.exec('make:controller', [
  'user',
  '--resource',
])
    
console.log(command.exitCode)
console.log(command.result)
console.log(command.error)

您可以使用 ace.hasCommand 方法在执行命令之前检查命令是否存在。

import ace from '@adonisjs/core/services/ace'

/**
 * boot 方法将加载命令（如果尚未加载）
 */
await ace.boot()

if (ace.hasCommand('make:controller')) {
  await ace.exec('make:controller', [
    'user',
    '--resource',
  ])
}