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.

Konfiguration

Konfigurer Vercel Doctor med en konfigurationsfil til at ignorere regler, filer og tilpasse adfærd.

Vercel Doctor fungerer direkte uden konfiguration. Når du har brug for at tilpasse adfærden, kan du tilføje en konfigurationsfil.

Konfigurationsfil

Opret en vercel-doctor.config.json i din projektrod:

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

Alternativt kan du tilføje en "vercelDoctor"-nøgle til din package.json:

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

Hvis begge eksisterer, har vercel-doctor.config.json forrang.

Muligheder

Nøgle	Type	Standard	Beskrivelse
`ignore.rules`	`string[]`	`[]`	Regel-ID'er der skal undertrykkes, i `plugin/rule`-format
`ignore.files`	`string[]`	`[]`	Glob-mønstre for filstier der skal springes over
`lint`	`boolean`	`true`	Aktiver eller deaktiver faktureringslinningsregler
`deadCode`	`boolean`	`true`	Aktiver eller deaktiver detektering af død kode
`verbose`	`boolean`	`false`	Vis filstier og linjenumre per regel
`diff`	`boolean \| string`	`false`	Aktiver diff-tilstand eller angiv en base-branch

Ignorering af regler

Brug plugin/rule-formatet for regel-ID'er:

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

Se Regler-siderne for alle tilgængelige regel-ID'er.

Ignorering af filer

Brug glob-mønstre til at udelukke filer fra scanning:

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

CLI-tilsidesættelser

CLI-flag har altid forrang over konfigurationsfilværdier. For eksempel tilsidesætter --verbose på kommandolinjen "verbose": false i konfigurationsfilen.

Fuldt eksempel

{
  "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