Composerを便利に使うために私がやっていること #phperkaigi

PHPerKaigi 2024でのLT資料です
https://fortee.jp/phperkaigi-2024/proposal/e4485a45-5a69-4cce-9635-c0eca88be6db

Transcript

1. Composerを便利に使うために 私がやっていること PHPerKaigi 2024 / LT Hideki Kinjyo GitHub: o0h / X: @o0h_ [公開用] v1.1.1
2. 自己紹介 • 金城秀樹 / きんじょうひでき • GitHub:@o0h / Twitter:@o0h_ • 好きなFWはCakePHP • アイコンは 美味しい鮭親子丼の写真です • パンフレット記事も寄稿しています！ ありがとうございます！
3. 今日のお話 • よく使う道具だから、少しでも便利に使えると良いですね！ • 個人的にやっている、 「手を抜いたり安心して使う」ためによく使いがちな方法を 共有しに来ました！！！ • パッパとtipsを話していきます 
4. composer-bin-plugin
5. composer-bin-plugin • ざっくりいうと「vendorディレクトリを増やせる」ようなもの • そうすると、 「依存パッケージが指定しているバージョンがコンフリクトする」 みたいな状況を避けられる！ﾔｯﾀｰ • 開発系のツールなどに利用するといい感じになりそう • 「別のパッケージのせいで」とか「プロダクトコードのために」を理由に、 新しくて便利な開発ツールを入れられない・・・・とｻﾖｳﾅﾗ！
6. まずはプラグインをrequire  composer require —dev bamarni/composer-bin-plugin
7. で、パッケージ「***」を設置 ※ $名前空間 = 任意の名前。これが設置されるディレクトリ名になる  composer bin $໊લۭؒ require ***
8. `vendor-bin`ディレクトリと、 その下に$名前空間ごとのディレクトリが掘られている様子 
9. で、その名前空間の下でComposerが叩ける！！  comoser bin $໊લۭؒ $αϒίϚϯυ
10. composer.json>configに 書いておきたい設定
11. PJの設定 • `composer.json`内の`config`、意識して設定していますか？ • diffが出にくくなったりCIで便利になる設定もあるので、オススメ！
12. 私の好きな設定項目たち • `sort-packages`: require/require-devの項目を名前順に揃える • デフォルト(false)だと末尾追記。見やすくなってノリも揃って気持ち良い〜
13. 私の好きな設定項目たち • `sort-packages`: require/require-devの項目を名前順に揃える • `platform`: PHPのランタイムや拡張の情報を上書きする • 例えば「`require` に `php:8.2.3` が指定されている」状態の時に、 「PHPStanを実行するCIは、最新のバージョンのPHPを使っている」 • config.platformを書くことで、 「特定のPHP環境で動いているとみなして、install等をしてOK」になる！ • ؔ࿈: `--ignore-platform-req=ext-foo` ͰͷґଘνΣοΫແࢹ
14. 私の好きな設定項目たち • `sort-packages`: require/require-devの項目を名前順に揃える • `platform`: PHPのランタイムや拡張の情報を上書きする • `cache-dir`: Composerのキャッシュ格納先を指定する • デフォルトだと `$HOME/.composer/cache` など • 「キャッシュをDockerコンテナに突っ込みたいな〜」という時にいじったり
15. 私の好きな設定項目たち • `sort-packages`: require/require-devの項目を名前順に揃える • `platform`: PHPのランタイムや拡張の情報を上書きする • `cache-dir`: Composerのキャッシュ格納先を指定する • `optimize-autoloader`/`apcu-autoloader`: autoloadを速くする • オートロード用の静的なクラスマップを作る /キャッシュをAPCuに乗せる。 • optimize〜〜は、`—o` オプションと同等。 dumpが遅くなるので開発時には外したい・・・は、オプションを使った方が◎
16. config.jsonに書いておきたい設定
17. globalなデフォルト設定値を記憶 • 自分の環境におけるデフォルト設定を保持するのが、 `$COMPOSER_HOME/config.json` • ここで俺俺カスタマイズを入れるすぎるのも微妙ですが・・ • PJで他のメンバーと共有するために `$PJ/composer.json` に書いた方が 便利な事の方が多い • モノによっては、設定しておくことで 「何度も同じことを聞かれる〜〜」とかの煩わしさが軽減します
18. 例えば・・・ • `github-oauth`: GItHubのAPIを利用するためのトークンを保持
19. 例えば・・・ • `github-oauth`: GItHubのAPIを利用するためのトークンを保持 • `use-parent-dir`: サブディレクトリでComposerコマンドを打ったと きに `No composer.json in current directory, do you want to use the one at ***?` と聞かれなく出来る • 自分はfalseにしてる
20. 例えば・・・ • `github-oauth`: GItHubのAPIを利用するためのトークンを保持 • `use-parent-dir`: サブディレクトリでComposerコマンドを打ったと きに `No composer.json in current directory, do you want to use the one at ***?` と聞かれなく出来る • 自分はfalseにしてる • 他の項目に関しては https://getcomposer.org/doc/06-config.mdを参照！
21. 嬉しいコマンド: show depends prohibits
22. show • `composer show`もしくは `composer info` • パッケージ自体や依存パッケージ情報の表示
23. show / show —locked • オプション無しだと インストール済みパッケージ • = `vendor`にあるパッケージ • `--locked` で composer.lockを見に行く
25. show -s • `-s` で、そのPJ自身の情報 • sはselfのs
27. show -t • `-t` で依存をツリー表示
29. show $package • パッケージ名を渡すと そのパッケージの情報
31. show $package • ワイルドカードの利用もOK • PSR何使ってるの〜〜！？ とか出来る
33. depends / why • 指定したパッケージに依存をしているパッケージの表示 • `why`はエイリアスとして設定されている
34. depends $package • `show` と合わせて使ったり • 「間接依存なら、エイッて上 げちゃって良いか！！」って 勇気をもらったり • `-t` で、 ツリー表示もできるぞ！
36. prohibits / why-not • 「なぜ、指定したバージョンを使えないのか」を調べる • いつもスペルとか忘れてエイリアスの `why-not` 使いがち
37. prohibits / why-not • 「このパッケージの、この バージョンが入らん。何 で？？」を尋ねるように • `conflicts` と出たら 解決してあげる(か諦める) • `-t` オプションもある • 色がついて見やすい
39. 皆さんの好きなコマンドも、 SNSなどでつぶやいてみてくださいね！ #phperkaigi
40. バージョン指定: @stable
41. @stable / @dev • 「雑に最新版をいれる」という時に、 semverの代わりに `@stable` を指定することができる • かなり使い道が限られそう・リスクもあるけれど • 公式のFAQで警告される程度にはリスキー(BAD IDEA) https://getcomposer.org/doc/faqs/why-are-unbound-version-constraints-a-bad-idea.md • バージョンが無軌道に上がったりするし、他に巻き込まれて下がったりもする • それを承知できる(?)人なら • comoposer.lockで細かいバージョン管理をしっかり行う前提で • require-devやglobalにいれるツールくらいでなら、 使っても良いんじゃない？？という気も
42. Packagist Semver Checker
43. Packagist Semver Checker • https://semver.madewithlove.com/ • 「このパッケージにこういうバージョン指定をしたら、何が入る？」 をチェックできるサイト
44. Packagist Semver Checker • Packagistに登録されている パッケージ&バージョンで 該当範囲を試せる • ʙ とʈの違いとか一目瞭然 • パッチバージョンの記述の 違いとか
46. まとめ
47. Composer、上手く使って 嬉しいな • 公式ドキュメントの、CLI・configのところは一読をオススメします！ • 詳しい情報があるので！ • 色々なプラグインも探ってみましょう！ • Packagistでタグ検索とかすると良いかも？ • バージョンアップで良い機能もたくさん入ってくるので、 リリース情報をチェックしましょう！ • 2.7で入った `--minimal-changes` オプションとか、私は好きですよ
48. おしまい！ お付き合いいただき ありがとうございました!!