5

我有一个关于 eslint-plugin-react-hooks 的问题。

我想减少执行 API 调用并将结果存储到状态中的样板代码,因此我创建了一个自定义挂钩:

export const loading = Symbol('Api Loading');
export const responseError = Symbol('Api Error');

export function useApi<T>(
    apiCall: () => CancelablePromise<T>,
    deps: DependencyList
): T | (typeof loading) | (typeof responseError) {
    const [response, setResponse] = useState<T | (typeof loading) | (typeof responseError)>(loading);
    useEffect(() => {
        const cancelablePromise = apiCall();
        cancelablePromise.promise
            .then(r => setResponse(r))
            .catch(e => {
                console.error(e);
                setResponse(responseError);
            });
        return () => cancelablePromise.cancel();
    }, deps); // React Hook useEffect has a missing dependency: 'apiCall'. Either include it or remove the dependency array. If 'apiCall' changes too often, find the parent component that defines it and wrap that definition in useCallback (react-hooks/exhaustive-deps)
    return response;
}

现在自定义钩子效果很好,但 eslint-plugin-react-hooks 没有那么多。我的代码中的警告不是一个大问题。我知道我可以通过添加评论来消除此警告:

// eslint-disable-next-line react-hooks/exhaustive-deps

问题是自定义钩子参数之一是依赖列表,而 eslint-plugin-react-hooks 不会检测到缺少的依赖项。如何让 eslint-plugin-react-hooks 正确检测自定义挂钩的依赖项列表问题?甚至可以对自定义钩子进行这种检测吗?

4

2 回答 2

5

react-hooks/exhaustive-deps规则允许您检查自定义挂钩。从高级配置选项:

可以配置extentive-deps 以使用附加Hooks 选项验证自定义Hooks 的依赖关系。此选项接受正则表达式来匹配具有依赖关系的自定义 Hook 的名称。

{   
  "rules": {
    // ...
    "react-hooks/exhaustive-deps": ["warn", {
      "additionalHooks": "(useMyCustomHook|useMyOtherCustomHook)"
    }]   
  }
} 

在您的.eslintrc文件中,在“规则”配置中添加以下条目:

'react-hooks/exhaustive-deps': ['warn', {
      'additionalHooks': '(useApi)'
    }],

然后你应该能够调用你的钩子并看到 linter 警告并使用 Quick Fix 选项。

在此处输入图像描述

于 2021-07-17T01:06:32.083 回答
2

似乎 eslint-plugin-react-hooks 不支持依赖列表作为自定义挂钩中的参数(据我所知)。正如dangerismycat 所建议的那样,useCallback 有一个解决方法。

所以不要这样做:

const apiResult = useApi(() => apiCall(a, b, c), [a, b, c]);

没有依赖列表参数的自定义钩子也可以实现相同的功能:

const callback = useCallback(() => apiCall(a, b, c), [a, b, c]);
const apiResult = useApi(callback);

虽然它引入了更多样板并且代码更难阅读,但我不太介意。

于 2020-02-08T14:53:39.410 回答