svelte-5-doctor 0.1.0

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,194 @@
+#!/usr/bin/env node
+/**
+ * Svelte Doctor CLI — ported from react-doctor-source/packages/react-doctor/src/cli/index.ts
+ * Mirrors React Doctor CLI surface: [directory] [options], --json, --verbose, --category, rules, why, ci
+ */
+import { Command } from "commander";
+import pc from "picocolors";
+import { readFileSync } from "node:fs";
+import { resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+import { runInspect } from "svelte-5-doctor-core";
+import { SVELTE_DOCTOR_RULES, RULE_MAP } from "svelte-5-doctor-core";
+const pkg = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf-8"));
+const program = new Command();
+program
+    .name("svelte-5-doctor")
+    .description("Svelte 5 Doctor — 0-100 health check for Svelte 5 codebases. Ported from React Doctor. (svelte-doctor alias kept for compat)")
+    .version(pkg.version, "-v, --version", "output the version number")
+    .argument("[directory]", "directory to scan", ".")
+    .option("--json", "output JSON report")
+    .option("--json-out <path>", "write JSON to file")
+    .option("--verbose", "verbose diagnostics")
+    .option("--category <category>", "filter by category (repeatable)", (v, prev) => [...prev, v], [])
+    .option("--score", "output score only")
+    .option("--no-score", "disable scoring output")
+    .option("--diff", "alias for --scope changed (deprecated)", false)
+    .option("--scope <scope>", "scope: full | changed | files", "full")
+    .option("--base <branch>", "diff base for changed scope", "main")
+    .option("--no-color", "disable color")
+    .action(async (directory, opts) => {
+    const dir = resolve(process.cwd(), directory);
+    const categories = opts.category ?? [];
+    // deprecated --diff alias
+    const scope = opts.diff ? "changed" : opts.scope;
+    const started = Date.now();
+    const report = await runInspect({ directory: dir, categories: categories.length ? categories : undefined, scope });
+    if (opts.score && !opts.json) {
+        console.log(String(report.score));
+        process.exit(report.diagnostics.some((d) => d.severity === "error") ? 1 : 0);
+    }
+    if (opts.json) {
+        const out = JSON.stringify(report, null, 2);
+        if (opts.jsonOut) {
+            const { writeFileSync } = await import("node:fs");
+            writeFileSync(resolve(process.cwd(), opts.jsonOut), out, "utf-8");
+            console.log(pc.green(`JSON written to ${opts.jsonOut}`));
+        }
+        else {
+            console.log(out);
+        }
+        const hasErrors = report.diagnostics.some((d) => d.severity === "error");
+        process.exit(hasErrors ? 1 : 0);
+    }
+    // human output — mirrors react-doctor score header
+    const labelColor = report.label === "Great" ? pc.green : report.label === "Needs work" ? pc.yellow : pc.red;
+    console.log("");
+    console.log(`  ${pc.bold("Svelte Doctor")}  ${pc.dim(`v${pkg.version}`)}  ${labelColor(`Score: ${report.score} (${report.label})`)}`);
+    console.log(`  ${pc.dim(`${report.summary.total} findings — ${report.summary.errors} errors, ${report.summary.warnings} warnings — ${report.meta.durationMs}ms`)}`);
+    console.log(`  ${pc.dim(`Svelte ${report.meta.svelteVersion} · ${report.meta.directory}`)}`);
+    console.log("");
+    if (report.diagnostics.length === 0) {
+        console.log(pc.green("  ✓ No issues found. Your Svelte 5 codebase is healthy!"));
+        console.log("");
+        process.exit(0);
+    }
+    // group by category like react-doctor
+    const byCat = {};
+    for (const d of report.diagnostics)
+        (byCat[d.category] ??= []).push(d);
+    const order = ["Security", "Correctness", "Performance", "Accessibility", "Maintainability", "Architecture"];
+    const cats = order.filter((c) => byCat[c]?.length);
+    for (const cat of cats) {
+        const list = byCat[cat] ?? [];
+        const icon = cat === "Security" ? "🔒" : cat === "Correctness" ? "🐛" : cat === "Performance" ? "⚡" : cat === "Accessibility" ? "♿" : "🏗️";
+        console.log(`  ${icon} ${pc.bold(cat)} — ${list.length}`);
+        for (const d of list.slice(0, opts.verbose ? 100 : 10)) {
+            const sev = d.severity === "error" ? pc.red("error") : pc.yellow("warn");
+            const loc = pc.dim(`${d.filePath}:${d.line}:${d.column}`);
+            console.log(`    ${sev}  ${pc.bold(d.ruleId)}  ${d.message}`);
+            console.log(`         ${loc}`);
+            if (opts.verbose && d.fix)
+                console.log(`         ${pc.cyan("fix:")} ${d.fix}`);
+        }
+        if (!opts.verbose && list.length > 10)
+            console.log(pc.dim(`    ... and ${list.length - 10} more (use --verbose)`));
+        console.log("");
+    }
+    if (report.skippedCheckReasons?.length) {
+        console.log(pc.dim(`  skipped: ${report.skippedCheckReasons.length} checks`));
+    }
+    console.log(pc.dim(`  Run ${pc.bold("npx svelte-5-doctor --json --json-out report.json")} for machine-readable output.`));
+    console.log(pc.dim(`  Run ${pc.bold("npx svelte-5-doctor rules list")} to see all rules.`));
+    console.log("");
+    const hasErrors = report.diagnostics.some((d) => d.severity === "error");
+    process.exit(hasErrors ? 1 : 0);
+});
+program
+    .command("rules")
+    .description("list and explain rules (ported from react-doctor rules)")
+    .argument("[subcommand]", "list | explain", "list")
+    .argument("[ruleId]", "rule id for explain")
+    .option("--category <cat>", "filter by category")
+    .option("--json", "json output")
+    .action((sub, ruleId, opts, cmd) => {
+    const parentOpts = program.opts();
+    // commander v14: subcommand args handling tricky; fallback
+    const subCmd = sub ?? "list";
+    const targetId = ruleId;
+    if (subCmd === "explain" && targetId) {
+        const rule = RULE_MAP.get(targetId) ?? RULE_MAP.get(`svelte-doctor/${targetId}`) ?? RULE_MAP.get(`svelte-5-doctor/${targetId}`);
+        if (!rule) {
+            console.error(pc.red(`Unknown rule: ${targetId}`));
+            process.exit(1);
+        }
+        console.log(`${pc.bold(rule.id)} [${rule.category}] ${rule.severity}`);
+        console.log(rule.description);
+        if (rule.tags?.length)
+            console.log(pc.dim(`tags: ${rule.tags.join(", ")}`));
+        if (rule.fix)
+            console.log(pc.cyan(`fix: ${rule.fix}`));
+        return;
+    }
+    let rules = [...SVELTE_DOCTOR_RULES];
+    if (opts.category)
+        rules = rules.filter((r) => r.category.toLowerCase() === String(opts.category).toLowerCase());
+    if (opts.json) {
+        console.log(JSON.stringify(rules, null, 2));
+        return;
+    }
+    console.log(pc.bold(`Svelte Doctor — ${rules.length} rules (ported from React Doctor's 287)`));
+    console.log(pc.dim("Categories: Security · Correctness · Performance · Accessibility · Maintainability"));
+    console.log("");
+    for (const r of rules) {
+        const sev = r.severity === "error" ? pc.red(r.severity) : r.severity === "warn" ? pc.yellow(r.severity) : pc.dim(r.severity);
+        console.log(`  ${sev.padEnd(10)} ${pc.bold(r.id)}  ${pc.dim(`[${r.category}]`)}  ${r.description}`);
+    }
+    console.log("");
+    console.log(pc.dim(`Run ${pc.bold("npx svelte-5-doctor rules explain <ruleId>")} for details.`));
+});
+program
+    .command("why")
+    .description("explain why a diagnostic was reported at a location")
+    .argument("<location>", "file:line e.g. src/App.svelte:42")
+    .action(async (location) => {
+    const [file, lineStr] = location.split(":");
+    const line = Number.parseInt(lineStr ?? "1", 10);
+    const dir = process.cwd();
+    const report = await runInspect({ directory: dir });
+    const matches = report.diagnostics.filter((d) => d.filePath.endsWith(file ?? "") && Math.abs(d.line - line) <= 2);
+    if (!matches.length) {
+        console.log(pc.yellow(`No diagnostics near ${location}`));
+        return;
+    }
+    for (const d of matches) {
+        console.log(`${pc.bold(d.ruleId)} [${d.category}] ${d.severity} at ${d.filePath}:${d.line}:${d.column}`);
+        console.log(`  ${d.message}`);
+        if (d.fix)
+            console.log(pc.cyan(`  fix: ${d.fix}`));
+        const rule = RULE_MAP.get(d.ruleId);
+        if (rule)
+            console.log(pc.dim(`  ${rule.description}`));
+        console.log("");
+    }
+});
+program
+    .command("ci")
+    .description("CI helpers (ported from react-doctor ci)")
+    .argument("[sub]", "install | config")
+    .action((sub) => {
+    if (sub === "install" || !sub) {
+        console.log(pc.bold("Svelte Doctor CI install"));
+        console.log("");
+        console.log("Add to .github/workflows/svelte-doctor.yml:");
+        console.log(pc.cyan(`
+name: Svelte Doctor
+on:
+  pull_request: [opened, synchronize, reopened]
+  push:
+    branches: [main]
+jobs:
+  svelte-doctor:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+      - run: pnpm install
+      - run: npx svelte-doctor --scope changed --base main
+`));
+        console.log(pc.dim("See action.yml for full GitHub Action inputs (blocking, scope, comment)."));
+        return;
+    }
+    console.log("Unknown ci subcommand:", sub);
+});
+program.parseAsync(process.argv);

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Public API — ported from react-doctor-source/packages/react-doctor/src/index.ts
+ * Exposes programmatic inspect() for Svelte Doctor.
+ */
+export { runInspect } from "svelte-5-doctor-core";
+export type { JsonReport, Diagnostic } from "svelte-5-doctor-core";

package/dist/index.js

@@ -0,0 +1,5 @@
+/**
+ * Public API — ported from react-doctor-source/packages/react-doctor/src/index.ts
+ * Exposes programmatic inspect() for Svelte Doctor.
+ */
+export { runInspect } from "svelte-5-doctor-core";

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "svelte-5-doctor",
+  "version": "0.1.0",
+  "description": "Svelte 5 Doctor — 0-100 health check for Svelte 5. Ported from React Doctor (millionco/react-doctor). Renamed from svelte-doctor (taken on npm by pimatis/svelte-doctor).",
+  "type": "module",
+  "bin": {
+    "svelte-5-doctor": "./dist/cli.js",
+    "svelte-doctor": "./dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "commander": "^14.0.3",
+    "picocolors": "^1.1.1",
+    "tinyglobby": "^0.2.12",
+    "svelte-5-doctor-core": "0.1.0"
+  },
+  "devDependencies": {
+    "svelte": "^5.35.0",
+    "tsx": "^4.22.4",
+    "typescript": "^5.9.2",
+    "vitest": "^3.2.4"
+  },
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "keywords": [
+    "svelte",
+    "svelte5",
+    "linter",
+    "doctor",
+    "security",
+    "performance",
+    "a11y"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "dev": "tsx src/cli.ts --help",
+    "test": "vitest run"
+  }
+}