react-doctor 0.0.19 → 0.0.21

package/dist/cli.js

@@ -28,8 +28,10 @@ const SUMMARY_BOX_HORIZONTAL_PADDING_CHARS = 1;
 const SUMMARY_BOX_OUTER_INDENT_CHARS = 2;
 const SCORE_API_URL = "https://www.react.doctor/api/score";
 const SHARE_BASE_URL = "https://www.react.doctor/share";
+const OPEN_BASE_URL = "https://www.react.doctor/open";
 const GIT_LS_FILES_MAX_BUFFER_BYTES = 50 * 1024 * 1024;
 const OFFLINE_MESSAGE = "You are offline, could not calculate score. Reconnect to calculate.";
+const OFFLINE_FLAG_MESSAGE = "Score not calculated. Remove --offline to calculate score.";
 const DEFAULT_BRANCH_CANDIDATES = ["main", "master"];
 
 //#endregion
@@ -765,6 +767,46 @@ const createOxlintConfig = ({ pluginPath, framework, hasReactCompiler }) => ({
 	}
 });
 
+//#endregion
+//#region src/utils/neutralize-disable-directives.ts
+const findFilesWithDisableDirectives = (rootDirectory) => {
+	const result = spawnSync("git", [
+		"grep",
+		"-l",
+		"--untracked",
+		"-E",
+		"(eslint|oxlint)-disable"
+	], {
+		cwd: rootDirectory,
+		encoding: "utf-8",
+		maxBuffer: GIT_LS_FILES_MAX_BUFFER_BYTES
+	});
+	if (result.error || result.status === null) return [];
+	return result.stdout.split("\n").filter((filePath) => filePath.length > 0 && SOURCE_FILE_PATTERN.test(filePath));
+};
+const neutralizeContent = (content) => content.replaceAll("eslint-disable", "eslint_disable").replaceAll("oxlint-disable", "oxlint_disable");
+const neutralizeDisableDirectives = (rootDirectory) => {
+	const filePaths = findFilesWithDisableDirectives(rootDirectory);
+	const originalContents = /* @__PURE__ */ new Map();
+	for (const relativePath of filePaths) {
+		const absolutePath = path.join(rootDirectory, relativePath);
+		let originalContent;
+		try {
+			originalContent = fs.readFileSync(absolutePath, "utf-8");
+		} catch {
+			continue;
+		}
+		const neutralizedContent = neutralizeContent(originalContent);
+		if (neutralizedContent !== originalContent) {
+			originalContents.set(absolutePath, originalContent);
+			fs.writeFileSync(absolutePath, neutralizedContent);
+		}
+	}
+	return () => {
+		for (const [absolutePath, originalContent] of originalContents) fs.writeFileSync(absolutePath, originalContent);
+	};
+};
+
 //#endregion
 //#region src/utils/run-oxlint.ts
 const esmRequire = createRequire(import.meta.url);
@@ -832,7 +874,7 @@ const RULE_CATEGORY_MAP = {
 	"react-doctor/async-parallel": "Performance"
 };
 const RULE_HELP_MAP = {
-	"no-derived-state-effect": "Compute during render: `const derived = computeFrom(dep1, dep2)` — no useEffect needed",
+	"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-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",
@@ -934,6 +976,7 @@ const runOxlint = async (rootDirectory, hasTypeScript, framework, hasReactCompil
 		framework,
 		hasReactCompiler
 	});
+	const restoreDisableDirectives = neutralizeDisableDirectives(rootDirectory);
 	try {
 		fs.writeFileSync(configPath, JSON.stringify(config, null, 2));
 		const args = [
@@ -989,6 +1032,7 @@ const runOxlint = async (rootDirectory, hasTypeScript, framework, hasReactCompil
 			};
 		});
 	} finally {
+		restoreDisableDirectives();
 		if (fs.existsSync(configPath)) fs.unlinkSync(configPath);
 	}
 };
@@ -1170,7 +1214,7 @@ const buildShareUrl = (diagnostics, scoreResult, projectName) => {
 	if (affectedFileCount > 0) params.set("f", String(affectedFileCount));
 	return `${SHARE_BASE_URL}?${params.toString()}`;
 };
