`react-doctor/ink-use-string-width-for-cursor`

String length used as terminal column width

Category: Bugs
Severity: warn
Source: oxlint-plugin-react-doctor
Framework: global
Enabled when: Ink >= 6.7.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-use-string-width-for-cursor. 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 { useCursor } from "ink";

const App = ({ label }) => {
  const cursor = useCursor();
  cursor.setCursorPosition({ x: label.length, y: 0 });
  return null;
};

Corrected pattern

import { useCursor } from "ink";
import stringWidth from "string-width";

const App = ({ label }) => {
  const cursor = useCursor();
  cursor.setCursorPosition({
    x: stringWidth(label),
    y: 0,
  });
  return null;
};

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 react-doctor/ink-use-string-width-for-cursor diagnostic in the current repository. Required change: - Measure terminal columns with string-width before calling setCursorPosition.

Reference transformation:Before:

import { useCursor } from "ink";

const App = ({ label }) => {
  const cursor = useCursor();
  cursor.setCursorPosition({ x: label.length, y: 0 });
  return null;
};

After:

import { useCursor } from "ink";
import stringWidth from "string-width";

const App = ({ label }) => {
  const cursor = useCursor();
  cursor.setCursorPosition({
    x: stringWidth(label),
    y: 0,
  });
  return null;
};

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 >= 6.7.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.

More Bugs rules from the rules reference:

react-doctor/ink-use-suspend-terminal: Interactive child process bypasses Ink suspension
react-doctor/jotai-derived-atom-returns-fresh-object: Split the derivation into per-field primitive derived atoms, or wrap with selectAtom(source, fn, shallow) from jotai/utils when a wrapper object is required.
react-doctor/jotai-select-atom-in-render-body: Lift selectAtom to module scope, or wrap it: const a = useMemo(() => selectAtom(base, fn), [deps])
react-doctor/jotai-tq-use-raw-query-atom: Derive the field once, then subscribe to the derived atom: const dataAtom = atom((get) => get(queryAtom).data)
react-doctor/jsx-key: Require a stable key on elements rendered from arrays or iterators so React can reconcile list items correctly.

react-doctor/ink-use-string-width-for-cursor