docs: 仕様書の集約 export コマンドと鮮度チェック CI を追加 (#6906)

[ttokoro20240902]

概要(Overview・Refs Issue)

Refs #6906（Phase B / 戦略資料 §8.2）。#6909（Phase A）にスタックした PR（base = docs/spec-readme-colocation）。全 README.html を集約・出力する基盤と、顧客提出向けフィルタ、鮮度維持の CI を実装します。

• eccube:docs:export コマンド（--filter=all|customer）＋ DocsExportService。全 README.html を出力先へ集約し、--filter=customer で data-customer="true" の章だけを残す。
• 鮮度維持 CI（docs-check）: アプリ起動不要の軽量チェッカー .github/bin/check-readme-docs.php。

静的サイト化・本番公開先（サブドメイン／doc4 との統合を含む）は未確定のため、本 PR には含めず Issue #6906 で検討します。顧客提出 PDF は出力 HTML のブラウザ印刷で派生。

方針(Policy)

• 責務分離: HTML 走査・section フィルタは DocsExportService に集約し、コマンドは薄い入口に（Skill command 準拠）。
• section フィルタは自己完結 HTML の整形・UTF-8 を保持（DOMDocument の数値実体参照化を避け、開始タグの属性のみで判定＝本文が属性名に言及しても誤判定しない）。
• 各 README.html は自己完結 HTML なので、ローカル閲覧・配布はビルド不要でそのまま開ける。静的サイト化の要否・本番公開先・doc4 との統合方針は Issue [4.4] コード近接の人間向け仕様ドキュメント（README.html）と静的サイト/PDF 化 — 実装設計 #6906 で継続検討（この PR はコマンドと鮮度 CI まで）。

実装に関する補足(Appendix)

• CI docs-check はアプリ起動不要の軽量チェック（.github/bin/check-readme-docs.php）。README/ドキュメント変更時のみ実行し、次を検出:
  • README.html 各 <section> の data-section/data-customer 属性欠落
  • README.html/README.md の相対リンク切れ
  • ルート README.html（ポータル）が全 README.html を列挙しているか（TOP ページの追従漏れ）
• PR テンプレートに「README.html/README.md 更新漏れ」チェック項目を追加。
• eccube:docs:export をコアのコマンド一覧（src/Eccube/Command/README.html）へ掲載。

テスト（Test）

• PHPUnit 6 件（DocsExportServiceTest）: customer フィルタで dev 章除去・customer 章保持、構造保持、文字化け防止、除外ディレクトリ、未知フィルタ例外、本文が属性名に言及しても除去。
• QA: php-cs-fixer / rector（dry-run 差分なし）/ phpstan level 6 / phpunit すべて通過。
• bin/console eccube:docs:export --filter=customer を end-to-end 実行し、出力・dev 章除去・文字化けなし・整形保持を確認。
• docs-check CI がグリーン（section 属性・リンク・ポータル列挙）。

🤖 Generated with Claude Code

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 575d17c7-dbc7-4747-94d0-ae8818830503

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/spec-static-site

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.56%. Comparing base (10b9615) to head (f2315a7).

Additional details and impacted files

@@                       Coverage Diff                       @@
##           docs/spec-readme-colocation    #6910      +/-   ##
===============================================================
- Coverage                        75.66%   75.56%   -0.11%     
===============================================================
  Files                              541      523      -18     
  Lines                            26751    25636    -1115     
===============================================================
- Hits                             20241    19371     -870     
+ Misses                            6510     6265     -245     

Flag	Coverage Δ
Unit	75.56% <100.00%> (-0.11%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[nanasess]

https://doc.ec-cube.net/ は3系のドキュメントサイトなので、紛らわしいサブドメインは避けたいですね。
doc4 と統合するとか難しそうですよね

[ttokoro20240902]

@nanasess
ご指摘ありがとうございます。おっしゃるとおり docs.ec-cube.net は 3系の doc.ec-cube.net と紛らわしいので、新しいサブドメインは作らない方針にします。

本 PR からは公開先の記述を外し、既存の doc4.ec-cube.net に相乗りできないか（例: doc4.ec-cube.net/spec/）を Issue #6906 に検討事項として追加しました。doc4 は Jekyll なので、自己完結 HTML をそのまま配信できそうです。