react-doctor 0.0.18 → 0.0.20

package/dist/index.d.ts

@@ -25,11 +25,32 @@ interface ScoreResult {
   score: number;
   label: string;
 }
+interface DiffInfo {
+  currentBranch: string;
+  baseBranch: string;
+  changedFiles: string[];
+}
+interface ReactDoctorIgnoreConfig {
+  rules?: string[];
+  files?: string[];
+}
+interface ReactDoctorConfig {
+  ignore?: ReactDoctorIgnoreConfig;
+  lint?: boolean;
+  deadCode?: boolean;
+  verbose?: boolean;
+  diff?: boolean | string;
+}
+//#endregion
+//#region src/utils/get-diff-files.d.ts
+declare const getDiffInfo: (directory: string, explicitBaseBranch?: string) => DiffInfo | null;
+declare const filterSourceFiles: (filePaths: string[]) => string[];
 //#endregion
 //#region src/index.d.ts
 interface DiagnoseOptions {
   lint?: boolean;
   deadCode?: boolean;
+  includePaths?: string[];
 }
 interface DiagnoseResult {
   diagnostics: Diagnostic[];
@@ -39,5 +60,5 @@ interface DiagnoseResult {
 }
 declare const diagnose: (directory: string, options?: DiagnoseOptions) => Promise<DiagnoseResult>;
 //#endregion
-export { DiagnoseOptions, DiagnoseResult, type Diagnostic, type ProjectInfo, type ScoreResult, diagnose };
+export { DiagnoseOptions, DiagnoseResult, type Diagnostic, type DiffInfo, type ProjectInfo, type ReactDoctorConfig, type ScoreResult, diagnose, filterSourceFiles, getDiffInfo };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types.ts","../src/index.ts"],"mappings":";KAAY,SAAA;AAAA,UAEK,WAAA;EACf,aAAA;EACA,WAAA;EACA,YAAA;EACA,SAAA,EAAW,SAAA;EACX,aAAA;EACA,gBAAA;EACA,eAAA;AAAA;AAAA,UAiCe,UAAA;EACf,QAAA;EACA,MAAA;EACA,IAAA;EACA,QAAA;EACA,OAAA;EACA,IAAA;EACA,IAAA;EACA,MAAA;EACA,QAAA;EACA,MAAA;AAAA;AAAA,UA2Be,WAAA;EACf,KAAA;EACA,KAAA;AAAA;;;UCtEe,eAAA;EACf,IAAA;EACA,QAAA;AAAA;AAAA,UAGe,cAAA;EACf,WAAA,EAAa,UAAA;EACb,KAAA,EAAO,WAAA;EACP,OAAA,EAAS,WAAA;EACT,mBAAA;AAAA;AAAA,cAGW,QAAA,GACX,SAAA,UACA,OAAA,GAAS,eAAA,KACR,OAAA,CAAQ,cAAA"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types.ts","../src/utils/get-diff-files.ts","../src/index.ts"],"mappings":";KAAY,SAAA;AAAA,UAEK,WAAA;EACf,aAAA;EACA,WAAA;EACA,YAAA;EACA,SAAA,EAAW,SAAA;EACX,aAAA;EACA,gBAAA;EACA,eAAA;AAAA;AAAA,UAiCe,UAAA;EACf,QAAA;EACA,MAAA;EACA,IAAA;EACA,QAAA;EACA,OAAA;EACA,IAAA;EACA,IAAA;EACA,MAAA;EACA,QAAA;EACA,MAAA;AAAA;AAAA,UA4Be,WAAA;EACf,KAAA;EACA,KAAA;AAAA;AAAA,UAWe,QAAA;EACf,aAAA;EACA,UAAA;EACA,YAAA;AAAA;AAAA,UAqDe,uBAAA;EACf,KAAA;EACA,KAAA;AAAA;AAAA,UAGe,iBAAA;EACf,MAAA,GAAS,uBAAA;EACT,IAAA;EACA,QAAA;EACA,OAAA;EACA,IAAA;AAAA;;;cC/FW,WAAA,GAAe,SAAA,UAAmB,kBAAA,cAA8B,QAAA;AAAA,cAYhE,iBAAA,GAAqB,SAAA;;;UC7DjB,eAAA;EACf,IAAA;EACA,QAAA;EACA,YAAA;AAAA;AAAA,UAGe,cAAA;EACf,WAAA,EAAa,UAAA;EACb,KAAA,EAAO,WAAA;EACP,OAAA,EAAS,WAAA;EACT,mBAAA;AAAA;AAAA,cAGW,QAAA,GACX,SAAA,UACA,OAAA,GAAS,eAAA,KACR,OAAA,CAAQ,cAAA"}

