Skip to content

chore: apps/cli(1272e81d 以降に足された分)の無駄なコメントを消す - #4403

Merged
takecchi merged 1 commit into
mainfrom
chore/cli-comments-3710
Oct 10, 2026
Merged

takecchi merged 1 commit into
mainfrom
chore/cli-comments-3710

Conversation

@takecchi

Copy link
Copy Markdown
Owner

Refs #3710

apps/cli で、2026-10-09 の到達点の報告の時点(1272e81d)より後に足されたコメントを整理した。コメントだけの変更で、コードは変えていない。

基準と、その根拠

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

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

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

範囲

消したもの・残したもの

  • 消した:
    • Issue 番号(#4356・#4353・#4342・#3943)
    • command-args.ts の各関数の上の、名前を言い直していた1行
    • 試験の冒頭で試験の名前を言い直していた行
  • 書き直して残した: command-args.ts の冒頭(規則を1か所に置く理由、余分な語を断る理由)。normalizeCommandWord・parseCountArg の上は、「何をするか」から「なぜそうするか」の形に直した
  • 残した: input.ts の Ink の読み方の理由、test-helpers.ts の書き終わりの callback の理由、confirm.test.ts の偽の端末の理由

確かめたこと

  • コメントを除いた構文木が main と一致する: 8 files, mismatches 0(TypeScript の printer を removeComments: true で回し、origin/main の版と比べた)
  • npx prettier --check(変えた8ファイル)通過
  • 触ったファイルを readFileSync / ?raw で読む箇所は無かった

確かめていないこと

  • 手元では cli の typecheck も試験も回していない。この器では依存パッケージが未 build である。コードが変わっていないことの根拠は、上の構文木の一致だけである。試験は CI に任せた
  • どのコメントが What で、どれが守らないと壊れる理由かは私の判定であって、確認ではない

Alteroid-Issue-Done: none

@takecchi
takecchi merged commit 3a4974b into main Oct 10, 2026
6 checks passed
@takecchi
takecchi deleted the chore/cli-comments-3710 branch October 10, 2026 04:17
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