2023.08.15
【PHP】Composerのよく使うコマンド一覧

David MarkによるPixabayからの画像

はじめに

composerでよく使うコマンドの一覧です。

コマンド一覧

composer自体のアップデート

composer self-update

composer.jsonの新規作成

composer init        ←対話形式で作成する場合
composer init --quiet  ←空のcomposer.jsonを作成する場合

※composer.jsonにname,description,licenseは必須なので、空のファイルを作成した際には追記する必要があります。

composer.jsonに記載の全パッケージをインストール

composer install      ←全パッケージをインストール
composer install --no-dev  ←require-devに記載のもの以外全てをインストール

composer.jsonに従いパッケージ、依存関係を更新

composer update     ←全パッケージを更新
composer update --no-dev ←require-devに記載のもの以外全てを更新

※初回のパッケージインストール時のみ「composer install」を使い、以降composer.jsonを更新したら「composer update」を使用します。

パッケージのインストール

package.jsonを書き換えなくても、コマンドでパッケージをインストールすることができます。

composer require [vendor]/[package]:[version]
composer require --dev [vendor]/[package]:[version]

例)composer require panique/php-sass:1.*

※どんなパッケージがあるか調べたい場合はこのページで検索してみてください。
 https://packagist.org/

インストール済みパッケージを一覧表示

composer show        ←require,require-devの全パッケージを表示
composer show --no-dev    ←requireの欄のパッケージのみ表示
composer show [パッケージ名] ←パッケージの詳細情報を確認

パッケージの削除

composer.jsonを書き換えず、コマンドでパッケージを削除したい場合に使うコマンドです。

composer remove [vendor]/[package] ←1つのパッケージを削除

composer remove [vendor1]/[package1] [vendor2]/[package2] ←複数同時に削除

インストール済みパッケージの最新バージョンを確認

composer outdated

パッケージがインストールされた理由を確認する

composer depends [パッケージ名]

※同じ挙動をするコマンドとして「composer why [パッケージ名]」もあります。

composer.json、composer.lockの文法チェック

composer validate

キャッシュのクリア

composer clear-cache

※composerでダウンロードしたパッケージは自動でキャッシュされます。

composerコマンド一覧を表示

composer list

コマンドの使い方を確認

composer help [コマンド]

p

便利なオプション

以下は上にまとめたコマンドにくっつけて使う便利なオプションです。

グローバル環境の操作:global

パッケージはプロジェクト毎に管理するものが多いですが、Laravelを代表とするフレームワークなどグローバル環境で使うものもあります。

グローバル環境は、オプションの「global」をつけて操作します。

例)composer global show

composer.json、composer.lockの変更なしにコマンドを試す:–dry-run

例)composer install --dry-run

パッケージのバージョン指定

以下は、package.jsonを書く際やcomposer requireコマンド使用時にパッケージのバージョン指定の書き方です。

ワイルドカード:*

意味:「*」以外は固定する

例)1.1.*

※赤字部分が固定されます。

チルダ:~

意味:最後の桁以外を固定する

例)~1.1
例)~1.1.1

※赤字部分が固定されます。

ハット:^

意味:0以外で始まる最初の桁までを固定する

例)^1.1.1
例)^0.1.1

※赤字部分が固定されます。