-const printSummary = (diagnostics, elapsedMilliseconds, scoreResult, projectName, totalSourceFileCount) => {
+const printSummary = (diagnostics, elapsedMilliseconds, scoreResult, projectName, totalSourceFileCount, noScoreMessage) => {
 	const errorCount = diagnostics.filter((diagnostic) => diagnostic.severity === "error").length;
 	const warningCount = diagnostics.filter((diagnostic) => diagnostic.severity === "warning").length;
 	const affectedFileCount = collectAffectedFiles(diagnostics).size;
@@ -1212,7 +1256,7 @@ const printSummary = (diagnostics, elapsedMilliseconds, scoreResult, projectName
 	} else {
 		summaryFramedLines.push(createFramedLine("React Doctor (www.react.doctor)", `React Doctor ${highlighter.dim("(www.react.doctor)")}`));
 		summaryFramedLines.push(createFramedLine(""));
-		summaryFramedLines.push(createFramedLine(OFFLINE_MESSAGE, highlighter.dim(OFFLINE_MESSAGE)));
+		summaryFramedLines.push(createFramedLine(noScoreMessage, highlighter.dim(noScoreMessage)));
 		summaryFramedLines.push(createFramedLine(""));
 	}
 	summaryFramedLines.push(createFramedLine(summaryLinePartsPlain.join("  "), summaryLineParts.join("  ")));
@@ -1237,6 +1281,7 @@ const scan = async (directory, inputOptions = {}) => {
 		deadCode: inputOptions.deadCode ?? userConfig?.deadCode ?? true,
 		verbose: inputOptions.verbose ?? userConfig?.verbose ?? false,
 		scoreOnly: inputOptions.scoreOnly ?? false,
+		offline: inputOptions.offline ?? false,
 		includePaths: inputOptions.includePaths
 	};
 	const includePaths = options.includePaths ?? [];
@@ -1266,7 +1311,10 @@ const scan = async (directory, inputOptions = {}) => {
 			return lintDiagnostics;
 		} catch (error) {
 			lintSpinner?.fail("Lint checks failed (non-fatal, skipping).");
-			logger.error(String(error));
+			if (error instanceof Error) {
+				logger.error(error.message);
+				if (error.stack) logger.dim(error.stack);
+			} else logger.error(String(error));
 			return [];
 		}
 	})() : Promise.resolve([]);
@@ -1290,10 +1338,11 @@ const scan = async (directory, inputOptions = {}) => {
 	];
 	const diagnostics = userConfig ? filterIgnoredDiagnostics(allDiagnostics, userConfig) : allDiagnostics;
 	const elapsedMilliseconds = performance.now() - startTime;
-	const scoreResult = await calculateScore(diagnostics);
+	const scoreResult = options.offline ? null : await calculateScore(diagnostics);
+	const noScoreMessage = options.offline ? OFFLINE_FLAG_MESSAGE : OFFLINE_MESSAGE;
 	if (options.scoreOnly) {
 		if (scoreResult) logger.log(`${scoreResult.score}`);
-		else logger.dim(OFFLINE_MESSAGE);
+		else logger.dim(noScoreMessage);
 		return;
 	}
 	if (diagnostics.length === 0) {
@@ -1302,12 +1351,12 @@ const scan = async (directory, inputOptions = {}) => {
 		if (scoreResult) {
 			printBranding(scoreResult.score);
 			printScoreGauge(scoreResult.score, scoreResult.label);
-		} else logger.dim(`  ${OFFLINE_MESSAGE}`);
+		} else logger.dim(`  ${noScoreMessage}`);
 		return;
 	}
 	printDiagnostics(diagnostics, options.verbose);
 	const displayedSourceFileCount = isDiffMode ? includePaths.length : projectInfo.sourceFileCount;
-	printSummary(diagnostics, elapsedMilliseconds, scoreResult, projectInfo.projectName, displayedSourceFileCount);
+	printSummary(diagnostics, elapsedMilliseconds, scoreResult, projectInfo.projectName, displayedSourceFileCount, noScoreMessage);
 };
 
 //#endregion
@@ -1614,7 +1663,7 @@ const maybePromptSkillInstall = async (shouldSkipPrompts) => {
 
 //#endregion
 //#region src/cli.ts
-const VERSION = "0.0.19";
+const VERSION = "0.0.21";
 process.on("SIGINT", () => process.exit(0));
 process.on("SIGTERM", () => process.exit(0));
 const resolveDiffMode = async (diffInfo, effectiveDiff, shouldSkipPrompts, isScoreOnly) => {
@@ -1639,7 +1688,7 @@ const resolveDiffMode = async (diffInfo, effectiveDiff, shouldSkipPrompts, isSco
 	});
 	return Boolean(shouldScanBranchOnly);
 };
