Vite Doctor

Setup

comark-linter/doctor is a Vite Doctor extension. Vite Doctor loads extensions from an executable config, so register it in doctor.config.ts:

// doctor.config.ts
import comark from "comark-linter/doctor";
import { defineDoctorConfig } from "vite-doctor/config";

export default defineDoctorConfig({
  extends: ["comark/recommended"],
  extensions: [comark({ components: ["duck-count"] })],
});

pnpm vite-doctor . --config doctor.config.ts

It runs whenever the extension is registered, and the comark/recommended preset turns every rule on. It needs vite-doctor 0.1 or later.

Options

It takes the same plugins and components as the command line's config, plus two of its own:

This site lints its own pages this way. Its docs/build.ts renders a few components itself, so the config names them:

// doctor.config.ts
export default defineDoctorConfig({
  extends: ["comark/recommended"],
  extensions: [
    comark({
      include: "docs/pages/**/*.md",
      components: ["cards", "example", "examples", "hero", "matrix"],
    }),
  ],
});

Codes

Each rule reports with its own code, and the code links to the rule's entry on the overview. Frontmatter Comark can't read and unsafe URLs are errors; the rest are warnings.