入門編の増補と、本文とPHPファイルの整合性チェック

[zonuexe]

概要

入門編 (beginner) を増補し、あわせて Markdown 本文と PHP ファイル・PHPStan の実際の出力が矛盾しないようにする仕組みを追加しました。

入門編の増補

• 1.5. 「型は追跡され、追跡できなくなると広がる」を独立した節・ファイル (beginner/1.5.php) として追加。定数型 (5, 6) と整数範囲型 (int<0, max>, positive-int) を dumpType() で体感する
• 各スクリプトと解答例に use function PHPStan\dumpType; / assertType; を追加。§1 の TIP で「dumpType() とも書けるが、本文は \PHPStan\dumpType() で統一する」と明記
• 2. 「エラーメッセージを読む」小節を追加。初期状態の4エラーを1つずつ読み下し、mixed の意味、レベル (Playground の Level 10)、エラー識別子を紹介
• 3. Author/Book クラスの掲載と TIP (コンストラクタプロモーション / readonly class / non-empty-array)、「ほかの絞り込み方」小節 (比較演算子 → int<1, 100>、is_string() → mixed から string)、!$word が non-falsy-string になる注意
• 各演習の IMPORTANT に解答例へのリンクを追加、修了時のまとめを更新

整合性チェックの仕組み (composer check)

tools/check-docs.php が README のコードブロックを検査します。詳細は CONTRIBUTING.md。

• ```php file=3.php — ブロックが演習ファイルの連続する行と一致すること (タブ/スペース差は無視、// ... で省略可)
• ```php phpstan — ブロック単体を PHPStan で解析
• // DumpedType: X / // Error: message 注釈 (行末または直前行) が実際の出力と過不足なく一致すること
• answers/**/*.php が単体でエラーなしであること
• README 内の相対リンク先が存在すること

.github/workflows/check.yml で PR/push 時に実行します。

解答例 answers/

answers/beginner/2.php のように配置しました。演習ファイルと同じディレクトリに置くと phpstan analyse の一括実行で label() や Book の定義が衝突して誤検出が出るため (excludePaths で除くと今度は明示指定でも解析されない)、paths 外に置いています。

Playground リンクの検査・更新 (tools/playground.php)

Playground の Share ボタンと同じ API (POST https://api.phpstan.org/analyse + saveResult: true) を叩き、GET /sample?id= で保存内容を照合します。

• composer check-playground — リンク先サンプルのコード・設定がローカルの演習ファイルと一致するか (読み取りのみ、CI で実行)
• composer update-playground — 不一致/TODO のリンクを新規発行して README を書き換え (--dry-run あり)

全節のリンクを再生成済みです (Level 10, bleedingEdge オン, strictRules オフ = ローカル設定と同じ)。

TODO (Draft の理由)

• 各節の PHPStan Playground リンクを再生成する
• 文言のレビュー

動作確認

$ composer check
[OK] No errors        # tools/ を level max で解析
[OK] 33 checks passed # 本文と PHP ファイルの整合性