react-doctor 0.1.1 → 0.1.3

package/README.md

@@ -160,21 +160,26 @@ When a suppression isn't working, `--explain <file:line>` reports what the scann
 
 ### Config keys
 
-| Key                       | Type                             | Default  |
-| ------------------------- | -------------------------------- | -------- |
-| `ignore.rules`            | `string[]`                       | `[]`     |
-| `ignore.files`            | `string[]`                       | `[]`     |
-| `ignore.overrides`        | `{ files, rules? }[]`            | `[]`     |
-| `lint`                    | `boolean`                        | `true`   |
-| `deadCode`                | `boolean`                        | `true`   |
-| `verbose`                 | `boolean`                        | `false`  |
-| `diff`                    | `boolean \| string`              |          |
-| `failOn`                  | `"error" \| "warning" \| "none"` | `"none"` |
-| `customRulesOnly`         | `boolean`                        | `false`  |
-| `share`                   | `boolean`                        | `true`   |
-| `textComponents`          | `string[]`                       | `[]`     |
-| `respectInlineDisables`   | `boolean`                        | `true`   |
-| `adoptExistingLintConfig` | `boolean`                        | `true`   |
+| Key                        | Type                             | Default  |
+| -------------------------- | -------------------------------- | -------- |
+| `ignore.rules`             | `string[]`                       | `[]`     |
+| `ignore.files`             | `string[]`                       | `[]`     |
+| `ignore.overrides`         | `{ files, rules? }[]`            | `[]`     |
+| `lint`                     | `boolean`                        | `true`   |
+| `deadCode`                 | `boolean`                        | `true`   |
+| `verbose`                  | `boolean`                        | `false`  |
+| `diff`                     | `boolean \| string`              |          |
+| `failOn`                   | `"error" \| "warning" \| "none"` | `"none"` |
+| `customRulesOnly`          | `boolean`                        | `false`  |
+| `share`                    | `boolean`                        | `true`   |
+| `textComponents`           | `string[]`                       | `[]`     |
+| `rawTextWrapperComponents` | `string[]`                       | `[]`     |
+| `respectInlineDisables`    | `boolean`                        | `true`   |
+| `adoptExistingLintConfig`  | `boolean`                        | `true`   |
+
+`textComponents` is the broad escape hatch for `rn-no-raw-text` — list components that themselves behave like React Native's `<Text>` (custom `Typography`, `NativeTabs.Trigger.Label`, etc.) and the rule will treat them as text containers regardless of what their children look like.
+
+`rawTextWrapperComponents` is the narrower option for components that are not text elements but safely route string-only children through an internal `<Text>` (e.g. `heroui-native`'s `Button`, which stringifies its children and renders them through a `ButtonLabel`). Listed wrappers suppress `rn-no-raw-text` only when their children are entirely stringifiable. A wrapper with mixed children — e.g. `<Button>Save<Icon /></Button>` — still reports because the wrapper can't safely route raw text alongside a sibling JSX element.
 
 ## Node.js API
 

package/dist/cli.js

@@ -212,7 +212,10 @@ const finalize = (method, originalText, displayText) => {
 		return;
 	}
 	sharedInstance.stop();
-	ora(displayText).start()[method](displayText);
+	ora({
+		text: displayText,
+		indent: 2
+	}).start()[method](displayText);
 	const [remainingText] = pendingTexts;
 	if (remainingText) sharedInstance.text = remainingText;
 	sharedInstance.start();
@@ -221,7 +224,10 @@ const spinner = (text) => ({ start() {
 	if (isSilent) return noopHandle;
 	activeCount++;
 	pendingTexts.add(text);
-	if (!sharedInstance) sharedInstance = ora({ text }).start();
+	if (!sharedInstance) sharedInstance = ora({
+		text,
+		indent: 2
+	}).start();
 	else sharedInstance.text = text;
 	const handle = {
 		succeed: (displayText) => {
@@ -906,6 +912,8 @@ const isFileIgnoredByPatterns = (filePath, rootDirectory, patterns) => {
 //#endregion
 //#region src/utils/filter-diagnostics.ts
 const OPENING_TAG_PATTERN = /<([A-Z][\w.]*)/;
+const JSX_CHILD_OPEN_PATTERN = /<[A-Za-z]/;
+const escapeRegExpSpecials = (rawText) => rawText.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 const resolveCandidateReadPath = (rootDirectory, filePath) => {
 	const normalizedFile = filePath.replace(/\\/g, "/");
 	if (normalizedFile.startsWith("/") || /^[a-zA-Z]:\//.test(normalizedFile) || /^[a-zA-Z]:\\/.test(filePath)) return filePath;
@@ -931,21 +939,93 @@ const isInsideTextComponent = (lines, diagnosticLine, textComponentNames) => {
 	}
 	return false;
 };
+const findOpenerAtOrAbove = (lines, upperBoundLineIndex) => {
+	for (let lineIndex = upperBoundLineIndex; lineIndex >= 0; lineIndex--) {
+		const match = lines[lineIndex].match(OPENING_TAG_PATTERN);
+		if (!match) continue;
+		const fullName = match[1];
+		return {
+			fullName,
+			leafName: fullName.includes(".") ? fullName.split(".").at(-1) ?? fullName : fullName,
+			lineIndex
+		};
+	}
+	return null;
+};
+const resolveJsxRange = (lines, opener) => {
+	const closingPattern = new RegExp(`</(?:${escapeRegExpSpecials(opener.fullName)}|${escapeRegExpSpecials(opener.leafName)})\\s*>`);
+	let closerLineIndex = -1;
+	let closerColumn = -1;
+	for (let lineIndex = opener.lineIndex; lineIndex < lines.length; lineIndex++) {
+		const match = closingPattern.exec(lines[lineIndex]);
+		if (!match) continue;
+		closerLineIndex = lineIndex;
+		closerColumn = match.index;
+		break;
+	}
+	if (closerLineIndex < 0) return null;
+	const openerLine = lines[opener.lineIndex];
+	const tagStartIndex = openerLine.indexOf(`<${opener.fullName}`);
+	if (tagStartIndex < 0) return null;
+	const openerEndIndex = openerLine.indexOf(">", tagStartIndex);
+	let bodyText;
+	if (opener.lineIndex === closerLineIndex) {
+		if (openerEndIndex < 0 || openerEndIndex >= closerColumn) return null;
+		bodyText = openerLine.slice(openerEndIndex + 1, closerColumn);
+	} else {
+		const segments = [];
+		if (openerEndIndex >= 0) segments.push(openerLine.slice(openerEndIndex + 1));
+		for (let lineIndex = opener.lineIndex + 1; lineIndex < closerLineIndex; lineIndex++) segments.push(lines[lineIndex]);
+		segments.push(lines[closerLineIndex].slice(0, closerColumn));
+		bodyText = segments.join("\n");
+	}
+	return {
+		closerLineIndex,
+		closerColumn,
+		bodyText
+	};
+};
+const isInsideStringOnlyWrapper = (lines, diagnosticLine, diagnosticColumn, wrapperNames) => {
+	const diagnosticLineIndex = diagnosticLine - 1;
+	const diagnosticColumnIndex = Math.max(0, diagnosticColumn - 1);
+	let upperBoundLineIndex = diagnosticLineIndex;
+	while (upperBoundLineIndex >= 0) {
+		const opener = findOpenerAtOrAbove(lines, upperBoundLineIndex);
+		if (!opener) return false;
+		const range = resolveJsxRange(lines, opener);
+		if (range === null) {
+			upperBoundLineIndex = opener.lineIndex - 1;
+			continue;
+		}
+		if (range.closerLineIndex < diagnosticLineIndex || range.closerLineIndex === diagnosticLineIndex && range.closerColumn <= diagnosticColumnIndex) {
+			upperBoundLineIndex = opener.lineIndex - 1;
+			continue;
+		}
+		if (!wrapperNames.has(opener.fullName) && !wrapperNames.has(opener.leafName)) return false;
+		return !JSX_CHILD_OPEN_PATTERN.test(range.bodyText);
+	}
+	return false;
+};
 const filterIgnoredDiagnostics = (diagnostics, config, rootDirectory, readFileLinesSync) => {
 	const ignoredRules = new Set(Array.isArray(config.ignore?.rules) ? config.ignore.rules.filter((rule) => typeof rule === "string") : []);
 	const ignoredFilePatterns = compileIgnoredFilePatterns(config);
 	const compiledOverrides = compileIgnoreOverrides(config);
 	const textComponentNames = new Set(Array.isArray(config.textComponents) ? config.textComponents.filter((name) => typeof name === "string") : []);
 	const hasTextComponents = textComponentNames.size > 0;
+	const rawTextWrapperComponentNames = new Set(Array.isArray(config.rawTextWrapperComponents) ? config.rawTextWrapperComponents.filter((name) => typeof name === "string") : []);
+	const hasRawTextWrappers = rawTextWrapperComponentNames.size > 0;
 	const getFileLines = createFileLinesCache(rootDirectory, readFileLinesSync);
 	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 (isDiagnosticIgnoredByOverrides(diagnostic, rootDirectory, compiledOverrides)) return false;
-		if (hasTextComponents && diagnostic.rule === "rn-no-raw-text" && diagnostic.line > 0) {
+		if ((hasTextComponents || hasRawTextWrappers) && diagnostic.rule === "rn-no-raw-text" && diagnostic.line > 0) {
 			const lines = getFileLines(diagnostic.filePath);
-			if (lines && isInsideTextComponent(lines, diagnostic.line, textComponentNames)) return false;
+			if (lines) {
+				if (hasTextComponents && isInsideTextComponent(lines, diagnostic.line, textComponentNames)) return false;
+				if (hasRawTextWrappers && isInsideStringOnlyWrapper(lines, diagnostic.line, diagnostic.column, rawTextWrapperComponentNames)) return false;
+			}
 		}
 		return true;
 	});
@@ -2177,22 +2257,22 @@ const TANSTACK_START_RULES = {
 	"react-doctor/tanstack-start-loader-parallel-fetch": "warn"
 };
 const REACT_COMPILER_RULES = {
-	"react-hooks-js/set-state-in-render": "warn",
-	"react-hooks-js/immutability": "warn",
-	"react-hooks-js/refs": "warn",
-	"react-hooks-js/purity": "warn",
-	"react-hooks-js/hooks": "warn",
-	"react-hooks-js/set-state-in-effect": "warn",
-	"react-hooks-js/globals": "warn",
-	"react-hooks-js/error-boundaries": "warn",
-	"react-hooks-js/preserve-manual-memoization": "warn",
-	"react-hooks-js/unsupported-syntax": "warn",
-	"react-hooks-js/component-hook-factories": "warn",
-	"react-hooks-js/static-components": "warn",
-	"react-hooks-js/use-memo": "warn",
-	"react-hooks-js/void-use-memo": "warn",
-	"react-hooks-js/incompatible-library": "warn",
-	"react-hooks-js/todo": "warn"
+	"react-hooks-js/set-state-in-render": "error",
+	"react-hooks-js/immutability": "error",
+	"react-hooks-js/refs": "error",
+	"react-hooks-js/purity": "error",
+	"react-hooks-js/hooks": "error",
+	"react-hooks-js/set-state-in-effect": "error",
+	"react-hooks-js/globals": "error",
+	"react-hooks-js/error-boundaries": "error",
+	"react-hooks-js/preserve-manual-memoization": "error",
+	"react-hooks-js/unsupported-syntax": "error",
+	"react-hooks-js/component-hook-factories": "error",
+	"react-hooks-js/static-components": "error",
+	"react-hooks-js/use-memo": "error",
+	"react-hooks-js/void-use-memo": "error",
+	"react-hooks-js/incompatible-library": "error",
+	"react-hooks-js/todo": "error"
 };
 const readPluginRuleNames = (pluginSpecifier) => {
 	try {
@@ -3251,18 +3331,13 @@ const printDiagnostics = (diagnostics, isVerbose, rootDirectory) => {
 	const visibleRuleGroups = isVerbose ? sortedRuleGroups : sortedRuleGroups.slice(0, 5);
 	const hiddenRuleGroups = isVerbose ? [] : sortedRuleGroups.slice(5);
 	const ruleNameColumnWidth = computeRuleNameColumnWidth(visibleRuleGroups.map(([ruleKey]) => ruleKey));
-	visibleRuleGroups.forEach(([ruleKey, ruleDiagnostics], visibleIndex) => {
+	visibleRuleGroups.forEach(([ruleKey, ruleDiagnostics]) => {
 		if (isVerbose) {
 			printVerboseRuleGroup(ruleKey, ruleDiagnostics, ruleNameColumnWidth);
 			return;
 		}
-		if (visibleIndex < 1) {
-			printDetailedRuleGroup(ruleKey, ruleDiagnostics, rootDirectory, ruleNameColumnWidth);
-			return;
-		}
-		printCompactRuleGroupLine(ruleKey, ruleDiagnostics, ruleNameColumnWidth);
+		printDetailedRuleGroup(ruleKey, ruleDiagnostics, rootDirectory, ruleNameColumnWidth);
 	});
-	if (visibleRuleGroups.length > 1 && !isVerbose) logger.break();
 	if (hiddenRuleGroups.length > 0) printHiddenDiagnosticsSummary(hiddenRuleGroups);
 };
 const printHiddenDiagnosticsSummary = (hiddenRuleGroups) => {
@@ -3608,6 +3683,7 @@ const runScan = async (directory, options, userConfig, startTime) => {
 		else printNoScoreHeader(noScoreMessage);
 		return buildResult();
 	}
+	logger.break();
 	printDiagnostics(diagnostics, options.verbose, directory);
 	const displayedSourceFileCount = isDiffMode ? includePaths.length : lintSourceFileCount;
 	const shouldShowShareLink = !options.offline && options.share;
@@ -4026,7 +4102,7 @@ const promptProjectSelection = async (workspacePackages, rootDirectory) => {
 };
 //#endregion
 //#region src/cli.ts
-const VERSION = "0.1.1";
+const VERSION = "0.1.3";
 const VALID_FAIL_ON_LEVELS = new Set([
 	"error",
 	"warning",

package/dist/eslint-plugin.js

@@ -6946,7 +6946,7 @@ const ALL_RULES_AT_RECOMMENDED_SEVERITY = {
 const eslintPlugin = {
 	meta: {
 		name: PLUGIN_NAMESPACE,
-		version: "0.1.1"
+		version: "0.1.3"
 	},
 	rules: eslintShapedRules,
 	configs: {

package/dist/index.d.ts

@@ -76,6 +76,23 @@ interface ReactDoctorConfig {
   customRulesOnly?: boolean;
   share?: boolean;
   textComponents?: string[];
+  /**
+   * Names of components that safely route string-only children through a
+   * React Native `<Text>` internally (e.g. `heroui-native`'s `Button`,
+   * which stringifies its children and renders them through a
+   * `ButtonLabel` → `Text`). For listed components, `rn-no-raw-text`
+   * is suppressed ONLY when the wrapper's children are entirely
+   * stringifiable (no nested JSX elements). A wrapper with mixed
+   * children — e.g. `<Button>Save<Icon /></Button>` — still reports,
+   * because the wrapper can't safely route raw text alongside a
+   * sibling JSX element.
+   *
+   * Use this instead of `textComponents` when the component is not
+   * itself a text element but is known to wrap its string children
+   * in one. `textComponents` is the broader escape hatch and
+   * suppresses regardless of sibling content.
+   */
+  rawTextWrapperComponents?: string[];
   /**
    * Whether to respect inline `// eslint-disable*`, `// oxlint-disable*`,
    * and `// react-doctor-disable*` comments in source files. Default: `true`.

package/dist/index.js

@@ -1349,6 +1349,8 @@ const isFileIgnoredByPatterns = (filePath, rootDirectory, patterns) => {
 //#endregion
 //#region src/utils/filter-diagnostics.ts
 const OPENING_TAG_PATTERN = /<([A-Z][\w.]*)/;
+const JSX_CHILD_OPEN_PATTERN = /<[A-Za-z]/;
+const escapeRegExpSpecials = (rawText) => rawText.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 const resolveCandidateReadPath = (rootDirectory, filePath) => {
 	const normalizedFile = filePath.replace(/\\/g, "/");
 	if (normalizedFile.startsWith("/") || /^[a-zA-Z]:\//.test(normalizedFile) || /^[a-zA-Z]:\\/.test(filePath)) return filePath;
@@ -1374,21 +1376,93 @@ const isInsideTextComponent = (lines, diagnosticLine, textComponentNames) => {
 	}
 	return false;
 };
+const findOpenerAtOrAbove = (lines, upperBoundLineIndex) => {
+	for (let lineIndex = upperBoundLineIndex; lineIndex >= 0; lineIndex--) {
+		const match = lines[lineIndex].match(OPENING_TAG_PATTERN);
+		if (!match) continue;
+		const fullName = match[1];
+		return {
+			fullName,
+			leafName: fullName.includes(".") ? fullName.split(".").at(-1) ?? fullName : fullName,
+			lineIndex
+		};
+	}
+	return null;
+};
+const resolveJsxRange = (lines, opener) => {
+	const closingPattern = new RegExp(`</(?:${escapeRegExpSpecials(opener.fullName)}|${escapeRegExpSpecials(opener.leafName)})\\s*>`);
+	let closerLineIndex = -1;
+	let closerColumn = -1;
+	for (let lineIndex = opener.lineIndex; lineIndex < lines.length; lineIndex++) {
+		const match = closingPattern.exec(lines[lineIndex]);
+		if (!match) continue;
+		closerLineIndex = lineIndex;
+		closerColumn = match.index;
+		break;
+	}
+	if (closerLineIndex < 0) return null;
+	const openerLine = lines[opener.lineIndex];
+	const tagStartIndex = openerLine.indexOf(`<${opener.fullName}`);
+	if (tagStartIndex < 0) return null;
+	const openerEndIndex = openerLine.indexOf(">", tagStartIndex);
+	let bodyText;
+	if (opener.lineIndex === closerLineIndex) {
+		if (openerEndIndex < 0 || openerEndIndex >= closerColumn) return null;
+		bodyText = openerLine.slice(openerEndIndex + 1, closerColumn);
+	} else {
+		const segments = [];
+		if (openerEndIndex >= 0) segments.push(openerLine.slice(openerEndIndex + 1));
+		for (let lineIndex = opener.lineIndex + 1; lineIndex < closerLineIndex; lineIndex++) segments.push(lines[lineIndex]);
+		segments.push(lines[closerLineIndex].slice(0, closerColumn));
+		bodyText = segments.join("\n");
+	}
+	return {
+		closerLineIndex,
+		closerColumn,
+		bodyText
+	};
+};
+const isInsideStringOnlyWrapper = (lines, diagnosticLine, diagnosticColumn, wrapperNames) => {
+	const diagnosticLineIndex = diagnosticLine - 1;
+	const diagnosticColumnIndex = Math.max(0, diagnosticColumn - 1);
+	let upperBoundLineIndex = diagnosticLineIndex;
+	while (upperBoundLineIndex >= 0) {
+		const opener = findOpenerAtOrAbove(lines, upperBoundLineIndex);
+		if (!opener) return false;
+		const range = resolveJsxRange(lines, opener);
+		if (range === null) {
+			upperBoundLineIndex = opener.lineIndex - 1;
+			continue;
+		}
+		if (range.closerLineIndex < diagnosticLineIndex || range.closerLineIndex === diagnosticLineIndex && range.closerColumn <= diagnosticColumnIndex) {
+			upperBoundLineIndex = opener.lineIndex - 1;
+			continue;
+		}
+		if (!wrapperNames.has(opener.fullName) && !wrapperNames.has(opener.leafName)) return false;
+		return !JSX_CHILD_OPEN_PATTERN.test(range.bodyText);
+	}
+	return false;
+};
 const filterIgnoredDiagnostics = (diagnostics, config, rootDirectory, readFileLinesSync) => {
 	const ignoredRules = new Set(Array.isArray(config.ignore?.rules) ? config.ignore.rules.filter((rule) => typeof rule === "string") : []);
 	const ignoredFilePatterns = compileIgnoredFilePatterns(config);
 	const compiledOverrides = compileIgnoreOverrides(config);
 	const textComponentNames = new Set(Array.isArray(config.textComponents) ? config.textComponents.filter((name) => typeof name === "string") : []);
 	const hasTextComponents = textComponentNames.size > 0;
+	const rawTextWrapperComponentNames = new Set(Array.isArray(config.rawTextWrapperComponents) ? config.rawTextWrapperComponents.filter((name) => typeof name === "string") : []);
+	const hasRawTextWrappers = rawTextWrapperComponentNames.size > 0;
 	const getFileLines = createFileLinesCache(rootDirectory, readFileLinesSync);
 	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 (isDiagnosticIgnoredByOverrides(diagnostic, rootDirectory, compiledOverrides)) return false;
-		if (hasTextComponents && diagnostic.rule === "rn-no-raw-text" && diagnostic.line > 0) {
+		if ((hasTextComponents || hasRawTextWrappers) && diagnostic.rule === "rn-no-raw-text" && diagnostic.line > 0) {
 			const lines = getFileLines(diagnostic.filePath);
-			if (lines && isInsideTextComponent(lines, diagnostic.line, textComponentNames)) return false;
+			if (lines) {
+				if (hasTextComponents && isInsideTextComponent(lines, diagnostic.line, textComponentNames)) return false;
+				if (hasRawTextWrappers && isInsideStringOnlyWrapper(lines, diagnostic.line, diagnostic.column, rawTextWrapperComponentNames)) return false;
+			}
 		}
 		return true;
 	});
@@ -1850,22 +1924,22 @@ const TANSTACK_START_RULES = {
 	"react-doctor/tanstack-start-loader-parallel-fetch": "warn"
 };
 const REACT_COMPILER_RULES = {
-	"react-hooks-js/set-state-in-render": "warn",
-	"react-hooks-js/immutability": "warn",
-	"react-hooks-js/refs": "warn",
-	"react-hooks-js/purity": "warn",
-	"react-hooks-js/hooks": "warn",
-	"react-hooks-js/set-state-in-effect": "warn",
-	"react-hooks-js/globals": "warn",
-	"react-hooks-js/error-boundaries": "warn",
-	"react-hooks-js/preserve-manual-memoization": "warn",
-	"react-hooks-js/unsupported-syntax": "warn",
-	"react-hooks-js/component-hook-factories": "warn",
-	"react-hooks-js/static-components": "warn",
-	"react-hooks-js/use-memo": "warn",
-	"react-hooks-js/void-use-memo": "warn",
-	"react-hooks-js/incompatible-library": "warn",
-	"react-hooks-js/todo": "warn"
+	"react-hooks-js/set-state-in-render": "error",
+	"react-hooks-js/immutability": "error",
+	"react-hooks-js/refs": "error",
+	"react-hooks-js/purity": "error",
+	"react-hooks-js/hooks": "error",
+	"react-hooks-js/set-state-in-effect": "error",
+	"react-hooks-js/globals": "error",
+	"react-hooks-js/error-boundaries": "error",
+	"react-hooks-js/preserve-manual-memoization": "error",
+	"react-hooks-js/unsupported-syntax": "error",
+	"react-hooks-js/component-hook-factories": "error",
+	"react-hooks-js/static-components": "error",
+	"react-hooks-js/use-memo": "error",
+	"react-hooks-js/void-use-memo": "error",
+	"react-hooks-js/incompatible-library": "error",
+	"react-hooks-js/todo": "error"
 };
 const readPluginRuleNames = (pluginSpecifier) => {
 	try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-doctor",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Diagnose and fix React codebases for security, performance, correctness, accessibility, bundle-size, and architecture issues",
   "keywords": [
     "accessibility",