react-doctor 0.0.28 → 0.0.29

package/README.md

@@ -48,6 +48,29 @@ curl -fsSL https://react.doctor/install-skill.sh | bash
 
 Supports Cursor, Claude Code, Amp Code, Codex, Gemini CLI, OpenCode, Windsurf, and Antigravity.
 
+## GitHub Actions
+
+```yaml
+- uses: actions/checkout@v5
+  with:
+    fetch-depth: 0 # required for --diff
+- uses: millionco/react-doctor@main
+  with:
+    diff: main
+    github-token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+| Input          | Default | Description                                                       |
+| -------------- | ------- | ----------------------------------------------------------------- |
+| `directory`    | `.`     | Project directory to scan                                         |
+| `verbose`      | `true`  | Show file details per rule                                        |
+| `project`      |         | Workspace project(s) to scan (comma-separated)                    |
+| `diff`         |         | Base branch for diff mode. Only changed files are scanned         |
+| `github-token` |         | When set on `pull_request` events, posts findings as a PR comment |
+| `node-version` | `20`    | Node.js version to use                                            |
+
+The action outputs a `score` (0–100) you can use in subsequent steps.
+
 ## Options
 
 ```

package/dist/cli.js

@@ -283,6 +283,7 @@ const combineDiagnostics = (lintDiagnostics, deadCodeDiagnostics, directory, isD
 //#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;
 	const packageJsonPath = path.join(directory, "package.json");
 	if (!fs.existsSync(packageJsonPath)) return false;
 	const packageJson = readPackageJson(packageJsonPath);
@@ -335,7 +336,9 @@ const FRAMEWORK_PACKAGES = {
 	vite: "vite",
 	"react-scripts": "cra",
 	"@remix-run/react": "remix",
-	gatsby: "gatsby"
+	gatsby: "gatsby",
+	expo: "expo",
+	"react-native": "react-native"
 };
 const FRAMEWORK_DISPLAY_NAMES = {
 	nextjs: "Next.js",
@@ -343,10 +346,34 @@ const FRAMEWORK_DISPLAY_NAMES = {
 	cra: "Create React App",
 	remix: "Remix",
 	gatsby: "Gatsby",
+	expo: "Expo",
+	"react-native": "React Native",
 	unknown: "React"
 };
 const formatFrameworkName = (framework) => FRAMEWORK_DISPLAY_NAMES[framework];
-const countSourceFiles = (rootDirectory) => {
+const IGNORED_DIRECTORIES = new Set([
+	"node_modules",
+	"dist",
+	"build",
+	"coverage"
+]);
+const countSourceFilesViaFilesystem = (rootDirectory) => {
+	let count = 0;
+	const stack = [rootDirectory];
+	while (stack.length > 0) {
+		const currentDirectory = stack.pop();
+		const entries = fs.readdirSync(currentDirectory, { withFileTypes: true });
+		for (const entry of entries) {
+			if (entry.isDirectory()) {
+				if (!entry.name.startsWith(".") && !IGNORED_DIRECTORIES.has(entry.name)) stack.push(path.join(currentDirectory, entry.name));
+				continue;
+			}
+			if (entry.isFile() && SOURCE_FILE_PATTERN.test(entry.name)) count++;
+		}
+	}
+	return count;
+};
+const countSourceFilesViaGit = (rootDirectory) => {
 	const result = spawnSync("git", [
 		"ls-files",
 		"--cached",
@@ -357,9 +384,10 @@ const countSourceFiles = (rootDirectory) => {
 		encoding: "utf-8",
 		maxBuffer: GIT_LS_FILES_MAX_BUFFER_BYTES
 	});
-	if (result.error || result.status !== 0) return 0;
+	if (result.error || result.status !== 0) return null;
 	return result.stdout.split("\n").filter((filePath) => filePath.length > 0 && SOURCE_FILE_PATTERN.test(filePath)).length;
 };
+const countSourceFiles = (rootDirectory) => countSourceFilesViaGit(rootDirectory) ?? countSourceFilesViaFilesystem(rootDirectory);
 const collectAllDependencies = (packageJson) => ({
 	...packageJson.peerDependencies,
 	...packageJson.dependencies,
@@ -444,14 +472,30 @@ const findReactInWorkspaces = (rootDirectory, packageJson) => {
 	}
 	return result;
 };
+const REACT_DEPENDENCY_NAMES = new Set([
+	"react",
+	"react-native",
+	"next"
+]);
 const hasReactDependency = (packageJson) => {
 	const allDependencies = collectAllDependencies(packageJson);
-	return Object.keys(allDependencies).some((packageName) => packageName === "next" || packageName.includes("react"));
+	return Object.keys(allDependencies).some((packageName) => REACT_DEPENDENCY_NAMES.has(packageName));
 };
 const discoverReactSubprojects = (rootDirectory) => {
 	if (!fs.existsSync(rootDirectory) || !fs.statSync(rootDirectory).isDirectory()) return [];
-	const entries = fs.readdirSync(rootDirectory, { withFileTypes: true });
 	const packages = [];
+	const rootPackageJsonPath = path.join(rootDirectory, "package.json");
+	if (fs.existsSync(rootPackageJsonPath)) {
+		const rootPackageJson = readPackageJson(rootPackageJsonPath);
+		if (hasReactDependency(rootPackageJson)) {
+			const name = rootPackageJson.name ?? path.basename(rootDirectory);
+			packages.push({
+				name,
+				directory: rootDirectory
+			});
+		}
+	}
+	const entries = fs.readdirSync(rootDirectory, { withFileTypes: true });
 	for (const entry of entries) {
 		if (!entry.isDirectory() || entry.name.startsWith(".") || entry.name === "node_modules") continue;
 		const subdirectory = path.join(rootDirectory, entry.name);
@@ -623,14 +667,10 @@ const loadConfig = (rootDirectory) => {
 	if (fs.existsSync(configFilePath)) try {
 		const fileContent = fs.readFileSync(configFilePath, "utf-8");
 		const parsed = JSON.parse(fileContent);
-		if (!isPlainObject(parsed)) {
-			console.warn(`Warning: ${CONFIG_FILENAME} must be a JSON object, ignoring.`);
-			return null;
-		}
-		return parsed;
+		if (isPlainObject(parsed)) return parsed;
+		console.warn(`Warning: ${CONFIG_FILENAME} must be a JSON object, ignoring.`);
 	} catch (error) {
 		console.warn(`Warning: Failed to parse ${CONFIG_FILENAME}: ${error instanceof Error ? error.message : String(error)}`);
-		return null;
 	}
 	const packageJsonPath = path.join(rootDirectory, "package.json");
 	if (fs.existsSync(packageJsonPath)) try {
@@ -862,11 +902,15 @@ const CONFIG_LOADING_ERROR_PATTERN = /Error loading .*\/([a-z-]+)\.config\./;
 const extractFailedPluginName = (error) => {
 	return String(error).match(CONFIG_LOADING_ERROR_PATTERN)?.[1] ?? null;
 };
+const TSCONFIG_FILENAMES = ["tsconfig.base.json", "tsconfig.json"];
+const resolveTsConfigFile = (directory) => TSCONFIG_FILENAMES.find((filename) => fs.existsSync(path.join(directory, filename)));
 const runKnipWithOptions = async (knipCwd, workspaceName) => {
+	const tsConfigFile = resolveTsConfigFile(knipCwd);
 	const options = await silenced(() => createOptions({
 		cwd: knipCwd,
 		isShowProgress: false,
-		...workspaceName ? { workspace: workspaceName } : {}
+		...workspaceName ? { workspace: workspaceName } : {},
+		...tsConfigFile ? { tsConfigFile } : {}
 	}));
 	const parsedConfig = options.parsedConfig;
 	for (let attempt = 0; attempt <= MAX_KNIP_RETRIES; attempt++) try {
@@ -938,6 +982,16 @@ const NEXTJS_RULES = {
 	"react-doctor/nextjs-no-head-import": "error",
 	"react-doctor/nextjs-no-side-effect-in-get-handler": "error"
 };
+const REACT_NATIVE_RULES = {
+	"react-doctor/rn-no-raw-text": "error",
+	"react-doctor/rn-no-deprecated-modules": "error",
+	"react-doctor/rn-no-legacy-expo-packages": "warn",
+	"react-doctor/rn-no-dimensions-get": "warn",
+	"react-doctor/rn-no-inline-flatlist-renderitem": "warn",
+	"react-doctor/rn-no-legacy-shadow-styles": "warn",
+	"react-doctor/rn-prefer-reanimated": "warn",
+	"react-doctor/rn-no-single-element-style-array": "warn"
+};
 const REACT_COMPILER_RULES = {
 	"react-hooks-js/set-state-in-render": "error",
 	"react-hooks-js/immutability": "error",
@@ -1041,7 +1095,8 @@ const createOxlintConfig = ({ pluginPath, framework, hasReactCompiler }) => ({
 		"react-doctor/server-after-nonblocking": "warn",
 		"react-doctor/client-passive-event-listeners": "warn",
 		"react-doctor/async-parallel": "warn",
-		...framework === "nextjs" ? NEXTJS_RULES : {}
+		...framework === "nextjs" ? NEXTJS_RULES : {},
+		...framework === "expo" || framework === "react-native" ? REACT_NATIVE_RULES : {}
 	}
 });
 
@@ -1149,7 +1204,15 @@ const RULE_CATEGORY_MAP = {
 	"react-doctor/server-auth-actions": "Server",
 	"react-doctor/server-after-nonblocking": "Server",
 	"react-doctor/client-passive-event-listeners": "Performance",
-	"react-doctor/async-parallel": "Performance"
+	"react-doctor/async-parallel": "Performance",
+	"react-doctor/rn-no-raw-text": "React Native",
+	"react-doctor/rn-no-deprecated-modules": "React Native",
+	"react-doctor/rn-no-legacy-expo-packages": "React Native",
+	"react-doctor/rn-no-dimensions-get": "React Native",
+	"react-doctor/rn-no-inline-flatlist-renderitem": "React Native",
+	"react-doctor/rn-no-legacy-shadow-styles": "React Native",
+	"react-doctor/rn-prefer-reanimated": "React Native",
+	"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} />`",
@@ -1205,7 +1268,15 @@ const RULE_HELP_MAP = {
 	"server-auth-actions": "Add `const session = await auth()` at the top and throw/redirect if unauthorized before any data access",
 	"server-after-nonblocking": "`import { after } from 'next/server'` then wrap: `after(() => analytics.track(...))` — response isn't blocked",
 	"client-passive-event-listeners": "Add `{ passive: true }` as the third argument: `addEventListener('scroll', handler, { passive: true })`",
-	"async-parallel": "Use `const [a, b] = await Promise.all([fetchA(), fetchB()])` to run independent operations concurrently"
+	"async-parallel": "Use `const [a, b] = await Promise.all([fetchA(), fetchB()])` to run independent operations concurrently",
+	"rn-no-raw-text": "Wrap text in a `<Text>` component: `<Text>{value}</Text>` — raw strings outside `<Text>` crash on React Native",
+	"rn-no-deprecated-modules": "Import from the community package instead — deprecated modules were removed from the react-native core",
+	"rn-no-legacy-expo-packages": "Migrate to the recommended replacement package — legacy Expo packages are no longer maintained",
+	"rn-no-dimensions-get": "Use `const { width, height } = useWindowDimensions()` — it updates reactively on rotation and resize",
+	"rn-no-inline-flatlist-renderitem": "Extract renderItem to a named function or wrap in useCallback to avoid re-creating on every render",
+	"rn-no-legacy-shadow-styles": "Use `boxShadow` for cross-platform shadows on the new architecture instead of platform-specific shadow properties",
+	"rn-prefer-reanimated": "Use `import Animated from 'react-native-reanimated'` — animations run on the UI thread instead of the JS thread",
+	"rn-no-single-element-style-array": "Use `style={value}` instead of `style={[value]}` — single-element arrays add unnecessary allocation"
 };
 const FILEPATH_WITH_LOCATION_PATTERN = /\S+\.\w+:\d+:\d+[\s\S]*$/;
 const REACT_COMPILER_MESSAGE = "React Compiler can't optimize this code";
@@ -1639,13 +1710,15 @@ const scan = async (directory, inputOptions = {}) => {
 			return lintDiagnostics;
 		} catch (error) {
 			didLintFail = true;
-			const errorMessage = error instanceof Error ? error.message : String(error);
-			if (errorMessage.includes("native binding")) {
-				lintSpinner?.fail(`Lint checks failed — oxlint native binding not found (Node ${process.version}).`);
-				logger.dim(`  Upgrade to Node ${OXLINT_NODE_REQUIREMENT} or run: npx -p oxlint@latest react-doctor@latest`);
-			} else {
-				lintSpinner?.fail("Lint checks failed (non-fatal, skipping).");
-				logger.error(errorMessage);
+			if (!options.scoreOnly) {
+				const errorMessage = error instanceof Error ? error.message : String(error);
+				if (errorMessage.includes("native binding")) {
+					lintSpinner?.fail(`Lint checks failed — oxlint native binding not found (Node ${process.version}).`);
+					logger.dim(`  Upgrade to Node ${OXLINT_NODE_REQUIREMENT} or run: npx -p oxlint@latest react-doctor@latest`);
+				} else {
+					lintSpinner?.fail("Lint checks failed (non-fatal, skipping).");
+					logger.error(errorMessage);
+				}
 			}
 			return [];
 		}
@@ -1658,8 +1731,10 @@ const scan = async (directory, inputOptions = {}) => {
 			return knipDiagnostics;
 		} catch (error) {
 			didDeadCodeFail = true;
-			deadCodeSpinner?.fail("Dead code detection failed (non-fatal, skipping).");
-			logger.error(String(error));
+			if (!options.scoreOnly) {
+				deadCodeSpinner?.fail("Dead code detection failed (non-fatal, skipping).");
+				logger.error(String(error));
+			}
 			return [];
 		}
 	})() : Promise.resolve([]);
@@ -2029,7 +2104,18 @@ const maybePromptSkillInstall = async (shouldSkipPrompts) => {
 
 //#endregion
 //#region src/cli.ts
-const VERSION = "0.0.28";
+const VERSION = "0.0.29";
+const VALID_FAIL_ON_LEVELS = new Set([
+	"error",
+	"warning",
+	"none"
+]);
+const isValidFailOnLevel = (level) => VALID_FAIL_ON_LEVELS.has(level);
+const shouldFailForDiagnostics = (diagnostics, failOnLevel) => {
+	if (failOnLevel === "none") return false;
+	if (failOnLevel === "warning") return diagnostics.length > 0;
+	return diagnostics.some((diagnostic) => diagnostic.severity === "error");
+};
 const exitWithFixHint = () => {
 	logger.break();
 	logger.log("Cancelled.");
@@ -2052,8 +2138,8 @@ const isAutomatedEnvironment = () => AUTOMATED_ENVIRONMENT_VARIABLES.some((envVa
 const resolveCliScanOptions = (flags, userConfig, programInstance) => {
 	const isCliOverride = (optionName) => programInstance.getOptionValueSource(optionName) === "cli";
 	return {
-		lint: isCliOverride("lint") ? flags.lint : userConfig?.lint ?? flags.lint,
-		deadCode: isCliOverride("deadCode") ? flags.deadCode : userConfig?.deadCode ?? flags.deadCode,
+		lint: isCliOverride("lint") ? flags.lint : userConfig?.lint ?? true,
+		deadCode: isCliOverride("deadCode") ? flags.deadCode : userConfig?.deadCode ?? true,
 		verbose: isCliOverride("verbose") ? Boolean(flags.verbose) : userConfig?.verbose ?? false,
 		scoreOnly: flags.score,
 		offline: flags.offline
@@ -2081,7 +2167,7 @@ const resolveDiffMode = async (diffInfo, effectiveDiff, shouldSkipPrompts, isSco
 	});
 	return Boolean(shouldScanChangedOnly);
 };
-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("--no-ami", "skip Ami-related prompts").option("--fix", "open Ami to auto-fix all issues").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("--lint", "enable linting").option("--no-lint", "skip linting").option("--dead-code", "enable dead code detection").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("--no-ami", "skip Ami-related prompts").option("--fail-on <level>", "exit with error code on diagnostics: error, warning, none", "none").option("--fix", "open Ami to auto-fix all issues").action(async (directory, flags) => {
 	const isScoreOnly = flags.score;
 	try {
 		const resolvedDirectory = path.resolve(directory);
@@ -2131,6 +2217,8 @@ const program = new Command().name("react-doctor").description("Diagnose React c
 			allDiagnostics.push(...scanResult.diagnostics);
 			if (!isScoreOnly) logger.break();
 		}
+		const resolvedFailOn = program.getOptionValueSource("failOn") === "cli" ? flags.failOn : userConfig?.failOn ?? flags.failOn;
+		if (shouldFailForDiagnostics(allDiagnostics, isValidFailOnLevel(resolvedFailOn) ? resolvedFailOn : "none")) process.exitCode = 1;
 		if (flags.fix) openAmiToFix(resolvedDirectory);
 		if (!isScoreOnly && !shouldSkipAmiPrompts && !flags.fix) {
 			await maybePromptSkillInstall(shouldSkipAmiPrompts);
@@ -2193,7 +2281,11 @@ const openAmiToFix = (directory) => {
 	if (!isInstalled) {
 		if (process.platform === "darwin") {
 			installAmi();
-			logger.success("Ami installed successfully.");
+			if (isAmiInstalled()) logger.success("Ami installed successfully.");
+			else {
+				logger.error("Installation could not be verified.");
+				logger.dim(`Install manually at ${highlighter.info(AMI_WEBSITE_URL)}`);
+			}
 		} else {
 			logger.error("Ami is not installed.");
 			logger.dim(`Download at ${highlighter.info(AMI_RELEASES_URL)}`);