Skip to content

docs: tool-catalog.md のバージョン番号重複を削除 - #696

Merged
keito4 merged 3 commits into
mainfrom
fix/tool-catalog-no-version-dup
Apr 27, 2026
Merged

docs: tool-catalog.md のバージョン番号重複を削除#696
keito4 merged 3 commits into
mainfrom
fix/tool-catalog-no-version-dup

Conversation

@keito4

@keito4 keito4 commented Apr 26, 2026

Copy link
Copy Markdown
Owner

Summary

docs/tool-catalog.md から npm/global.json / package.json 由来のバージョン番号を削除し、各ファイルへのリンク参照に置換。dependency 更新時の手動同期が不要になる(DRY)。

変更内容

  • 2.1 ランタイム: npm, corepack のバージョンセル → see global.json
  • 2.2 AI CLI: Codex, Gemini CLI, Happy Codersee global.json
  • 2.3 ユーティリティ: Vercel CLI, n8n, pm2, difit, @antfu/nisee global.json
  • 2.4 Language Servers: テーブル → 箇条書き、npm/global.json リンク
  • 2.5 MCP / Automation: テーブル → 箇条書き、npm/global.json リンク
  • 2.6 Git / CI 関連: テーブル → 箇条書き、package.json リンク

Test plan

  • npm run lint
  • npm test 95 件パス
  • npm run format:check
  • pre-commit hook すべて通過

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Reorganized tool catalog to reference centralized version sources instead of maintaining hardcoded version entries throughout the document
    • Reformatted Language Servers, MCP/Automation, and Git/CI-related package sections from versioned tables into bullet-point lists
    • Streamlined documentation by pointing to global.json and package.json as single sources of truth for versions

`npm/global.json` / `package.json` をソース・オブ・トゥルースとし、
docs では `see global.json` または該当ファイルへのリンクで参照する。

これにより毎回の dependency update 時に tool-catalog.md を手動同期する
必要がなくなる(DRY 原則)。バージョン値が知りたい場合は同ファイルを参照。

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Apr 26, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

The tool catalog documentation replaces hardcoded version entries with references to source files (npm/global.json and package.json). Several tool sections are reformatted from versioned tables into bullet lists, removing explicit version numbers while directing readers to authoritative version sources.

Changes

Cohort / File(s) Summary
Documentation Updates
docs/tool-catalog.md
Replaced multiple hardcoded version entries with "see global.json" or "see package.json" references; reformatted Language Servers, MCP/Automation, and Git/CI-related sections from versioned tables into bullet lists pointing to version sources.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

  • #478: Updates versions in npm/global.json that the main PR now references in documentation.
  • #463: Modifies dependency versions in npm/global.json and package.json, which are the new source-of-truth files referenced by updated docs.
  • #515: Updates tool versions in npm/global.json and package.json that the main PR directs readers to consult.

Suggested labels

docs

Poem

🐰 No more versions locked in stone,

Let global.json reign alone!

Pointers dance where numbers played,

A catalog made truth-displayed. ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: removing duplicate version numbers from the tool-catalog.md file.
Description check ✅ Passed The description covers all required sections: Summary, What (変更内容), and test results. It provides clear details about which sections were modified and how.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/tool-catalog-no-version-dup

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@claude

claude Bot commented Apr 27, 2026

Copy link
Copy Markdown
Contributor

Claude finished @keito4's task in 1m 29s —— View job


