What is Vercel Doctor?

Vercel Doctor is an open-source tool for Next.js projects that identifies patterns increasing your Vercel costs, such as long function durations, uncached routes, and unnecessary invocations.

How do I use Vercel Doctor?

You can run it via npx: `npx -y vercel-doctor@latest .`. Use `--verbose` for detailed reports.

Is Vercel Doctor free?

Yes, Vercel Doctor is completely free and open-source under the MIT license.

設定 | Vercel Doctor

設定ファイルでVercel Doctorを設定し、ルールやファイルを無視して動作をカスタマイズできます。

Vercel Doctorは設定なしでそのまま動作します。動作をカスタマイズする場合は、設定ファイルを追加できます。

設定ファイル

プロジェクトルートに vercel-doctor.config.json を作成してください：

{
  "ignore": {
    "rules": ["vercel-doctor/nextjs-link-prefetch-default"],
    "files": ["src/generated/**"]
  }
}

または、package.json に "vercelDoctor" キーを追加します：

{
  "vercelDoctor": {
    "ignore": {
      "rules": ["knip/exports"],
      "files": ["src/generated/**"]
    }
  }
}

両方存在する場合、vercel-doctor.config.json が優先されます。

オプション

Key	Type	Default	Description
`ignore.rules`	`string[]`	`[]`	Rule IDs to suppress, in `plugin/rule` format
`ignore.files`	`string[]`	`[]`	Glob patterns for file paths to skip
`lint`	`boolean`	`true`	Enable or disable billing lint rules
`deadCode`	`boolean`	`true`	Enable or disable dead code detection
`verbose`	`boolean`	`false`	Show file paths and line numbers per rule
`diff`	`boolean \| string`	`false`	Enable diff mode or pin a base branch

ルールを無視する

ルールIDは plugin/rule 形式を使用します：

{
  "ignore": {
    "rules": [
      "vercel-doctor/nextjs-image-missing-sizes",
      "vercel-doctor/vercel-large-static-asset",
      "knip/exports"
    ]
  }
}

利用可能なルールIDは Rules ページで確認できます。

ファイルを無視する

スキャン対象外にするファイルをglobパターンで指定します：

{
  "ignore": {
    "files": ["src/generated/**", "**/*.stories.tsx", "scripts/**"]
  }
}

CLIによる上書き

CLIフラグは常に設定ファイルの値より優先されます。例えば、コマンドラインで --verbose を指定すると、設定ファイルの "verbose": false を上書きします。

完全な例

{
  "ignore": {
    "rules": [
      "vercel-doctor/vercel-consider-bun-runtime",
      "vercel-doctor/vercel-avoid-platform-cron"
    ],
    "files": ["src/generated/**", "e2e/**"]
  },
  "lint": true,
  "deadCode": true,
  "verbose": false,
  "diff": "main"
}

Edit on GitHub

Last updated on

設定