@retreejs/react-eslint-plugin

Type-aware ESLint rules for Retree React applications. This package is an early feasibility implementation published on npm.

Install

npm install --save-dev @retreejs/react-eslint-plugin

Running npm create @retreejs@latest in an existing React + ESLint + TypeScript project also offers this package by default and can update a recognizable eslint.config.mjs automatically.

no-unobserved-react-read

Detects render-time reads that cross beyond the node observed by useNode or the default mode of useRaw:

const state = useNode(project);
return <span>{state.owner.name}</span>;
//                         ^ owner is not observed

Observe the child, select the value, or deliberately subscribe to the subtree:

const state = useNode(project);
const owner = useNode(state.owner);
return <span>{owner.name}</span>;

Setup

The TypeScript preset is a complete flat-config array: it selects TypeScript and TSX files, configures typed parsing, registers the plugin, and enables the rule as an error.

import { defineConfig } from "eslint/config";
import retree from "@retreejs/react-eslint-plugin/typescript";

export default defineConfig([
    // ...other configs
    ...retree,
]);

Spec and test files are excluded from this preset. Import the default export from @retreejs/react-eslint-plugin when you need to register the plugin in a custom typed configuration instead. The rule requires TypeScript parser services even when configured manually; .js and .jsx source files are not supported by the convenience preset yet.

The first implementation covers direct Retree hooks, local aliases and destructuring, array render callbacks, JSX, hook dependency arrays, and paired direct-child useRaw conversions. It deliberately skips uncertain values and does not yet summarize ReactiveNode.dependencies, decorators, getters, or methods. Map/Set provenance, Object.*/JSON.stringify/structuredClone whole-value consumers, same-file custom-hook return summaries, and nested named components that close over an outer component's hook result are also deferred.