`react-doctor/react-router-require-root-error-boundary`

Root route lacks an error boundary

Category: Bugs
Severity: error
Source: oxlint-plugin-react-doctor
Framework: global
Enabled when: react-router:6.4
Tags: test-noise
Default: Enabled

Validate the diagnostic

Confirm the reported code matches this rule before you edit it.

Confirm the reported code matches react-doctor/react-router-require-root-error-boundary. 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

createBrowserRouter([
  { path: "/", Component: Root, children: routes },
]);

Corrected pattern

createBrowserRouter([
  {
    path: "/",
    Component: Root,
    ErrorBoundary: RootErrorBoundary,
    children: routes,
  },
]);

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/react-router-require-root-error-boundary diagnostic in the current repository. Required change: - Define ErrorBoundary or errorElement on the root route so rendering, loader, and action failures have an application fallback.

Reference transformation:Before:

createBrowserRouter([
  { path: "/", Component: Root, children: routes },
]);

After:

createBrowserRouter([
  {
    path: "/",
    Component: Root,
    ErrorBoundary: RootErrorBoundary,
    children: routes,
  },
]);

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: react-router:6.4. 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/react-router-resource-link-requires-reload: Resource link intercepted as navigation
react-doctor/react-router-return-navigation-promise-in-transition: Transition drops a navigation promise
react-doctor/react-router-server-middleware-return-response: Server middleware drops the Response
react-doctor/react-router-session-mutation-requires-commit: Session mutation is not committed
react-doctor/react-router-valid-route-object: Contradictory route object

react-doctor/react-router-require-root-error-boundary