🌿

Composerのdump-autoloadは--no-devの指定をどう判断しているのか

に公開

はじめに

Composerで本番環境向けに依存パッケージをインストールするとき、--no-devオプションを指定することがあります。

composer install --no-dev

そのあとに、次のコマンドを実行したとします。

composer dump-autoload

dump-autoloadコマンドには--no-devを指定していませんが、開発用のオートロード設定(autoload-dev)は除外されたままでした。

なぜ、このような動作なるのか気になったので、Composerの公式ドキュメントとソースコードを確認してみました。

環境

  • PHP 8.5.12
  • Composer 2.10.3

公式ドキュメントを確認する

まず、Composerの公式ドキュメントを確認します。

https://getcomposer.org/doc/03-cli.md#dump-autoload-dumpautoload

dump-autoloadコマンドの--dev及び--no-devオプションには次の説明があります。

Composer will by default infer this automatically according to the last install or update --no-dev state.

どちらも、最後のinstallまたはupdateで指定された--no-devの状態から自動的に判断される、と書かれています。

つまり、dump-autoloadコマンドは--dev及び--no-devオプションが指定されていない場合、直前の状態で判断しているようです。

直前の状態で判断とは?この辺りはソースコードから読み解いていく方がよさそうです。

ソースコードを確認する

Composerのソースコードを確認します。

dump-autoloadコマンドのDumpAutoloadCommandクラスの処理を順番に追いかけていくとAutoloadGeneratorクラスのdump()メソッドに次の処理があります。

https://github.com/composer/composer/blob/2.10.3/src/Composer/Autoload/AutoloadGenerator.php#L184-L196

この処理を見ていきます。

1. devModeが未指定か確認する

if (null === $this->devMode) {

最初に、$this->devModeがnullかどうかを確認しています。

$this->devModeがnullの場合は自動判定に進みます。

null以外の場合、--dev及び--no-devが明示的に指定されているため、自動判定の処理には入りません。

この$this->devModeに値を設定するのは、DumpAutoloadCommandクラスで行なっています。

https://github.com/composer/composer/blob/2.10.3/src/Composer/Command/DumpAutoloadCommand.php#L102-L110

2. installed.jsonを読み込む

// we assume no-dev mode if no vendor dir is present or it is too old to contain dev information
$this->devMode = false;

$installedJson = new JsonFile($config->get('vendor-dir').'/composer/installed.json');
if ($installedJson->exists()) {
    $installedJson = $installedJson->read();

    if (isset($installedJson['dev'])) {
        $this->devMode = $installedJson['dev'];
    }
}

次に、vendor/composer/installed.jsonを読み込んでいます。

ファイルの存在確認を行なってから、installed.jsonの devの値を取得しています。

この値が存在する場合、$this->devModeに値を設定しています。

つまり、--dev及び--no-devオプションを指定していない場合は、installed.jsonのdevの値を使って判断していることになります。

installed.jsonのdevにはどんな値が入る?

installコマンドを実行するとInstallCommandクラスが動くのでみてみると以下で --no-devオプションを取得し、設定していることがわかります。

https://github.com/composer/composer/blob/2.10.3/src/Composer/Command/InstallCommand.php#L136

このsetDevModeメソッドを確認してみると引数の型はbool型になっていました。

https://github.com/composer/composer/blob/2.10.3/src/Composer/Installer.php#L1381-L1389

つまり、--no-devオプションがあればfalse、なければtrueを設定しています。
※!$input->getOption('no-dev')と!がついているので意味が逆転します。

このあとの処理を順番に見ていきます。

https://github.com/composer/composer/blob/2.10.3/src/Composer/Command/InstallCommand.php#L152

https://github.com/composer/composer/blob/2.10.3/src/Composer/Installer.php#L327

https://github.com/composer/composer/blob/2.10.3/src/Composer/Installer.php#L876

最終的な書き込みは以下の場所で行われていました。

https://github.com/composer/composer/blob/2.10.3/src/Composer/Installer/InstallationManager.php#L238

ここまでの間で設定した値は書き換わっていないので、installed.jsonのdevにはbool値が入っていることがわかります。

この値をdump-autoloadコマンドが読み取ることで、開発用のオートロード設定を含めるかどうかが決まるようです。

まとめ

dump-autoloadコマンドはinstalled.jsonのdevの値を見て、開発用のオートロード設定を含めるかどうか判断していることがわかりました。

ソースコードを追いかけてみて、またひとつComposerのことが詳しくなれました。

GitHubで編集を提案

Discussion