Konfiguration
Konfiguriere Vercel Doctor mit einer Config-Datei, um Regeln, Dateien zu ignorieren und das Verhalten anzupassen.
Vercel Doctor funktioniert ohne Konfiguration out-of-the-box. Wenn du das Verhalten anpassen musst, kannst du eine Config-Datei hinzufügen.
Config-Datei
Erstelle eine vercel-doctor.config.json im Projektroot:
{
"ignore": {
"rules": ["vercel-doctor/nextjs-link-prefetch-default"],
"files": ["src/generated/**"]
}
}Alternativ kannst du einen "vercelDoctor"-Schlüssel in deine package.json einfügen:
{
"vercelDoctor": {
"ignore": {
"rules": ["knip/exports"],
"files": ["src/generated/**"]
}
}
}Wenn beide existieren, hat vercel-doctor.config.json Vorrang.
Optionen
| 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 |
Regeln ignorieren
Verwende das plugin/rule-Format für Rule-IDs:
{
"ignore": {
"rules": [
"vercel-doctor/nextjs-image-missing-sizes",
"vercel-doctor/vercel-large-static-asset",
"knip/exports"
]
}
}Siehe die Rules-Seiten für alle verfügbaren Rule-IDs.
Dateien ignorieren
Verwende Glob-Patterns, um Dateien vom Scan auszuschließen:
{
"ignore": {
"files": ["src/generated/**", "**/*.stories.tsx", "scripts/**"]
}
}CLI-Überschreibungen
CLI-Flags haben immer Vorrang vor Werten aus der Config-Datei. Zum Beispiel überschreibt --verbose auf der Kommandozeile "verbose": false in der Config-Datei.
Vollständiges Beispiel
{
"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"
}Last updated on