-const program = new Command().name("react-doctor").description("Diagnose React codebase health").version(VERSION, "-v, --version", "display the version number").argument("[directory]", "project directory to scan", ".").option("--no-lint", "skip linting").option("--no-dead-code", "skip dead code detection").option("--verbose", "show file details per rule").option("--score", "output only the score").option("-y, --yes", "skip prompts, scan all workspace projects").option("--project <name>", "select workspace project (comma-separated for multiple)").option("--diff [base]", "scan only files changed vs base branch").option("--fix", "open Ami to auto-fix all issues").option("--prompt", "copy latest scan output to clipboard").action(async (directory, flags) => {
+const program = new Command().name("react-doctor").description("Diagnose React codebase health").version(VERSION, "-v, --version", "display the version number").argument("[directory]", "project directory to scan", ".").option("--no-lint", "skip linting").option("--no-dead-code", "skip dead code detection").option("--verbose", "show file details per rule").option("--score", "output only the score").option("-y, --yes", "skip prompts, scan all workspace projects").option("--project <name>", "select workspace project (comma-separated for multiple)").option("--diff [base]", "scan only files changed vs base branch").option("--offline", "skip telemetry (anonymous, not stored, only used to calculate score)").option("--fix", "open Ami to auto-fix all issues").option("--prompt", "copy latest scan output to clipboard").action(async (directory, flags) => {
 	const isScoreOnly = flags.score && !flags.prompt;
 	const shouldCopyPromptOutput = flags.prompt;
 	if (shouldCopyPromptOutput) startLoggerCapture();
@@ -1655,7 +1704,8 @@ const program = new Command().name("react-doctor").description("Diagnose React c
 			lint: isCliOverride("lint") ? flags.lint : userConfig?.lint ?? flags.lint,
 			deadCode: isCliOverride("deadCode") ? flags.deadCode : userConfig?.deadCode ?? flags.deadCode,
 			verbose: flags.prompt || (isCliOverride("verbose") ? Boolean(flags.verbose) : userConfig?.verbose ?? false),
-			scoreOnly: isScoreOnly
+			scoreOnly: isScoreOnly,
+			offline: flags.offline
 		};
 		const isAutomatedEnvironment = [
 			process.env.CI,
@@ -1753,12 +1803,20 @@ const openUrl = (url) => {
 	}
 	execSync(process.platform === "darwin" ? `open "${url}"` : `xdg-open "${url}"`, { stdio: "ignore" });
 };
-const buildDeeplink = (directory) => {
-	return `ami://open-project?cwd=${encodeURIComponent(path.resolve(directory))}&prompt=${encodeURIComponent(DEEPLINK_FIX_PROMPT)}&mode=agent&autoSubmit=true`;
-};
+const buildDeeplinkParams = (directory) => {
+	const params = new URLSearchParams();
+	params.set("cwd", path.resolve(directory));
+	params.set("prompt", DEEPLINK_FIX_PROMPT);
+	params.set("mode", "agent");
+	params.set("autoSubmit", "true");
+	return params;
+};
+const buildDeeplink = (directory) => `ami://open-project?${buildDeeplinkParams(directory).toString()}`;
+const buildWebDeeplink = (directory) => `${OPEN_BASE_URL}?${buildDeeplinkParams(directory).toString()}`;
 const openAmiToFix = (directory) => {
 	const isInstalled = isAmiInstalled();
 	const deeplink = buildDeeplink(directory);
+	const webDeeplink = buildWebDeeplink(directory);
 	if (!isInstalled) {
 		if (process.platform === "darwin") {
 			installAmi();
@@ -1769,7 +1827,7 @@ const openAmiToFix = (directory) => {
 		}
 		logger.break();
 		logger.dim("Once Ami is running, open this link to start fixing:");
-		logger.info(deeplink);
+		logger.info(webDeeplink);
 		return;
 	}
 	logger.log("Opening Ami to fix react-doctor issues...");
@@ -1779,7 +1837,7 @@ const openAmiToFix = (directory) => {
 	} catch {
 		logger.break();
 		logger.dim("Could not open Ami automatically. Open this URL manually:");
-		logger.info(deeplink);
+		logger.info(webDeeplink);
 	}
 };
 const buildPromptWithOutput = (reactDoctorOutput) => {