@santi020k/astro-doctor

Your agent writes bad Astro. This catches it.

The CLI for Astro Doctor — scans your Astro project and reports issues across performance, accessibility, security, and best practices.

It combines 13 proprietary Astro rules with the official Astro ESLint catalog and project-level audits, providing up to 71 checks with the all preset.

Quick Start

# One-time scan (no install)
pnpm dlx @santi020k/astro-doctor@latest

# Scan a specific directory
pnpm dlx @santi020k/astro-doctor@latest --dir ./src

# Scaffold config, ESLint setup, and GitHub Action
pnpm dlx @santi020k/astro-doctor@latest init

# Enable every non-deprecated official Astro rule
pnpm dlx @santi020k/astro-doctor@latest --preset all

# Install the agent skill after scanning
pnpm dlx @santi020k/astro-doctor@latest install

# Cache repeated scans
pnpm dlx @santi020k/astro-doctor@latest --cache

# Emit SARIF for code-scanning tools
pnpm dlx @santi020k/astro-doctor@latest --format sarif > astro-doctor.sarif

# Record existing findings and report only new ones
pnpm dlx @santi020k/astro-doctor@latest baseline create
pnpm dlx @santi020k/astro-doctor@latest --baseline .astro-doctor-baseline.json

Programmatic API

import {
  formatConsoleReport,
  formatGithubReport,
  formatJsonReport,
  formatSarifReport,
  scan,
} from '@santi020k/astro-doctor'

const result = await scan({ directory: './src' })

console.log(formatConsoleReport(result))
// Other formatters support JSON, GitHub Actions annotations, and SARIF.
// result.diagnostics  — array of findings
// result.errorCount   — number of errors
// result.warningCount — number of warnings
// result.fileCount    — number of files included in scoring

GitHub Actions

- uses: santi020k/astro-doctor@v1
  with:
    fail-on: error   # error | warning | off
    min-score: 90    # minimum passing health score (0–100)

See Also

• Full documentation
• @santi020k/eslint-plugin-astro-doctor — the underlying ESLint plugin
• Inspired by react-doctor by Million Software, Inc

License

MIT — santi020k