イントロダクション

Aceは、AdonisJSがコンソールコマンドを作成および実行するために使用するコマンドラインフレームワークです。プロジェクトのルートにAceのエントリーポイントファイルが保存されており、次のように実行できます。

node ace

nodeバイナリはTypeScriptのソースコードを直接実行できないため、aceファイルを純粋なJavaScriptで保持し、.js拡張子を使用する必要があります。

内部では、ace.jsファイルはESMモジュールローダーフックとしてTS Nodeを登録し、TypeScriptコードを実行し、bin/console.tsファイルをインポートします。

ヘルプとコマンドの一覧表示

引数なしでaceエントリーポイントファイルを実行するか、listコマンドを使用して利用可能なコマンドの一覧を表示できます。

node ace

# 上記と同じ
node ace list

--helpフラグを使用して、単一のコマンドのヘルプを表示できます。

node ace make:controller --help

カラーの有効化/無効化

Aceは、実行環境がカラーをサポートしていない場合、カラフルな出力を無効にします。ただし、--ansiフラグを使用して手動でカラーを有効化または無効化することもできます。

# カラーを無効にする
node ace list --no-ansi

# カラーを強制的に有効にする
node ace list --ansi

コマンドのエイリアス作成

コマンドのエイリアスは、よく使用するコマンドのエイリアスを定義する便利なレイヤーを提供します。たとえば、単数のリソースフルなコントローラを頻繁に作成する場合、adonisrc.tsファイル内にエイリアスを作成できます。

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

エイリアスが定義されると、エイリアスを使用してコマンドを実行できます。

node ace resource admin

エイリアスの展開方法

• コマンドを実行するたびに、AceはcommandsAliasesオブジェクト内をエイリアスをチェックします。

• エイリアスが存在する場合、スペースの前のセグメントがコマンドの検索に使用されます。

• コマンドが存在する場合、エイリアスの値の残りのセグメントがコマンド名に追加されます。

  たとえば、次のコマンドを実行する場合

  Copy code to clipboard

  node ace resource admin --help
  

  それは展開されます

  Copy code to clipboard

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

プログラムでコマンドを実行する

aceサービスを使用してプログラムでコマンドを実行できます。aceサービスは、アプリケーションが起動された後に利用可能になります。

ace.execメソッドは、最初のパラメータとしてコマンド名を、2番目のパラメータとしてコマンドライン引数の配列を受け取ります。

例:

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',
  ])
}