react-doctor 0.0.31 → 0.0.33

package/dist/index.d.ts

@@ -43,6 +43,9 @@ interface ReactDoctorConfig {
   verbose?: boolean;
   diff?: boolean | string;
   failOn?: FailOnLevel;
+  customRulesOnly?: boolean;
+  share?: boolean;
+  textComponents?: string[];
 }
 //#endregion
 //#region src/utils/get-diff-files.d.ts

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types.ts","../src/utils/get-diff-files.ts","../src/index.ts"],"mappings":";KAAY,WAAA;AAAA,KAEA,SAAA;AAAA,UAUK,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,UAyBe,QAAA;EACf,aAAA;EACA,UAAA;EACA,YAAA;EACA,gBAAA;AAAA;AAAA,UA2Ce,uBAAA;EACf,KAAA;EACA,KAAA;AAAA;AAAA,UAGe,iBAAA;EACf,MAAA,GAAS,uBAAA;EACT,IAAA;EACA,QAAA;EACA,OAAA;EACA,IAAA;EACA,MAAA,GAAS,WAAA;AAAA;;;cChGE,WAAA,GAAe,SAAA,UAAmB,kBAAA,cAA8B,QAAA;AAAA,cAiBhE,iBAAA,GAAqB,SAAA;;;UClFjB,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"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types.ts","../src/utils/get-diff-files.ts","../src/index.ts"],"mappings":";KAAY,WAAA;AAAA,KAEA,SAAA;AAAA,UAUK,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,UAmBe,QAAA;EACf,aAAA;EACA,UAAA;EACA,YAAA;EACA,gBAAA;AAAA;AAAA,UA2Ce,uBAAA;EACf,KAAA;EACA,KAAA;AAAA;AAAA,UAGe,iBAAA;EACf,MAAA,GAAS,uBAAA;EACT,IAAA;EACA,QAAA;EACA,OAAA;EACA,IAAA;EACA,MAAA,GAAS,WAAA;EACT,eAAA;EACA,KAAA;EACA,cAAA;AAAA;;;cC7FW,WAAA,GAAe,SAAA,UAAmB,kBAAA,cAA8B,QAAA;AAAA,cAiBhE,iBAAA,GAAqB,SAAA;;;UClFjB,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

@@ -19,20 +19,18 @@ 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 OXLINT_MAX_FILES_PER_BATCH = 500;
 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 GIT_SHOW_MAX_BUFFER_BYTES = 10 * 1024 * 1024;
 const IGNORED_DIRECTORIES = new Set([
 	"node_modules",
 	"dist",
 	"build",
 	"coverage"
 ]);
-const AMI_WEBSITE_URL = "https://ami.dev";
-const AMI_INSTALL_URL = `${AMI_WEBSITE_URL}/install.sh`;
 
 //#endregion
 //#region src/utils/proxy-fetch.ts
