React Doctor

リポジトリのルートで次を実行する。結果にスコアと上位のルール違反が表示される。

npx -y react-doctor@latest .

pull_request で github-token を渡すと、指摘を PR コメントとして投稿できる。diff に基づく部分スキャンでは履歴取得のため fetch-depth: 0 が推奨される。

- uses: actions/checkout@v5
  with:
    fetch-depth: 0
- uses: millionco/react-doctor@main
  with:
    diff: main
    github-token: ${{ secrets.GITHUB_TOKEN }}

アクションは score 出力も公開するため、後続ステップの条件に使える。

ルートに JSON を置くか、package.json の "reactDoctor" キーで同様の構造を書ける。CLI フラグは常に設定より優先する。

{
  "ignore": {
    "rules": ["react/no-danger", "jsx-a11y/no-autofocus"],
    "files": ["src/generated/**"],
    "overrides": [
      {
        "files": ["components/diff/**"],
        "rules": ["react-doctor/no-array-index-as-key"]
      }
    ]
  }
}

無視の階層

.gitignore、.eslintignore、.oxlintignore、.prettierignore、および .gitattributes の linguist-vendored / linguist-generated を尊重する。行コメントの // eslint-disable* と // oxlint-disable* も解釈される。

インライン抑制（React Doctor 用）

// react-doctor-disable-next-line react-doctor/no-cascading-set-state
useEffect(() => {
  setA(value);
  setB(value);
}, [value]);

同一行で複数ルールを止めるときはルール ID をカンマ区切り。JSX 内ではブロックコメントや JSX コメントの置き方が ESLint と同様の慣習に合わせる。

Node API

import { diagnose, toJsonReport, summarizeDiagnostics } from "react-doctor/api";

const result = await diagnose("./path/to/your/react-project");
console.log(result.score);
console.log(result.diagnostics);

diagnose の第 2 引数で { lint?: boolean, deadCode?: boolean } を渡せる。toJsonReport と summarizeDiagnostics で JSON レポート用の組み立てができる。型定義は api.ts。

pnpm workspace と Turborepo で管理されている。CLI とルール実装の本体、公開サイト、エージェント向けスキル定義が分離されている。

• GitHub: millionco/react-doctor
• npm: react-doctor
• デモサイト
• リーダーボード（ベンチマークリポジトリ由来の自動更新）
• Issue トラッカー

ライセンス

MIT。