package/dist/index.js

@@ -14,6 +14,7 @@ const JSX_FILE_PATTERN = /\.(tsx|jsx)$/;
 const ERROR_PREVIEW_LENGTH_CHARS = 200;
 const SCORE_API_URL = "https://www.react.doctor/api/score";
 const GIT_LS_FILES_MAX_BUFFER_BYTES = 50 * 1024 * 1024;
+const DEFAULT_BRANCH_CANDIDATES = ["main", "master"];
 
 //#endregion
 //#region src/utils/calculate-score.ts
@@ -136,6 +137,7 @@ const countSourceFiles = (rootDirectory) => {
 	return result.stdout.split("\n").filter((filePath) => filePath.length > 0 && SOURCE_FILE_PATTERN.test(filePath)).length;
 };
 const collectAllDependencies = (packageJson) => ({
+	...packageJson.peerDependencies,
 	...packageJson.dependencies,
 	...packageJson.devDependencies
 });
@@ -286,6 +288,79 @@ const discoverProject = (directory) => {
 	};
 };
 
+//#endregion
+//#region src/utils/match-glob-pattern.ts
+const REGEX_SPECIAL_CHARACTERS = /[.+^${}()|[\]\\]/g;
+const compileGlobPattern = (pattern) => {
+	const normalizedPattern = pattern.replace(/\\/g, "/");
+	let regexSource = "^";
+	let characterIndex = 0;
+	while (characterIndex < normalizedPattern.length) if (normalizedPattern[characterIndex] === "*" && normalizedPattern[characterIndex + 1] === "*") if (normalizedPattern[characterIndex + 2] === "/") {
+		regexSource += "(?:.+/)?";
+		characterIndex += 3;
+	} else {
+		regexSource += ".*";
+		characterIndex += 2;
+	}
+	else if (normalizedPattern[characterIndex] === "*") {
+		regexSource += "[^/]*";
+		characterIndex++;
+	} else if (normalizedPattern[characterIndex] === "?") {
+		regexSource += "[^/]";
+		characterIndex++;
+	} else {
+		regexSource += normalizedPattern[characterIndex].replace(REGEX_SPECIAL_CHARACTERS, "\\$&");
+		characterIndex++;
+	}
+	regexSource += "$";
+	return new RegExp(regexSource);
+};
+
+//#endregion
+//#region src/utils/filter-diagnostics.ts
+const filterIgnoredDiagnostics = (diagnostics, config) => {
+	const ignoredRules = new Set(Array.isArray(config.ignore?.rules) ? config.ignore.rules : []);
+	const ignoredFilePatterns = Array.isArray(config.ignore?.files) ? config.ignore.files.map(compileGlobPattern) : [];
+	if (ignoredRules.size === 0 && ignoredFilePatterns.length === 0) return diagnostics;
+	return diagnostics.filter((diagnostic) => {
+		const ruleIdentifier = `${diagnostic.plugin}/${diagnostic.rule}`;
+		if (ignoredRules.has(ruleIdentifier)) return false;
+		const normalizedPath = diagnostic.filePath.replace(/\\/g, "/");
+		if (ignoredFilePatterns.some((pattern) => pattern.test(normalizedPath))) return false;
+		return true;
+	});
+};
+
+//#endregion
+//#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 {
+		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;
+	} 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 {
+		const fileContent = fs.readFileSync(packageJsonPath, "utf-8");
+		const embeddedConfig = JSON.parse(fileContent)[PACKAGE_JSON_CONFIG_KEY];
+		if (isPlainObject(embeddedConfig)) return embeddedConfig;
+	} catch {
+		return null;
+	}
+	return null;
+};
+
 //#endregion
 //#region src/utils/run-knip.ts
 const KNIP_CATEGORY_MAP = {
@@ -541,6 +616,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);
@@ -608,7 +723,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",
@@ -702,13 +817,15 @@ const resolvePluginPath = () => {
 const resolveDiagnosticCategory = (plugin, rule) => {
 	return RULE_CATEGORY_MAP[`${plugin}/${rule}`] ?? PLUGIN_CATEGORY_MAP[plugin] ?? "Other";
 };
-const runOxlint = async (rootDirectory, hasTypeScript, framework, hasReactCompiler) => {
+const runOxlint = async (rootDirectory, hasTypeScript, framework, hasReactCompiler, includePaths) => {
+	if (includePaths !== void 0 && includePaths.length === 0) return [];
 	const configPath = path.join(os.tmpdir(), `react-doctor-oxlintrc-${process.pid}.json`);
 	const config = createOxlintConfig({
 		pluginPath: resolvePluginPath(),
 		framework,
 		hasReactCompiler
 	});
+	const restoreDisableDirectives = neutralizeDisableDirectives(rootDirectory);
 	try {
 		fs.writeFileSync(configPath, JSON.stringify(config, null, 2));
 		const args = [
@@ -719,7 +836,8 @@ const runOxlint = async (rootDirectory, hasTypeScript, framework, hasReactCompil
 			"json"
 		];
 		if (hasTypeScript) args.push("--tsconfig", "./tsconfig.json");
-		args.push(".");
+		if (includePaths !== void 0) args.push(...includePaths);
+		else args.push(".");
 		const stdout = await new Promise((resolve, reject) => {
 			const child = spawn(process.execPath, args, { cwd: rootDirectory });
 			const stdoutBuffers = [];
@@ -746,7 +864,7 @@ const runOxlint = async (rootDirectory, hasTypeScript, framework, hasReactCompil
 		} catch {
 			throw new Error(`Failed to parse oxlint output: ${stdout.slice(0, ERROR_PREVIEW_LENGTH_CHARS)}`);
 		}
-		return output.diagnostics.filter((diagnostic) => JSX_FILE_PATTERN.test(diagnostic.filename)).map((diagnostic) => {
+		return output.diagnostics.filter((diagnostic) => diagnostic.code && JSX_FILE_PATTERN.test(diagnostic.filename)).map((diagnostic) => {
 			const { plugin, rule } = parseRuleCode(diagnostic.code);
 			const primaryLabel = diagnostic.labels[0];
 			const cleaned = cleanDiagnosticMessage(diagnostic.message, diagnostic.help, plugin, rule);
@@ -763,32 +881,98 @@ const runOxlint = async (rootDirectory, hasTypeScript, framework, hasReactCompil
 			};
 		});
 	} finally {
+		restoreDisableDirectives();
 		if (fs.existsSync(configPath)) fs.unlinkSync(configPath);
 	}
 };
 
+//#endregion
+//#region src/utils/get-diff-files.ts
+const getCurrentBranch = (directory) => {
+	try {
+		const branch = execSync("git rev-parse --abbrev-ref HEAD", {
+			cwd: directory,
+			stdio: "pipe"
+		}).toString().trim();
+		return branch === "HEAD" ? null : branch;
+	} catch {
+		return null;
+	}
+};
+const detectDefaultBranch = (directory) => {
+	try {
+		return execSync("git symbolic-ref refs/remotes/origin/HEAD", {
+			cwd: directory,
+			stdio: "pipe"
+		}).toString().trim().replace("refs/remotes/origin/", "");
+	} catch {
+		for (const candidate of DEFAULT_BRANCH_CANDIDATES) try {
+			execSync(`git rev-parse --verify ${candidate}`, {
+				cwd: directory,
+				stdio: "pipe"
+			});
+			return candidate;
+		} catch {}
+		return null;
+	}
+};
+const getChangedFilesSinceBranch = (directory, baseBranch) => {
+	try {
+		const output = execSync(`git diff --name-only --diff-filter=ACMR --relative ${execSync(`git merge-base ${baseBranch} HEAD`, {
+			cwd: directory,
+			stdio: "pipe"
+		}).toString().trim()}`, {
+			cwd: directory,
+			stdio: "pipe"
+		}).toString().trim();
+		if (!output) return [];
+		return output.split("\n").filter(Boolean);
+	} catch {
+		return [];
+	}
+};
+const getDiffInfo = (directory, explicitBaseBranch) => {
+	const currentBranch = getCurrentBranch(directory);
+	if (!currentBranch) return null;
+	const baseBranch = explicitBaseBranch ?? detectDefaultBranch(directory);
+	if (!baseBranch) return null;
+	if (currentBranch === baseBranch) return null;
+	return {
+		currentBranch,
+		baseBranch,
+		changedFiles: getChangedFilesSinceBranch(directory, baseBranch)
+	};
+};
+const filterSourceFiles = (filePaths) => filePaths.filter((filePath) => SOURCE_FILE_PATTERN.test(filePath));
+
 //#endregion
 //#region src/index.ts
 const diagnose = async (directory, options = {}) => {
-	const { lint = true, deadCode = true } = options;
+	const { includePaths = [] } = options;
+	const isDiffMode = includePaths.length > 0;
 	const startTime = performance.now();
 	const resolvedDirectory = path.resolve(directory);
 	const projectInfo = discoverProject(resolvedDirectory);
+	const userConfig = loadConfig(resolvedDirectory);
+	const effectiveLint = options.lint ?? userConfig?.lint ?? true;
+	const effectiveDeadCode = options.deadCode ?? userConfig?.deadCode ?? true;
 	if (!projectInfo.reactVersion) throw new Error("No React dependency found in package.json");
-	const lintPromise = lint ? runOxlint(resolvedDirectory, projectInfo.hasTypeScript, projectInfo.framework, projectInfo.hasReactCompiler).catch((error) => {
+	const jsxIncludePaths = isDiffMode ? includePaths.filter((filePath) => JSX_FILE_PATTERN.test(filePath)) : void 0;
+	const lintPromise = effectiveLint ? runOxlint(resolvedDirectory, projectInfo.hasTypeScript, projectInfo.framework, projectInfo.hasReactCompiler, jsxIncludePaths).catch((error) => {
 		console.error("Lint failed:", error);
 		return [];
 	}) : Promise.resolve([]);
-	const deadCodePromise = deadCode ? runKnip(resolvedDirectory).catch((error) => {
+	const deadCodePromise = effectiveDeadCode && !isDiffMode ? runKnip(resolvedDirectory).catch((error) => {
 		console.error("Dead code analysis failed:", error);
 		return [];
 	}) : Promise.resolve([]);
 	const [lintDiagnostics, deadCodeDiagnostics] = await Promise.all([lintPromise, deadCodePromise]);
-	const diagnostics = [
+	const allDiagnostics = [
 		...lintDiagnostics,
 		...deadCodeDiagnostics,
-		...checkReducedMotion(resolvedDirectory)
+		...isDiffMode ? [] : checkReducedMotion(resolvedDirectory)
 	];
+	const diagnostics = userConfig ? filterIgnoredDiagnostics(allDiagnostics, userConfig) : allDiagnostics;
 	const elapsedMilliseconds = performance.now() - startTime;
 	return {
 		diagnostics,
@@ -799,5 +983,5 @@ const diagnose = async (directory, options = {}) => {
 };
 
 //#endregion
-export { diagnose };
+export { diagnose, filterSourceFiles, getDiffInfo };
 //# sourceMappingURL=index.js.map