@@ -106,22 +104,12 @@ 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);
+	const { errorRuleCount, warningRuleCount } = countUniqueRules(diagnostics);
+	const score = scoreFromRuleCounts(errorRuleCount, warningRuleCount);
 	return {
-		score: currentScore,
-		label: currentLabel
+		score,
+		label: getScoreLabel(score)
 	};
 };
 const calculateScore = async (diagnostics) => {
@@ -158,6 +146,7 @@ const readPackageJson = (packageJsonPath) => {
 	try {
 		return JSON.parse(fs.readFileSync(packageJsonPath, "utf-8"));
 	} catch (error) {
+		if (error instanceof SyntaxError) return {};
 		if (error instanceof Error && "code" in error) {
 			const { code } = error;
 			if (code === "EISDIR" || code === "EACCES") return {};
@@ -253,38 +242,58 @@ const isFileIgnoredByPatterns = (filePath, rootDirectory, patterns) => {
 
 //#endregion
 //#region src/utils/filter-diagnostics.ts
-const filterIgnoredDiagnostics = (diagnostics, config, rootDirectory) => {
-	const ignoredRules = new Set(Array.isArray(config.ignore?.rules) ? config.ignore.rules : []);
-	const ignoredFilePatterns = compileIgnoredFilePatterns(config);
-	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;
-		if (isFileIgnoredByPatterns(diagnostic.filePath, rootDirectory, ignoredFilePatterns)) return false;
-		return true;
-	});
-};
+const OPENING_TAG_PATTERN = /<([A-Z][\w.]*)/;
 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);
+const createFileLinesCache = (rootDirectory) => {
+	const cache = /* @__PURE__ */ new Map();
+	return (filePath) => {
+		const cached = cache.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);
+			cache.set(filePath, lines);
 			return lines;
 		} catch {
-			fileLineCache.set(filePath, null);
+			cache.set(filePath, null);
 			return null;
 		}
 	};
+};
+const isInsideTextComponent = (lines, diagnosticLine, textComponentNames) => {
+	for (let lineIndex = diagnosticLine - 1; lineIndex >= 0; lineIndex--) {
+		const match = lines[lineIndex].match(OPENING_TAG_PATTERN);
+		if (!match) continue;
+		const fullTagName = match[1];
+		const leafTagName = fullTagName.includes(".") ? fullTagName.split(".").at(-1) ?? fullTagName : fullTagName;
+		return textComponentNames.has(fullTagName) || textComponentNames.has(leafTagName);
+	}
+	return false;
+};
+const isRuleSuppressed = (commentRules, ruleId) => {
+	if (!commentRules?.trim()) return true;
+	return commentRules.split(/[,\s]+/).some((rule) => rule.trim() === ruleId);
+};
+const filterIgnoredDiagnostics = (diagnostics, config, rootDirectory) => {
+	const ignoredRules = new Set(Array.isArray(config.ignore?.rules) ? config.ignore.rules : []);
+	const ignoredFilePatterns = compileIgnoredFilePatterns(config);
+	const textComponentNames = new Set(Array.isArray(config.textComponents) ? config.textComponents : []);
+	const hasTextComponents = textComponentNames.size > 0;
+	const getFileLines = createFileLinesCache(rootDirectory);
+	return diagnostics.filter((diagnostic) => {
+		const ruleIdentifier = `${diagnostic.plugin}/${diagnostic.rule}`;
+		if (ignoredRules.has(ruleIdentifier)) return false;
+		if (isFileIgnoredByPatterns(diagnostic.filePath, rootDirectory, ignoredFilePatterns)) return false;
+		if (hasTextComponents && diagnostic.rule === "rn-no-raw-text" && diagnostic.line > 0) {
+			const lines = getFileLines(diagnostic.filePath);
+			if (lines && isInsideTextComponent(lines, diagnostic.line, textComponentNames)) return false;
+		}
+		return true;
+	});
+};
+const filterInlineSuppressions = (diagnostics, rootDirectory) => {
+	const getFileLines = createFileLinesCache(rootDirectory);
 	return diagnostics.filter((diagnostic) => {
 		if (diagnostic.line <= 0) return true;
 		const lines = getFileLines(diagnostic.filePath);
@@ -296,9 +305,9 @@ const filterInlineSuppressions = (diagnostics, rootDirectory) => {
 			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);
+			const previousLine = lines[diagnostic.line - 2];
+			if (previousLine) {
+				const nextLineMatch = previousLine.match(DISABLE_NEXT_LINE_PATTERN);
 				if (nextLineMatch && isRuleSuppressed(nextLineMatch[1], ruleId)) return false;
 			}
 		}
@@ -685,8 +694,8 @@ const discoverProject = (directory) => {
 //#region src/utils/load-config.ts
 const CONFIG_FILENAME = "react-doctor.config.json";
 const PACKAGE_JSON_CONFIG_KEY = "reactDoctor";
-const loadConfig = (rootDirectory) => {
-	const configFilePath = path.join(rootDirectory, CONFIG_FILENAME);
+const loadConfigFromDirectory = (directory) => {
+	const configFilePath = path.join(directory, CONFIG_FILENAME);
 	if (isFile(configFilePath)) try {
 		const fileContent = fs.readFileSync(configFilePath, "utf-8");
 		const parsed = JSON.parse(fileContent);
@@ -695,7 +704,7 @@ const loadConfig = (rootDirectory) => {
 	} catch (error) {
 		console.warn(`Warning: Failed to parse ${CONFIG_FILENAME}: ${error instanceof Error ? error.message : String(error)}`);
 	}
-	const packageJsonPath = path.join(rootDirectory, "package.json");
+	const packageJsonPath = path.join(directory, "package.json");
 	if (isFile(packageJsonPath)) try {
 		const fileContent = fs.readFileSync(packageJsonPath, "utf-8");
 		const embeddedConfig = JSON.parse(fileContent)[PACKAGE_JSON_CONFIG_KEY];
@@ -705,6 +714,17 @@ const loadConfig = (rootDirectory) => {
 	}
 	return null;
 };
+const loadConfig = (rootDirectory) => {
+	const localConfig = loadConfigFromDirectory(rootDirectory);
+	if (localConfig) return localConfig;
+	let ancestorDirectory = path.dirname(rootDirectory);
+	while (ancestorDirectory !== path.dirname(ancestorDirectory)) {
+		const ancestorConfig = loadConfigFromDirectory(ancestorDirectory);
+		if (ancestorConfig) return ancestorConfig;
+		ancestorDirectory = path.dirname(ancestorDirectory);
+	}
+	return null;
+};
 
 //#endregion
 //#region src/utils/resolve-lint-include-paths.ts
@@ -915,7 +935,37 @@ const REACT_COMPILER_RULES = {
 	"react-hooks-js/incompatible-library": "error",
 	"react-hooks-js/todo": "error"
 };
-const createOxlintConfig = ({ pluginPath, framework, hasReactCompiler }) => ({
+const BUILTIN_REACT_RULES = {
+	"react/rules-of-hooks": "error",
+	"react/no-direct-mutation-state": "error",
+	"react/jsx-no-duplicate-props": "error",
+	"react/jsx-key": "error",
+	"react/no-children-prop": "warn",
+	"react/no-danger": "warn",
+	"react/jsx-no-script-url": "error",
+	"react/no-render-return-value": "warn",
+	"react/no-string-refs": "warn",
+	"react/no-is-mounted": "warn",
+	"react/require-render-return": "error",
+	"react/no-unknown-property": "warn"
+};
+const BUILTIN_A11Y_RULES = {
+	"jsx-a11y/alt-text": "error",
+	"jsx-a11y/anchor-is-valid": "warn",
+	"jsx-a11y/click-events-have-key-events": "warn",
+	"jsx-a11y/no-static-element-interactions": "warn",
+	"jsx-a11y/role-has-required-aria-props": "error",
+	"jsx-a11y/no-autofocus": "warn",
+	"jsx-a11y/heading-has-content": "warn",
+	"jsx-a11y/html-has-lang": "warn",
+	"jsx-a11y/no-redundant-roles": "warn",
+	"jsx-a11y/scope": "warn",
+	"jsx-a11y/tabindex-no-positive": "warn",
+	"jsx-a11y/label-has-associated-control": "warn",
+	"jsx-a11y/no-distracting-elements": "error",
+	"jsx-a11y/iframe-has-title": "warn"
+};
+const createOxlintConfig = ({ pluginPath, framework, hasReactCompiler, customRulesOnly = false }) => ({
 	categories: {
 		correctness: "off",
 		suspicious: "off",
@@ -930,39 +980,14 @@ const createOxlintConfig = ({ pluginPath, framework, hasReactCompiler }) => ({
 		"jsx-a11y",
 		...hasReactCompiler ? [] : ["react-perf"]
 	],
-	jsPlugins: [...hasReactCompiler ? [{
+	jsPlugins: [...hasReactCompiler && !customRulesOnly ? [{
 		name: "react-hooks-js",
 		specifier: esmRequire$1.resolve("eslint-plugin-react-hooks")
 	}] : [], pluginPath],
 	rules: {
-		"react/rules-of-hooks": "error",
-		"react/no-direct-mutation-state": "error",
-		"react/jsx-no-duplicate-props": "error",
-		"react/jsx-key": "error",
-		"react/no-children-prop": "warn",
-		"react/no-danger": "warn",
-		"react/jsx-no-script-url": "error",
-		"react/no-render-return-value": "warn",
-		"react/no-string-refs": "warn",
-		"react/no-is-mounted": "warn",
-		"react/require-render-return": "error",
-		"react/no-unknown-property": "warn",
-		"jsx-a11y/alt-text": "error",
-		"jsx-a11y/anchor-is-valid": "warn",
-		"jsx-a11y/click-events-have-key-events": "warn",
-		"jsx-a11y/no-static-element-interactions": "warn",
-		"jsx-a11y/no-noninteractive-element-interactions": "warn",
-		"jsx-a11y/role-has-required-aria-props": "error",
-		"jsx-a11y/no-autofocus": "warn",
-		"jsx-a11y/heading-has-content": "warn",
-		"jsx-a11y/html-has-lang": "warn",
-		"jsx-a11y/no-redundant-roles": "warn",
-		"jsx-a11y/scope": "warn",
-		"jsx-a11y/tabindex-no-positive": "warn",
-		"jsx-a11y/label-has-associated-control": "warn",
-		"jsx-a11y/no-distracting-elements": "error",
-		"jsx-a11y/iframe-has-title": "warn",
-		...hasReactCompiler ? REACT_COMPILER_RULES : {},
+		...customRulesOnly ? {} : BUILTIN_REACT_RULES,
+		...customRulesOnly ? {} : BUILTIN_A11Y_RULES,
+		...hasReactCompiler && !customRulesOnly ? REACT_COMPILER_RULES : {},
 		"react-doctor/no-derived-state-effect": "error",
 		"react-doctor/no-fetch-in-effect": "error",
 		"react-doctor/no-cascading-set-state": "warn",
@@ -1233,7 +1258,9 @@ const batchIncludePaths = (baseArgs, includePaths) => {
 	let currentBatchLength = baseArgsLength;
 	for (const filePath of includePaths) {
 		const entryLength = filePath.length + 1;
-		if (currentBatch.length > 0 && currentBatchLength + entryLength > SPAWN_ARGS_MAX_LENGTH_CHARS) {
+		const exceedsArgLength = currentBatch.length > 0 && currentBatchLength + entryLength > SPAWN_ARGS_MAX_LENGTH_CHARS;
+		const exceedsFileCount = currentBatch.length >= OXLINT_MAX_FILES_PER_BATCH;
+		if (exceedsArgLength || exceedsFileCount) {
 			batches.push(currentBatch);
 			currentBatch = [];
 			currentBatchLength = baseArgsLength;
@@ -1295,13 +1322,14 @@ const parseOxlintOutput = (stdout) => {
 		};
 	});
 };
-const runOxlint = async (rootDirectory, hasTypeScript, framework, hasReactCompiler, includePaths, nodeBinaryPath = process.execPath) => {
+const runOxlint = async (rootDirectory, hasTypeScript, framework, hasReactCompiler, includePaths, nodeBinaryPath = process.execPath, customRulesOnly = false) => {
 	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
+		hasReactCompiler,
+		customRulesOnly
 	});
 	const restoreDisableDirectives = neutralizeDisableDirectives(rootDirectory, includePaths);
 	try {
@@ -1421,7 +1449,8 @@ const diagnose = async (directory, options = {}) => {
 	if (!projectInfo.reactVersion) throw new Error("No React dependency found in package.json");
 	const lintIncludePaths = computeJsxIncludePaths(includePaths) ?? resolveLintIncludePaths(resolvedDirectory, userConfig);
 	const emptyDiagnostics = [];
-	const lintPromise = effectiveLint ? runOxlint(resolvedDirectory, projectInfo.hasTypeScript, projectInfo.framework, projectInfo.hasReactCompiler, lintIncludePaths).catch((error) => {
+	const effectiveCustomRulesOnly = userConfig?.customRulesOnly ?? false;
+	const lintPromise = effectiveLint ? runOxlint(resolvedDirectory, projectInfo.hasTypeScript, projectInfo.framework, projectInfo.hasReactCompiler, lintIncludePaths, void 0, effectiveCustomRulesOnly).catch((error) => {
 		console.error("Lint failed:", error);
 		return emptyDiagnostics;
 	}) : Promise.resolve(emptyDiagnostics);