sailfork / t3code-github / oxlint-plugin-t3code/ rules/ no-unreasoned-state-sync.test.ts

import { assert, describe } from "@effect/vitest";

import { createOxlintRuleHarness } from "../test/utils.ts";

const reports = (output: string) =>
  output.match(/t3code\(no-unreasoned-state-sync\)/g)?.length ?? 0;
const lint = (filename: string) =>
  createOxlintRuleHarness("t3code/no-unreasoned-state-sync", { filename });

const component = lint("apps/web/src/Panel.tsx");

describe("t3code/no-unreasoned-state-sync", () => {
  component.invalid(
    "reports every effect hook, including member calls",
    `import React, { useEffect } from "react";
export function Panel() {
  useEffect(() => {}, []);
  React.useLayoutEffect(() => {});
  React.useInsertionEffect(() => {});
  return null;
}
`,
    (output) => assert.strictEqual(reports(output), 3),
  );

  component.valid(
    "ignores comments, strings and lookalike names",
    `// useEffect(() => {}) in a comment
/* React.useLayoutEffect(() => {}) */
const label = "useEffect(() => {})";
const pipeline = Effect.matchCauseEffect(effect, {});
const alias = useEffect;
`,
  );

  component.valid(
    "accepts an effect whose suppression states its reason",
    `export function Panel() {
  // oxlint-disable-next-line t3code/no-unreasoned-state-sync -- subscribes to the window's resize events
  React.useEffect(() => {});
  return null;
}
`,
  );

  for (const filename of [
    "apps/web/src/Panel.test.tsx",
    "apps/web/src/Panel.spec.tsx",
    "apps/web/tests/Panel.tsx",
  ]) {
    lint(filename).valid(
      `skips ${filename}`,
      `export function Panel() { useEffect(() => {}); return null; }`,
    );
  }
});