Skip to content

chore: packages/core(store.ts と、#4401 で外した4ファイル)の無駄なコメントを消す - #4412

Merged
takecchi merged 2 commits into
mainfrom
chore/core-rest-comments-3710
Oct 10, 2026
Merged

takecchi merged 2 commits into
mainfrom
chore/core-rest-comments-3710

Conversation

@takecchi

Copy link
Copy Markdown
Owner

Refs #3710

packages/core の残りを整理した。コメントだけの変更で、コードは変えていない。中身は2つある。

  1. chore: packages/core(1272e81d 以降に足された分)の無駄なコメントを消す #4401 で外した4ファイル(manager.ts・schema.ts・tools.ts・workspace-swap-hints.ts)のうち、1272e81d より後に足されたコメント(約20行)。chore: packages/core(1272e81d 以降に足された分)の無駄なコメントを消す #4401 の時点では、open の fix: pids が尽きて git を起こせなかった回の未 push 観測が、前に取れていた枝名を台帳から消さないようにする #4398 がこれらに触っていたので外していた。fix: pids が尽きて git を起こせなかった回の未 push 観測が、前に取れていた枝名を台帳から消さないようにする #4398 は 2026-10-10T02:42Z にマージ済みである
  2. 到達点の報告の申し送りにあった store.ts の「もう一段縮める」

基準と、その根拠

#4401〜#4405 と同じ。AGENTS.md の「情報の置き場所」に従い、コードのコメントには Why not(単純にすると壊れる理由)だけを残す。How はコードで、What は試験の名前で、Why はコミットログで表す。Issue 番号・経緯は消す。

オーナーの承認(クローンの手元の記録から):

  • 2026-10-07T00:46Z、承認 f6e6bad8「この基準で全体に広げてよい」
  • 2026-10-07T01:17Z、オーナーの逐語「AGENTS.mdに則って整理してくれませんか?とても大きな削除になると思いますが想定通りです。」

store.ts

store.ts は storage-fs / storage-pg / インメモリの3実装が実装する契約の正本なので、契約の条件は What に見えても残す側に倒した。 一段で削ったのは −31 行で、控えめである。

  • 消した:
    • 型名・欄名を言い直していただけの doc(WriteMemoryOptions・JournalPage・PendingInboxEvent・Stores など12か所)
    • Issue 番号(#662)
    • 逸話・経緯(未読 104 件の器の話、取り違えた比較が実際に起きた話、重複の事実が所在を特定した話、作り替えの経緯とオーナー逐語の引用、など)
    • describeUnreadable* 5つの「0件のときは何も出さない」の重ね書き
  • 書き直して残した(経緯と一緒に理由まで消えないように):
    • ensureTrailingNewline を通す理由: 複製すると実装ごとに読み戻しがずれるため
    • readTail が read() を使わない理由: 起動のたびの拾い直しが全文をヒープへ載せると OOM になる
  • 残した:
    • NUL・並び順・冪等性・先勝ち・ifMatch・「省略可能にしないこと」の各項
    • instanceof で見分ける系の doc
    • [sdk-verbatim …] の印
    • EnvProfileEntry の scope の説明。.claude/skills/env-profile/SKILL.md が根拠として指している

たたき台は作業者が作り、私が差分を全行読んで、上の2か所を戻した。その手直しは2つ目のコミットに入っている(コミットの件名は3ファイルの名前しか挙げていない)。

4ファイル

  • 消した:
    • Issue 番号(#1266・#2987・#4355・#4394)
    • externalOutputLimits の上の型の言い直し
    • where の欄の言い直し
    • Job.externalOutputs を写すだけ、の doc
    • rescueNotPushedDetail の doc
  • 書き直して残した: keptPerJob の上(古いほうから落としてよい理由)
  • 残した:
    • 枝名を null で上書きしない理由(manager.ts)
    • 長さの上限を道具の入口が持つ理由(schema.ts)
    • 一覧で件数と最後の1件だけにする理由(tools.ts。変更なし)

確かめたこと

  • コメントを除いた構文木が main と一致する: 4 files, mismatches 0(TypeScript の printer を removeComments: true で回し、origin/main の版と比べた)
  • npx prettier --check(変えた4ファイル)→ exit 0
  • pnpm --filter @alteroid/core typecheck → exit 0
  • open の PR は、この4ファイルにも store.ts にも触れていない(作成時点)

確かめていないこと

  • 試験は手元で回していない(CI に任せた)。コードが変わっていないことの根拠は、構文木の一致である
  • どのコメントが What で、どれが守らないと壊れる理由かは私の判定であって、確認ではない

Alteroid-Issue-Done: none

@takecchi
takecchi merged commit f2790e2 into main Oct 10, 2026
6 checks passed
@takecchi
takecchi deleted the chore/core-rest-comments-3710 branch October 10, 2026 05:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant