Composer scripts あれこれ

Tweet

Custom descriptions | Scripts – Composer

scripts-descriptions を定義すればOK。

{
    "scripts": {
        "test": "phpunit"
    }
    "scripts-descriptions": {
        "test": "Run all tests!"
    }
}

デフォルトでは300secなので、Codeceptionの受け入れテスト等、時間のかかるスクリプトは以下のようなタイムアウトエラーが出る。

  [Symfony\Component\Process\Exception\ProcessTimedOutException]
  The process "codecept run" exceeded the timeout of 300 seconds.

run-scriptコマンドのオプション--timeout、または環境変数のCOMPOSER_PROCESS_TIMEOUTを使用する。

# OK
composer run-script test --timeout=0
# OK runはrun-scriptの短縮形
composer run test --timeout=0
# NG timeoutオプションを指定する場合は、run-scriptを省略することはできない
composer test --timeout=0
# OK 環境変数のCOMPOSER_PROCESS_TIMEOUTを使用してもよい
COMPOSER_PROCESS_TIMEOUT=1 composer test

composer.jsonにprocess-timeoutを設定してもよいが、こちらはrun-script以外にもinstallやupdate等、composerコマンド全体で使用されるので注意。

-- の後に呼び出しコマンドに追加したいオプションを書く

# "cs-check": "phpcs" のとき以下で phpcs -n src/ の実行となる
composer cs-check -- -n src/