react-doctor 0.0.29 → 0.0.30

package/dist/index.js

@@ -12,11 +12,18 @@ import { fileURLToPath } from "node:url";
 const SOURCE_FILE_PATTERN = /\.(tsx?|jsx?)$/;
 const JSX_FILE_PATTERN = /\.(tsx|jsx)$/;
 const ERROR_PREVIEW_LENGTH_CHARS = 200;
+const PERFECT_SCORE = 100;
+const SCORE_GOOD_THRESHOLD = 75;
+const SCORE_OK_THRESHOLD = 50;
 const SCORE_API_URL = "https://www.react.doctor/api/score";
 const FETCH_TIMEOUT_MS = 1e4;
 const GIT_LS_FILES_MAX_BUFFER_BYTES = 50 * 1024 * 1024;
 const SPAWN_ARGS_MAX_LENGTH_CHARS = 24e3;
 const DEFAULT_BRANCH_CANDIDATES = ["main", "master"];
+const ERROR_RULE_PENALTY = 1.5;
+const WARNING_RULE_PENALTY = .75;
+const ERROR_ESTIMATED_FIX_RATE = .85;
+const WARNING_ESTIMATED_FIX_RATE = .8;
 const MAX_KNIP_RETRIES = 5;
 const AMI_WEBSITE_URL = "https://ami.dev";
 const AMI_INSTALL_URL = `${AMI_WEBSITE_URL}/install.sh`;
