react-doctor/ink-no-direct-raw-mode
Raw mode changed during render
- Category: Bugs
- Severity: error
- Source:
oxlint-plugin-react-doctor - Framework: global
- Enabled when: Ink >= 3.0.0
- Tags: ink
- Default: Enabled
Validate the diagnostic
Confirm the reported code matches this rule before you edit it.
Confirm the reported code matches react-doctor/ink-no-direct-raw-mode. Compare it with the Before example and verify the same API, framework, and execution context. Treat it as a false positive only when one of those conditions differs.
Compare the code
The corrected pattern shows a focused way to address the diagnostic.
Reported pattern
import { Text, useStdin } from "ink";
const App = () => {
const { setRawMode } = useStdin();
setRawMode(true);
return <Text />;
};Corrected pattern
import { Text, useStdin } from "ink";
import { useEffect } from "react";
const App = () => {
const { setRawMode } = useStdin();
useEffect(() => {
setRawMode(true);
return () => setRawMode(false);
}, [setRawMode]);
return <Text />;
};How to fix
Use the corrected pattern as a reference. Preserve behavior that the rule does not require you to change.
Copyable fix prompt
Copy this self-contained prompt into your coding agent after you confirm the diagnostic.
Fix every confirmed
Reference transformation:Before:react-doctor/ink-no-direct-raw-mode diagnostic in the current repository.
Required change:
- Move useStdin().setRawMode() to an effect and restore it in cleanup.import { Text, useStdin } from "ink";
const App = () => {
const { setRawMode } = useStdin();
setRawMode(true);
return <Text />;
};import { Text, useStdin } from "ink";
import { useEffect } from "react";
const App = () => {
const { setRawMode } = useStdin();
useEffect(() => {
setRawMode(true);
return () => setRawMode(false);
}, [setRawMode]);
return <Text />;
};Constraints:
- Confirm the reported code matches the Before pattern.
- Make the smallest change that fixes the root cause.
- Preserve behavior and interfaces unrelated to this diagnostic.
- Reuse existing project components, utilities, and conventions.
- Do not introduce render-phase side effects, render-phase state updates, or Hooks rule violations.
- Adapt identifiers and framework details instead of copying blindly.
- Do not disable the rule or suppress matching code.
- Confirm this rule is enabled for the project:
Ink >= 3.0.0.
Verification:
- Run focused tests for the changed behavior.
- Run React Doctor and confirm this diagnostic no longer appears.
- Report the files changed and any checks you could not run.Related rules
More Bugs rules from the rules reference:
react-doctor/ink-no-dom-host-elements: DOM element used in an Ink treereact-doctor/ink-no-dom-router: DOM router used in an Ink treereact-doctor/ink-no-focus-in-render: Ink focus changed during renderreact-doctor/ink-no-layout-inside-text: Layout component nested in Ink Textreact-doctor/ink-no-live-hooks-in-render-to-string: Inert input hook used during string rendering