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.config.json في جذر المشروع:

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

أو أضف مفتاح "vercelDoctor" إلى package.json:

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

إن وُجد الاثنان، فإن vercel-doctor.config.json له الأسبقية.

الخيارات

Key	Type	Default	الوصف
`ignore.rules`	`string[]`	`[]`	معرفات القواعد لقمعها بتنسيق `plugin/rule`
`ignore.files`	`string[]`	`[]`	أنماط Glob لمسارات الملفات لتخطيها
`lint`	`boolean`	`true`	تفعيل أو تعطيل قواعد billing lint
`deadCode`	`boolean`	`true`	تفعيل أو تعطيل اكتشاف الكود الميت
`verbose`	`boolean`	`false`	عرض مسارات الملفات وأرقام الأسطر لكل قاعدة
`diff`	`boolean \| string`	`false`	تفعيل وضع diff أو تثبيت الفرع الأساسي

تجاهل القواعد

استخدم تنسيق plugin/rule لمعرفات القواعد:

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

راجع صفحات 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