@@ -71,6 +78,46 @@ const proxyFetch = async (url, init) => {
 
 //#endregion
 //#region src/utils/calculate-score.ts
+const getScoreLabel = (score) => {
+	if (score >= SCORE_GOOD_THRESHOLD) return "Great";
+	if (score >= SCORE_OK_THRESHOLD) return "Needs work";
+	return "Critical";
+};
+const countUniqueRules = (diagnostics) => {
+	const errorRules = /* @__PURE__ */ new Set();
+	const warningRules = /* @__PURE__ */ new Set();
+	for (const diagnostic of diagnostics) {
+		const ruleKey = `${diagnostic.plugin}/${diagnostic.rule}`;
+		if (diagnostic.severity === "error") errorRules.add(ruleKey);
+		else warningRules.add(ruleKey);
+	}
+	return {
+		errorRuleCount: errorRules.size,
+		warningRuleCount: warningRules.size
+	};
+};
+const scoreFromRuleCounts = (errorRuleCount, warningRuleCount) => {
+	const penalty = errorRuleCount * ERROR_RULE_PENALTY + warningRuleCount * WARNING_RULE_PENALTY;
+	return Math.max(0, Math.round(PERFECT_SCORE - penalty));
+};
+const estimateScoreLocally = (diagnostics) => {
+	const { errorRuleCount, warningRuleCount } = countUniqueRules(diagnostics);
+	const currentScore = scoreFromRuleCounts(errorRuleCount, warningRuleCount);
+	const estimatedScore = scoreFromRuleCounts(Math.round(errorRuleCount * (1 - ERROR_ESTIMATED_FIX_RATE)), Math.round(warningRuleCount * (1 - WARNING_ESTIMATED_FIX_RATE)));
+	return {
+		currentScore,
+		currentLabel: getScoreLabel(currentScore),
+		estimatedScore,
+		estimatedLabel: getScoreLabel(estimatedScore)
+	};
+};
+const calculateScoreLocally = (diagnostics) => {
+	const { currentScore, currentLabel } = estimateScoreLocally(diagnostics);
+	return {
+		score: currentScore,
+		label: currentLabel
+	};
+};
 const calculateScore = async (diagnostics) => {
 	try {
 		const response = await proxyFetch(SCORE_API_URL, {
@@ -78,10 +125,10 @@ const calculateScore = async (diagnostics) => {
 			headers: { "Content-Type": "application/json" },
 			body: JSON.stringify({ diagnostics })
 		});
-		if (!response.ok) return null;
+		if (!response.ok) return calculateScoreLocally(diagnostics);
 		return await response.json();
 	} catch {
-		return null;
+		return calculateScoreLocally(diagnostics);
 	}
 };
 
@@ -89,13 +136,33 @@ const calculateScore = async (diagnostics) => {
 //#region src/plugin/constants.ts
 const MOTION_LIBRARY_PACKAGES = new Set(["framer-motion", "motion"]);
 
+//#endregion
+//#region src/utils/is-file.ts
+const isFile = (filePath) => {
+	try {
+		return fs.statSync(filePath).isFile();
+	} catch {
+		return false;
+	}
+};
+
 //#endregion
 //#region src/utils/read-package-json.ts
-const readPackageJson = (packageJsonPath) => JSON.parse(fs.readFileSync(packageJsonPath, "utf-8"));
+const readPackageJson = (packageJsonPath) => {
+	try {
+		return JSON.parse(fs.readFileSync(packageJsonPath, "utf-8"));
+	} catch (error) {
+		if (error instanceof Error && "code" in error) {
+			const { code } = error;
+			if (code === "EISDIR" || code === "EACCES") return {};
+		}
+		throw error;
+	}
+};
 
 //#endregion
 //#region src/utils/check-reduced-motion.ts
-const REDUCED_MOTION_GREP_PATTERN = "prefers-reduced-motion|useReducedMotion";
+const REDUCED_MOTION_GREP_PATTERN = "prefers-reduced-motion|useReducedMotion|MotionConfig|reducedMotion";
 const REDUCED_MOTION_FILE_GLOBS = "\"*.ts\" \"*.tsx\" \"*.js\" \"*.jsx\" \"*.css\" \"*.scss\"";
 const MISSING_REDUCED_MOTION_DIAGNOSTIC = {
 	filePath: "package.json",
@@ -111,7 +178,7 @@ const MISSING_REDUCED_MOTION_DIAGNOSTIC = {
 };
 const checkReducedMotion = (rootDirectory) => {
 	const packageJsonPath = path.join(rootDirectory, "package.json");
-	if (!fs.existsSync(packageJsonPath)) return [];
+	if (!isFile(packageJsonPath)) return [];
 	let hasMotionLibrary = false;
 	try {
 		const packageJson = readPackageJson(packageJsonPath);
@@ -139,7 +206,7 @@ const checkReducedMotion = (rootDirectory) => {
 //#region src/utils/match-glob-pattern.ts
 const REGEX_SPECIAL_CHARACTERS = /[.+^${}()|[\]\\]/g;
 const compileGlobPattern = (pattern) => {
-	const normalizedPattern = pattern.replace(/\\/g, "/");
+	const normalizedPattern = pattern.replace(/\\/g, "/").replace(/^\//, "");
 	let regexSource = "^";
 	let characterIndex = 0;
 	while (characterIndex < normalizedPattern.length) if (normalizedPattern[characterIndex] === "*" && normalizedPattern[characterIndex + 1] === "*") if (normalizedPattern[characterIndex + 2] === "/") {
@@ -177,26 +244,67 @@ const filterIgnoredDiagnostics = (diagnostics, config) => {
 		return true;
 	});
 };
+const DISABLE_NEXT_LINE_PATTERN = /\/\/\s*react-doctor-disable-next-line\b(?:\s+(.+))?/;
+const DISABLE_LINE_PATTERN = /\/\/\s*react-doctor-disable-line\b(?:\s+(.+))?/;
+const isRuleSuppressed = (commentRules, ruleId) => {
+	if (!commentRules?.trim()) return true;
+	return commentRules.split(/[,\s]+/).some((rule) => rule.trim() === ruleId);
+};
+const filterInlineSuppressions = (diagnostics, rootDirectory) => {
+	const fileLineCache = /* @__PURE__ */ new Map();
+	const getFileLines = (filePath) => {
+		const cached = fileLineCache.get(filePath);
+		if (cached !== void 0) return cached;
+		const absolutePath = path.isAbsolute(filePath) ? filePath : path.join(rootDirectory, filePath);
+		try {
+			const lines = fs.readFileSync(absolutePath, "utf-8").split("\n");
+			fileLineCache.set(filePath, lines);
+			return lines;
+		} catch {
+			fileLineCache.set(filePath, null);
+			return null;
+		}
+	};
+	return diagnostics.filter((diagnostic) => {
+		if (diagnostic.line <= 0) return true;
+		const lines = getFileLines(diagnostic.filePath);
+		if (!lines) return true;
+		const ruleId = `${diagnostic.plugin}/${diagnostic.rule}`;
+		const currentLine = lines[diagnostic.line - 1];
+		if (currentLine) {
+			const lineMatch = currentLine.match(DISABLE_LINE_PATTERN);
+			if (lineMatch && isRuleSuppressed(lineMatch[1], ruleId)) return false;
+		}
+		if (diagnostic.line >= 2) {
+			const prevLine = lines[diagnostic.line - 2];
+			if (prevLine) {
+				const nextLineMatch = prevLine.match(DISABLE_NEXT_LINE_PATTERN);
+				if (nextLineMatch && isRuleSuppressed(nextLineMatch[1], ruleId)) return false;
+			}
+		}
+		return true;
+	});
+};
 
 //#endregion
 //#region src/utils/combine-diagnostics.ts
 const computeJsxIncludePaths = (includePaths) => includePaths.length > 0 ? includePaths.filter((filePath) => JSX_FILE_PATTERN.test(filePath)) : void 0;
 const combineDiagnostics = (lintDiagnostics, deadCodeDiagnostics, directory, isDiffMode, userConfig) => {
-	const allDiagnostics = [
+	const merged = [
 		...lintDiagnostics,
 		...deadCodeDiagnostics,
 		...isDiffMode ? [] : checkReducedMotion(directory)
 	];
-	return userConfig ? filterIgnoredDiagnostics(allDiagnostics, userConfig) : allDiagnostics;
+	return filterInlineSuppressions(userConfig ? filterIgnoredDiagnostics(merged, userConfig) : merged, directory);
 };
 
 //#endregion
 //#region src/utils/find-monorepo-root.ts
 const isMonorepoRoot = (directory) => {
-	if (fs.existsSync(path.join(directory, "pnpm-workspace.yaml"))) return true;
-	if (fs.existsSync(path.join(directory, "nx.json"))) return true;
+	if (isFile(path.join(directory, "pnpm-workspace.yaml"))) return true;
+	if (isFile(path.join(directory, "nx.json"))) return true;
 	const packageJsonPath = path.join(directory, "package.json");
-	if (!fs.existsSync(packageJsonPath)) return false;
+	if (!isFile(packageJsonPath)) return false;
 	const packageJson = readPackageJson(packageJsonPath);
 	return Array.isArray(packageJson.workspaces) || Boolean(packageJson.workspaces?.packages);
 };
@@ -209,6 +317,10 @@ const findMonorepoRoot = (startDirectory) => {
 	return null;
 };
 
+//#endregion
+//#region src/utils/is-plain-object.ts
+const isPlainObject = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+
 //#endregion
 //#region src/utils/discover-project.ts
 const REACT_COMPILER_PACKAGES = new Set([
@@ -297,16 +409,37 @@ const detectFramework = (dependencies) => {
 	for (const [packageName, frameworkName] of Object.entries(FRAMEWORK_PACKAGES)) if (dependencies[packageName]) return frameworkName;
 	return "unknown";
 };
+const isCatalogReference = (version) => version.startsWith("catalog:");
+const resolveVersionFromCatalog = (catalog, packageName) => {
+	const version = catalog[packageName];
+	if (typeof version === "string" && !isCatalogReference(version)) return version;
+	return null;
+};
+const resolveCatalogVersion = (packageJson, packageName) => {
+	const raw = packageJson;
+	if (isPlainObject(raw.catalog)) {
+		const version = resolveVersionFromCatalog(raw.catalog, packageName);
+		if (version) return version;
+	}
+	if (isPlainObject(raw.catalogs)) {
+		for (const catalogEntries of Object.values(raw.catalogs)) if (isPlainObject(catalogEntries)) {
+			const version = resolveVersionFromCatalog(catalogEntries, packageName);
+			if (version) return version;
+		}
+	}
+	return null;
+};
 const extractDependencyInfo = (packageJson) => {
 	const allDependencies = collectAllDependencies(packageJson);
+	const rawVersion = allDependencies.react ?? null;
 	return {
-		reactVersion: allDependencies.react ?? null,
+		reactVersion: rawVersion && !isCatalogReference(rawVersion) ? rawVersion : null,
 		framework: detectFramework(allDependencies)
 	};
 };
 const parsePnpmWorkspacePatterns = (rootDirectory) => {
 	const workspacePath = path.join(rootDirectory, "pnpm-workspace.yaml");
-	if (!fs.existsSync(workspacePath)) return [];
+	if (!isFile(workspacePath)) return [];
 	const content = fs.readFileSync(workspacePath, "utf-8");
 	const patterns = [];
 	let isInsidePackagesBlock = false;
@@ -332,14 +465,14 @@ const resolveWorkspaceDirectories = (rootDirectory, pattern) => {
 	const cleanPattern = pattern.replace(/["']/g, "").replace(/\/\*\*$/, "/*");
 	if (!cleanPattern.includes("*")) {
 		const directoryPath = path.join(rootDirectory, cleanPattern);
-		if (fs.existsSync(directoryPath) && fs.existsSync(path.join(directoryPath, "package.json"))) return [directoryPath];
+		if (fs.existsSync(directoryPath) && isFile(path.join(directoryPath, "package.json"))) return [directoryPath];
 		return [];
 	}
 	const wildcardIndex = cleanPattern.indexOf("*");
 	const baseDirectory = path.join(rootDirectory, cleanPattern.slice(0, wildcardIndex));
 	const suffixAfterWildcard = cleanPattern.slice(wildcardIndex + 1);
 	if (!fs.existsSync(baseDirectory) || !fs.statSync(baseDirectory).isDirectory()) return [];
-	return fs.readdirSync(baseDirectory).map((entry) => path.join(baseDirectory, entry, suffixAfterWildcard)).filter((entryPath) => fs.existsSync(entryPath) && fs.statSync(entryPath).isDirectory() && fs.existsSync(path.join(entryPath, "package.json")));
+	return fs.readdirSync(baseDirectory).map((entry) => path.join(baseDirectory, entry, suffixAfterWildcard)).filter((entryPath) => fs.existsSync(entryPath) && fs.statSync(entryPath).isDirectory() && isFile(path.join(entryPath, "package.json")));
 };
 const findDependencyInfoFromMonorepoRoot = (directory) => {
 	const monorepoRoot = findMonorepoRoot(directory);
@@ -347,11 +480,17 @@ const findDependencyInfoFromMonorepoRoot = (directory) => {
 		reactVersion: null,
 		framework: "unknown"
 	};
-	const rootPackageJson = readPackageJson(path.join(monorepoRoot, "package.json"));
+	const monorepoPackageJsonPath = path.join(monorepoRoot, "package.json");
+	if (!isFile(monorepoPackageJsonPath)) return {
+		reactVersion: null,
+		framework: "unknown"
+	};
+	const rootPackageJson = readPackageJson(monorepoPackageJsonPath);
 	const rootInfo = extractDependencyInfo(rootPackageJson);
+	const catalogVersion = resolveCatalogVersion(rootPackageJson, "react");
 	const workspaceInfo = findReactInWorkspaces(monorepoRoot, rootPackageJson);
 	return {
-		reactVersion: rootInfo.reactVersion ?? workspaceInfo.reactVersion,
+		reactVersion: rootInfo.reactVersion ?? catalogVersion ?? workspaceInfo.reactVersion,
 		framework: rootInfo.framework !== "unknown" ? rootInfo.framework : workspaceInfo.framework
 	};
 };
@@ -377,7 +516,7 @@ const hasCompilerPackage = (packageJson) => {
 	return Object.keys(allDependencies).some((packageName) => REACT_COMPILER_PACKAGES.has(packageName));
 };
 const fileContainsPattern = (filePath, pattern) => {
-	if (!fs.existsSync(filePath)) return false;
+	if (!isFile(filePath)) return false;
 	const content = fs.readFileSync(filePath, "utf-8");
 	return pattern.test(content);
 };
@@ -391,7 +530,7 @@ const detectReactCompiler = (directory, packageJson) => {
 	let ancestorDirectory = path.dirname(directory);
 	while (ancestorDirectory !== path.dirname(ancestorDirectory)) {
 		const ancestorPackagePath = path.join(ancestorDirectory, "package.json");
-		if (fs.existsSync(ancestorPackagePath)) {
+		if (isFile(ancestorPackagePath)) {
 			if (hasCompilerPackage(readPackageJson(ancestorPackagePath))) return true;
 		}
 		ancestorDirectory = path.dirname(ancestorDirectory);
@@ -400,9 +539,10 @@ const detectReactCompiler = (directory, packageJson) => {
 };
 const discoverProject = (directory) => {
 	const packageJsonPath = path.join(directory, "package.json");
-	if (!fs.existsSync(packageJsonPath)) throw new Error(`No package.json found in ${directory}`);
+	if (!isFile(packageJsonPath)) throw new Error(`No package.json found in ${directory}`);
 	const packageJson = readPackageJson(packageJsonPath);
 	let { reactVersion, framework } = extractDependencyInfo(packageJson);
+	if (!reactVersion) reactVersion = resolveCatalogVersion(packageJson, "react");
 	if (!reactVersion || framework === "unknown") {
 		const workspaceInfo = findReactInWorkspaces(directory, packageJson);
 		if (!reactVersion && workspaceInfo.reactVersion) reactVersion = workspaceInfo.reactVersion;
@@ -432,10 +572,9 @@ const discoverProject = (directory) => {
 //#region src/utils/load-config.ts
 const CONFIG_FILENAME = "react-doctor.config.json";
 const PACKAGE_JSON_CONFIG_KEY = "reactDoctor";
-const isPlainObject = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
 const loadConfig = (rootDirectory) => {
 	const configFilePath = path.join(rootDirectory, CONFIG_FILENAME);
-	if (fs.existsSync(configFilePath)) try {
+	if (isFile(configFilePath)) try {
 		const fileContent = fs.readFileSync(configFilePath, "utf-8");
 		const parsed = JSON.parse(fileContent);
 		if (isPlainObject(parsed)) return parsed;
@@ -444,7 +583,7 @@ const loadConfig = (rootDirectory) => {
 		console.warn(`Warning: Failed to parse ${CONFIG_FILENAME}: ${error instanceof Error ? error.message : String(error)}`);
 	}
 	const packageJsonPath = path.join(rootDirectory, "package.json");
-	if (fs.existsSync(packageJsonPath)) try {
+	if (isFile(packageJsonPath)) try {
 		const fileContent = fs.readFileSync(packageJsonPath, "utf-8");
 		const embeddedConfig = JSON.parse(fileContent)[PACKAGE_JSON_CONFIG_KEY];
 		if (isPlainObject(embeddedConfig)) return embeddedConfig;
@@ -542,7 +681,7 @@ const runKnip = async (rootDirectory) => {
 	let knipResult;
 	if (monorepoRoot) {
 		const packageJsonPath = path.join(rootDirectory, "package.json");
-		const workspaceName = (fs.existsSync(packageJsonPath) ? JSON.parse(fs.readFileSync(packageJsonPath, "utf-8")) : {}).name ?? path.basename(rootDirectory);
+		const workspaceName = (isFile(packageJsonPath) ? JSON.parse(fs.readFileSync(packageJsonPath, "utf-8")) : {}).name ?? path.basename(rootDirectory);
 		try {
 			knipResult = await runKnipWithOptions(monorepoRoot, workspaceName);
 		} catch {
@@ -825,7 +964,7 @@ const RULE_CATEGORY_MAP = {
 	"react-doctor/rn-no-single-element-style-array": "React Native"
 };
 const RULE_HELP_MAP = {
-	"no-derived-state-effect": "For derived state, compute inline: `const x = fn(dep)`. For state resets on prop change, use a key prop: `<Component key={prop} />`",
+	"no-derived-state-effect": "For derived state, compute inline: `const x = fn(dep)`. For state resets on prop change, use a key prop: `<Component key={prop} />`. See https://react.dev/learn/you-might-not-need-an-effect",
 	"no-fetch-in-effect": "Use `useQuery()` from @tanstack/react-query, `useSWR()`, or fetch in a Server Component instead",
 	"no-cascading-set-state": "Combine into useReducer: `const [state, dispatch] = useReducer(reducer, initialState)`",
 	"no-effect-event-handler": "Move the conditional logic into onClick, onChange, or onSubmit handlers directly",
@@ -865,7 +1004,7 @@ const RULE_HELP_MAP = {
 	"nextjs-no-use-search-params-without-suspense": "Wrap the component using useSearchParams: `<Suspense fallback={<Skeleton />}><SearchComponent /></Suspense>`",
 	"nextjs-no-client-fetch-for-server-data": "Remove 'use client' and fetch directly in the Server Component — no API round-trip, secrets stay on server",
 	"nextjs-missing-metadata": "Add `export const metadata = { title: '...', description: '...' }` or `export async function generateMetadata()`",
-	"nextjs-no-client-side-redirect": "Use `redirect('/path')` from 'next/navigation' in a Server Component, or handle in middleware",
+	"nextjs-no-client-side-redirect": "Use `redirect('/path')` from 'next/navigation' directly (works in both server and client components), or handle in middleware",
 	"nextjs-no-redirect-in-try-catch": "Move the redirect/notFound call outside the try block, or add `unstable_rethrow(error)` in the catch",
 	"nextjs-image-missing-sizes": "Add sizes for responsive behavior: `sizes=\"(max-width: 768px) 100vw, 50vw\"` matching your layout breakpoints",
 	"nextjs-no-native-script": "`import Script from \"next/script\"` — use `strategy=\"afterInteractive\"` for analytics or `\"lazyOnload\"` for widgets",
@@ -953,7 +1092,14 @@ const spawnOxlint = (args, rootDirectory, nodeBinaryPath) => new Promise((resolv
 	child.stdout.on("data", (buffer) => stdoutBuffers.push(buffer));
 	child.stderr.on("data", (buffer) => stderrBuffers.push(buffer));
 	child.on("error", (error) => reject(/* @__PURE__ */ new Error(`Failed to run oxlint: ${error.message}`)));
-	child.on("close", () => {
+	child.on("close", (code, signal) => {
+		if (signal) {
+			const stderrOutput = Buffer.concat(stderrBuffers).toString("utf-8").trim();
+			const hint = signal === "SIGABRT" ? " (out of memory — try scanning fewer files with --diff)" : "";
+			const detail = stderrOutput ? `: ${stderrOutput}` : "";
+			reject(/* @__PURE__ */ new Error(`oxlint was killed by ${signal}${hint}${detail}`));
+			return;
+		}
 		const output = Buffer.concat(stdoutBuffers).toString("utf-8").trim();
 		if (!output) {
 			const stderrOutput = Buffer.concat(stderrBuffers).toString("utf-8").trim();