PR レビュー完了

  • コンテキスト収集
  • 変更内容の確認(docs/tool-catalog.md
  • レビューフィードバックの作成

総評

DRY 原則に従ってバージョン番号の重複を排除する、意図が明確でスコープも適切な変更です。npm/global.json / package.json を更新するだけでドキュメントが自動的に最新化される設計は正しいアプローチです。

Verdict: ✅ APPROVE(下記はすべて minor / recommendation レベル)


指摘事項

[minor] セクション 2.1〜2.3 の see global.json がリンクなし

docs/tool-catalog.md:34-35, 44-46, 70-74 にある see global.json はプレーンテキストのため、クリックして参照できません。セクション 2.4〜2.6 では適切な Markdown リンクを使用しているため、不整合になっています。

- | npm      | see global.json | パッケージマネージャ       |
- | corepack | see global.json | パッケージマネージャ切替   |
+ | npm      | [global.json](../npm/global.json) | パッケージマネージャ       |
+ | corepack | [global.json](../npm/global.json) | パッケージマネージャ切替   |

同様に 2.2 の Codex / Gemini CLI / Happy Coder、2.3 の Vercel CLI 等にも適用。Fix this →


[recommendation] セクション 2.6 のリンク先精度

docs/tool-catalog.md:89 — セクション 2.6 の見出しが「Dockerfile 末尾でインストール」となっており、global インストールを示唆しています。@commitlint/cli@commitlint/config-conventional は実際には npm/global.json(行 4〜11)と package.json(行 31〜32)の両方に存在します。huskypackage.json のみにあるため、現在のリンクは誤りではありませんが、@commitlint/* については global.json が正確な参照先です。

両ファイルを明示する案:

### 2.6 Git / CI 関連(Dockerfile 末尾でインストール、[`npm/global.json`](../npm/global.json) / [`package.json`](../package.json) 参照)

[recommendation] 残存するハードコードバージョン

以下はまだ固定値が残っており、更新時に手動同期が必要です(今回のスコープ外ですが、将来の追加 PR の候補):

箇所
Node.js docs/tool-catalog.md:31 24.14.1
pnpm docs/tool-catalog.md:33 10.33.0
Claude Code docs/tool-catalog.md:43 (2.1.92)

確認事項

  • リンクパス ../npm/global.json../package.jsondocs/ からの相対パスとして正しいことを確認 ✅
  • npm/global.jsonvercel, n8n, pm2, difit, @antfu/ni, @commitlint/*, mcp-remote, n8n-mcp-server が存在することを確認 ✅
  • Test plan(lint / test / format)がすべて通過していることをPR本文で確認 ✅

@keito4 keito4 self-assigned this Apr 27, 2026
@keito4

keito4 commented Apr 27, 2026

Copy link
Copy Markdown
Owner Author

(aside)
@claude PRがbaseにマージする際にCIが落ちています。
修正してください。

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: aecee8073c

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/tool-catalog.md
- `mcp-remote` — MCP リモート接続
- `@leonardsellem/n8n-mcp-server` — n8n MCP サーバー

### 2.6 Git / CI 関連(Dockerfile 末尾でインストール、バージョンは [`package.json`](../package.json) 参照)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Reference lockfile for Git/CI package versions

The updated 2.6 heading points readers to package.json for version information, but @commitlint/cli and @commitlint/config-conventional are defined there as semver ranges (e.g. ^20.5.x), while the image actually installs pinned versions via npm ci from package-lock.json. In this state, the docs can show an imprecise or wrong effective version after range-only edits, so the source-of-truth note should reference the lockfile (or keep explicit pinned values).

Useful? React with 👍 / 👎.

@claude

claude Bot commented Apr 27, 2026

Copy link
Copy Markdown
Contributor

Claude finished @keito4's task in 8m 52s —— View job


CI 失敗の調査結果

  • コンテキスト収集
  • CI ステータスの確認
  • 失敗原因の特定
  • 修正の実施(詳細は下記)

調査結果

PR #696 のコミット aecee8073c に対して全 CI チェックを確認しました。

チェック 結果
Quality Gate ✅ SUCCESS
GitGuardian Security Checks ✅ SUCCESS
claude-review ✅ SUCCESS
check-ci-status ✅ SUCCESS
dependabot-auto ✅ SUCCESS

CI は現在すべて緑です。 ci.yml は markdown のみの変更にはパス不要なため、quality-gate-fallback.yml が Quality Gate を代行し PASS しています。


マージがブロックされている本当の原因

mergeStateStatus: BLOCKED
reviewDecision:   REVIEW_REQUIRED
mergeable:        MERGEABLE(コンフリクトなし)

CI 失敗ではなく、ブランチ保護の「レビュー必須」ルールによるブロックです。承認済みレビューが 0 件のため、マージできない状態です。


関連情報

PR #695 (fix/quality-gate-fallback-name) が open 中です。ci.ymlquality-gate-fallback.yml が同じ name: CI を持つことで Actions UI 上の混乱を招く問題を修正するものです(workflow 名を CI Fallback に変更)。本 PR #696 のブロックとは無関係ですが、マージ前に #695 のマージを先に済ませると UI がスッキリします。


CI の修正は不要です(すでに全チェック PASS)。マージには人間によるレビュー承認が必要です。

@keito4

keito4 commented Apr 27, 2026

Copy link
Copy Markdown
Owner Author

(aside)
@claude PRがbaseにマージする際にCIが落ちています。
修正してください。

@claude

claude Bot commented Apr 27, 2026

Copy link
Copy Markdown
Contributor

Claude finished @keito4's task in 7m 10s —— View job


完了

  • コンテキスト収集
  • CI ステータス・失敗原因の特定
  • origin/main をブランチにマージしてブランチを最新化
  • push して CI 再トリガー

調査結果と対応内容

根本原因: mergeStateStatus: "BEHIND" — ブランチが origin/main より遅れており(Windows サポート PR #698#700 が main にマージ済み)、マージできない状態だった。

実施した修正:

git pull origin main --no-rebase --no-edit
  • README.md, brew/Winfile.json, git/gitconfig, script/import.ps1, script/import.sh, script/lib/platform.sh, vscode/extensions.txt を取り込み
  • マージコミット 48fd79a を push

現在の PR 状態:

項目 修正前 修正後
mergeable MERGEABLE MERGEABLE
mergeStateStatus BEHIND BLOCKEDREVIEW_REQUIRED のみ)
CI 競合 なし(docs/tool-catalog.md は main で未変更) -

BLOCKED の残原因: REVIEW_REQUIRED(ブランチ保護によるレビュー必須)— CI 起因の問題は解消済み。レビュー承認後にマージ可能です。

CI(GitGuardian 🟢、Quality Gate 実行中)が完了すれば、すべてのチェックが green になる見込みです。
| Branch: fix/tool-catalog-no-version-dup

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (3)
docs/tool-catalog.md (3)

29-35: LGTM! DRY improvement successfully implemented.

The replacement of hardcoded versions with "see global.json" for npm and corepack correctly references the single source of truth. This eliminates manual synchronization when dependencies are updated.

💡 Optional enhancement: Make "see global.json" clickable for better UX

Consider converting the plain text references into clickable links:

-| npm      | see global.json | パッケージマネージャ       |
-| corepack | see global.json | パッケージマネージャ切替   |
+| npm      | [see global.json](../npm/global.json) | パッケージマネージャ       |
+| corepack | [see global.json](../npm/global.json) | パッケージマネージャ切替   |

This would allow readers to navigate directly to the source file.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/tool-catalog.md` around lines 29 - 35, Replace the plain "see
global.json" text for the npm and corepack rows in the tools table with a
clickable Markdown link to the repository's global.json (e.g., [see
global.json](./global.json)), so update the npm and corepack table cells in
docs/tool-catalog.md to use a Markdown link pointing to the global.json file to
improve UX and direct readers to the single source of truth.

41-47: LGTM! Consistent DRY implementation for AI CLI tools.

The changes correctly reference global.json for npm-managed AI CLI tools while preserving version information for tools installed via other methods (native installer, curl).

💡 Optional enhancement: Make references clickable
-| Codex (`@openai/codex`)           | see global.json           | OpenAI Codex CLI    |
-| Gemini CLI (`@google/gemini-cli`) | see global.json           | Google Gemini CLI   |
-| Happy Coder                       | see global.json           | AI コーディング     |
+| Codex (`@openai/codex`)           | [see global.json](../npm/global.json) | OpenAI Codex CLI    |
+| Gemini CLI (`@google/gemini-cli`) | [see global.json](../npm/global.json) | Google Gemini CLI   |
+| Happy Coder                       | [see global.json](../npm/global.json) | AI コーディング     |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/tool-catalog.md` around lines 41 - 47, Update the table entries that
currently show "see global.json" so they link to the actual global.json file
(make the text a clickable Markdown link) for the Codex (`@openai/codex`),
Gemini CLI (`@google/gemini-cli`) and Happy Coder rows; preserve the display
text while wrapping it in a relative link to global.json and ensure Markdown
table alignment remains intact.

62-74: LGTM! Selective version reference replacement is appropriate.

The changes correctly identify and update only the npm-managed utilities (Vercel CLI, n8n, pm2, difit, @antfu/ni) to reference global.json, while preserving explicit version information for tools managed via apt, pnpm global, or on-demand installation.

💡 Optional enhancement: Add clickable links
-| Vercel CLI      | see global.json | Vercel デプロイ                                  |
-| n8n             | see global.json | ワークフロー自動化                               |
-| pm2             | see global.json | プロセスマネージャ                               |
-| difit           | see global.json | AI diff レビューツール                           |
-| `@antfu/ni`     | see global.json | パッケージマネージャ抽象化 CLI                   |
+| Vercel CLI      | [see global.json](../npm/global.json) | Vercel デプロイ                                  |
+| n8n             | [see global.json](../npm/global.json) | ワークフロー自動化                               |
+| pm2             | [see global.json](../npm/global.json) | プロセスマネージャ                               |
+| difit           | [see global.json](../npm/global.json) | AI diff レビューツール                           |
+| `@antfu/ni`     | [see global.json](../npm/global.json) | パッケージマネージャ抽象化 CLI                   |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/tool-catalog.md` around lines 62 - 74, The table update is good; as an
optional enhancement, convert the tool names for Vercel CLI, n8n, pm2, difit and
`@antfu/ni` into clickable Markdown links to their official docs/repos so
readers can quickly access installation/usage info; edit the rows in
docs/tool-catalog.md replacing plain names with [Vercel CLI](...), [n8n](...),
[pm2](...), [difit](...), and [`@antfu/ni`](...) while preserving the "see
global.json" version cells and keeping existing entries for apt/pnpm/on-demand
tools unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/tool-catalog.md`:
- Around line 29-35: Replace the plain "see global.json" text for the npm and
corepack rows in the tools table with a clickable Markdown link to the
repository's global.json (e.g., [see global.json](./global.json)), so update the
npm and corepack table cells in docs/tool-catalog.md to use a Markdown link
pointing to the global.json file to improve UX and direct readers to the single
source of truth.
- Around line 41-47: Update the table entries that currently show "see
global.json" so they link to the actual global.json file (make the text a
clickable Markdown link) for the Codex (`@openai/codex`), Gemini CLI
(`@google/gemini-cli`) and Happy Coder rows; preserve the display text while
wrapping it in a relative link to global.json and ensure Markdown table
alignment remains intact.
- Around line 62-74: The table update is good; as an optional enhancement,
convert the tool names for Vercel CLI, n8n, pm2, difit and `@antfu/ni` into
clickable Markdown links to their official docs/repos so readers can quickly
access installation/usage info; edit the rows in docs/tool-catalog.md replacing
plain names with [Vercel CLI](...), [n8n](...), [pm2](...), [difit](...), and
[`@antfu/ni`](...) while preserving the "see global.json" version cells and
keeping existing entries for apt/pnpm/on-demand tools unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fa4e1606-def1-4545-bed1-afca1d03ef19

📥 Commits

Reviewing files that changed from the base of the PR and between e1ec41e and 48fd79a.

📒 Files selected for processing (1)
  • docs/tool-catalog.md

@keito4
keito4 merged commit 11b34f2 into main Apr 27, 2026
3 checks passed
@keito4
keito4 deleted the fix/tool-catalog-no-version-dup branch April 27, 2026 03:42
@github-actions

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 1.111.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@github-actions github-actions Bot added the released リリース済み label Apr 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

released リリース済み

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant