Feature request: abortController + no-leaked-event-listener · jsx-eslint/eslint-plugin-react#3967

(3 留言) (0 反應) (0 負責人)JavaScript (8,630 star) (2,797 fork)batch import

bughelp wanted

描述

i've been using this pattern to clean up event listeners lately:

useEffect(() => {
  const abortController = new AbortController();
  const { signal } = abortController;

  window.addEventListener(
    "click",
    (event) => {
      doSomething();
    },
    { signal },
  );

  window.addEventListener(
    "resize",
    (event) => {
      doSomethingElse();
    },
    { signal },
  );

  return () => {
    abortController.abort();
  };
}, []);

it makes the cleanup function much smaller (and harder to mess up), plus it helps with type inference (i.e. you don't need to explicitly type your event handlers).

i can obviously just disable the no-leaked-event-listener rule, but it would be nice if it could detect this pattern with a heuristic, and maybe even alert you e.g. if you forget to pass signal or forget to call abort().

貢獻者指南

技術棧: javascripttypescriptreact
領域: developer experiencetooling
議題類型: feature
難度: 3
預計時間: 1-2 days
活動狀態: active
清晰度: clear
前置要求: ESLint rule developmentReact useEffectAST basics
新手友善度: 50
研究方向: Examine the existing no leaked event listener rule implementation in the eslint plugin react repository. The rule likely traverses useEffect callbacks and looks for addEventListener with cleanup. To support the AbortController pattern, the rule should be extended to detect when an AbortController is created and its signal is passed to addEventListener, and ensure that abort() is called in the cleanup. Look at the rule's source code and any related pull requests or discussions. Consider adding a heuristic that checks for the abortController.abort() call in the return function and verifies the signal is used.