PHPでの .gitattributes

PHP を使ったライブラリやアプリケーションでの .gitattributes ～ composer で配布の時に気を使って欲しい点

Transcript

1. PHPでの .gitattributes @sasezaki 第185回 PHP勉強会＠東京
2. 宣伝 sfp-phpstan-psr-log はおかげさまで 25万ダウン ロード！みんな⼊れてクレメンス🤖
3. PHP を使ったライブラリや アプリケーションでの .gitattributes ～ composer で配布の時に 気を使って欲しい点
4. 2011年の話の続きをします。
5. (PHP のほうの) Composer とは https://getcomposer.org/doc/00-intro.md
6. Composer is not a package manager in the same sense as Yum or Apt are. Yes, it deals with "packages" or libraries, but it manages them on a per-project basis, installing them in a directory (e.g. vendor) inside your project. By default, it does not install anything globally. Thus, it is a dependency manager. It does however support a "global" project for convenience via the global command.
7. Composer is not a package manager in the same sense as Yum or Apt are. Yes, it deals with "packages" or libraries, but it manages them on a per-project basis, installing them in a directory (e.g. vendor) inside your project. By default, it does not install anything globally. Thus, it is a dependency manager. It does however support a "global" project for convenience via the global command. Composer は、Yum や Apt と同じ意味でのパッケージマネージャーでは ありません。確かに「パッケージ」やライブラリを扱いますが、それらはプ ロジェクト単位で管理され、プロジェクト内のディレクトリ（例：vendor）に インストールされます。デフォルトでは、グローバルには何もインストール しません。そのため、Composer は依存関係マネージャー です。ただし、 global コマンドを通じて「グローバル」プロジェクトもサポートしていま す。
8. Composer は、Yum や Apt と同じ意味でのパッケージマネー ジャーではありません。確かに「パッケージ」やライブラリを扱いますが、それら はプロジェクト単位で管理され、プロジェクト内のディレクトリ（例： vendor）にインストールされます。デ フォルトでは、グローバルには何もインストールしません。そのため、 Composer は依存関係マネー ジャーです。ただし、global コマンドを通じて「グローバル」プロジェクトもサポートしています。
9. Composer はパッケージ を主眼 にしたツールではない と言える
10. 現代のパッケージングを意識しないディストリビュート 1. composer.json をおきます 2. packagist にgithubのURLを登録します 3. 完成！ ね、簡単でしょ？
11. vendorにインストールされる、zip の中身の例
12. ほとんどのファイル要らないね！
13. ほとんどのファイル要らないね！ - vendor 配下の容量が圧迫される - コンテナイメージでのサイズも肥大化する - 下手をすると、テストだけのクラスがautoloadの対象になったり と、ザ☆無駄。 - CI環境が高度に整った現在において、利用者側がテストを実行し たりする必要はないし、デモファイルもライブラリとして利用すると きはコードが参照することはない。 → エクスポートに含めない様にしよう！
14. composer は、GitHub ならびに Git と 密接な関係なため、インストール実行時は ほぼほぼ `git archive` なものが vendor に ダウンロードされます。 （要するに `--prefer-source` ではなく 　`--prefer-dist` のとき）
15. ほとんどのファイル要らないね！ → .gitattributes での export-ignore があるね！ https://git-scm.com/book/ja/v2/Git-のカスタマイズ-Git-の属性
16. .gitattributesでの export-ignore設定前 (例)
17. .gitattributesでの export-ignore設定時 (例)
18. `.gitattributes` で export-ignoreでテストファイルを含めないように しようね！の呼びかけは１０年以上前からあります https://madewithlove.com/blog/gitattributes/
19. `.gitattributes` で export-ignoreでテストファイルを含めないようにしようね！の呼びかけは１０年以上前から あります ど、どうして.... ※ AI slopなPRじゃないです。（手作業 )
20. export-ignoreはまだまだ設定されてなかったり、見直しが必要 だったりする - ほかの言語でのエコシステムなどと比較して、composer 特有のだったりす るので、広くプラクティスとして広まってはない - 拒否リスト方式で個別に指定した場合、追加のファイルで漏れが出てくる 　 (例: phpstan.neon, .php_cs → .php-cs-fixer.php でのリネーム) - README.md を含めるかは一考の余地あり - https://github.com/doctrine/dbal/pull/7272 の話を受けて、個人的に は不要だと思います - 今回のPR群では、疑問に思われそうだったのでignore指定するの避けちゃっ たけど.... - …それでもSymfonyのモノレポなら...SymfonyならCIが良い感じに設定さ れている気がする！ - → 漏れてました。m9(^Д^)ﾌﾟｷﾞｬｰ
21. ※ちなみに - composer の archiveオプションでも exclude指定はあります https://getcomposer.org/doc/04-sch ema.md#archive
22. みなさんも vendor/ 以下眺めて不要そうなファイルや ディレクトリがあったら、.gitattributes の export-ignore 変更提案 (Pull Request / Issues) を出してみてくださ い。
23. おまけ①
24. 原始の時代、小鳥たちはさえずり、人々は洋 ナシをパッケージにつめ 、自前のサーバー に設置することに勤しんでいた
26. どのファイルを包むか ちゃんと定義してる！
27. 「俺はパッケージングに帰って来たんだー」 完
28. ほそく
29. PHPとかの初心者向け 今日の話はライブラリ作成が10段階でレベル5ぐらいの話をしてます。 （その前にすることが色々ある）
30. おまけ②
31. .gitattributes には、 export-ignore属性のほかに 改行コードの扱いについての指定 例) 言語情報を指定 例) ※ https://github.com/github-linguist/linguist/blob/main/lib/linguist/languages.yml など色々あります *WinTest.inc text eol=crlf *.stub linguist-language=PHP
32. おまけ③
33. 「こういうパッケージに関するプラクティスのため のツールなり、skill なりあれば良いのでは？」
34. 「こういうパッケージに関するプラクティスのためのツールなり、skill なりあ れば良いのでは？」 あるっちゃ、ある。 あるけど...