Define effects in useEffect call

Workaround for biomejs/biome#3080
wojtekmaj · Jun 13, 2024 · 2076754 · 2076754
1 parent b44c566
commit 2076754
Show file tree

Hide file tree

Showing 8 changed files with 410 additions and 408 deletions.
diff --git a/packages/react-pdf/src/Document.tsx b/packages/react-pdf/src/Document.tsx
@@ -485,51 +485,53 @@ const Document = forwardRef(function Document(
     }
   }
 
-  function resetDocument() {
-    pdfDispatch({ type: 'RESET' });
-  }
-
-  // biome-ignore lint/correctness/useExhaustiveDependencies: See https://github.com/biomejs/biome/issues/3080
-  useEffect(resetDocument, [pdfDispatch, source]);
-
-  function loadDocument() {
-    if (!source) {
-      return;
-    }
-
-    const documentInitParams: Source = {
-      ...source,
-      ...options,
-    };
-
-    const destroyable = pdfjs.getDocument(documentInitParams);
-    if (onLoadProgress) {
-      destroyable.onProgress = onLoadProgress;
-    }
-    if (onPassword) {
-      destroyable.onPassword = onPassword;
-    }
-    const loadingTask = destroyable;
-
-    loadingTask.promise
-      .then((nextPdf) => {
-        pdfDispatch({ type: 'RESOLVE', value: nextPdf });
-      })
-      .catch((error) => {
-        if (loadingTask.destroyed) {
-          return;
-        }
+  // biome-ignore lint/correctness/useExhaustiveDependencies: useEffect intentionally triggered on source change
+  useEffect(
+    function resetDocument() {
+      pdfDispatch({ type: 'RESET' });
+    },
+    [pdfDispatch, source],
+  );
 
-        pdfDispatch({ type: 'REJECT', error });
-      });
+  // biome-ignore lint/correctness/useExhaustiveDependencies: Ommitted callbacks so they are not called every time they change
+  useEffect(
+    function loadDocument() {
+      if (!source) {
+        return;
+      }
 
-    return () => {
-      loadingTask.destroy();
-    };
-  }
+      const documentInitParams: Source = {
+        ...source,
+        ...options,
+      };
 
-  // biome-ignore lint/correctness/useExhaustiveDependencies: See https://github.com/biomejs/biome/issues/3080
-  useEffect(loadDocument, [options, pdfDispatch, source]);
+      const destroyable = pdfjs.getDocument(documentInitParams);
+      if (onLoadProgress) {
+        destroyable.onProgress = onLoadProgress;
+      }
+      if (onPassword) {
+        destroyable.onPassword = onPassword;
+      }
+      const loadingTask = destroyable;
+
+      loadingTask.promise
+        .then((nextPdf) => {
+          pdfDispatch({ type: 'RESOLVE', value: nextPdf });
+        })
+        .catch((error) => {
+          if (loadingTask.destroyed) {
+            return;
+          }
+
+          pdfDispatch({ type: 'REJECT', error });
+        });
+
+      return () => {
+        loadingTask.destroy();
+      };
+    },
+    [options, pdfDispatch, source],
+  );
 
   // biome-ignore lint/correctness/useExhaustiveDependencies: Ommitted callbacks so they are not called every time they change
   useEffect(() => {
@@ -545,14 +547,14 @@ const Document = forwardRef(function Document(
     onLoadSuccess();
   }, [pdf]);
 
-  function setupLinkService() {
-    linkService.current.setViewer(viewer.current);
-    linkService.current.setExternalLinkRel(externalLinkRel);
-    linkService.current.setExternalLinkTarget(externalLinkTarget);
-  }
-
-  // biome-ignore lint/correctness/useExhaustiveDependencies: See https://github.com/biomejs/biome/issues/3080
-  useEffect(setupLinkService, [externalLinkRel, externalLinkTarget]);
+  useEffect(
+    function setupLinkService() {
+      linkService.current.setViewer(viewer.current);
+      linkService.current.setExternalLinkRel(externalLinkRel);
+      linkService.current.setExternalLinkTarget(externalLinkTarget);
+    },
+    [externalLinkRel, externalLinkTarget],
+  );
 
   const registerPage = useCallback((pageIndex: number, ref: HTMLDivElement) => {
     pages.current[pageIndex] = ref;

diff --git a/packages/react-pdf/src/Outline.tsx b/packages/react-pdf/src/Outline.tsx
@@ -115,35 +115,36 @@ export default function Outline(props: OutlineProps) {
     }
   }
 
-  function resetOutline() {
-    outlineDispatch({ type: 'RESET' });
-  }
-
-  // biome-ignore lint/correctness/useExhaustiveDependencies: See https://github.com/biomejs/biome/issues/3080
-  useEffect(resetOutline, [outlineDispatch, pdf]);
-
-  function loadOutline() {
-    if (!pdf) {
-      // Impossible, but TypeScript doesn't know that
-      return;
-    }
-
-    const cancellable = makeCancellable(pdf.getOutline());
-    const runningTask = cancellable;
-
-    cancellable.promise
-      .then((nextOutline) => {
-        outlineDispatch({ type: 'RESOLVE', value: nextOutline });
-      })
-      .catch((error) => {
-        outlineDispatch({ type: 'REJECT', error });
-      });
-
-    return () => cancelRunningTask(runningTask);
-  }
+  // biome-ignore lint/correctness/useExhaustiveDependencies: useEffect intentionally triggered on pdf change
+  useEffect(
+    function resetOutline() {
+      outlineDispatch({ type: 'RESET' });
+    },
+    [outlineDispatch, pdf],
+  );
 
-  // biome-ignore lint/correctness/useExhaustiveDependencies: See https://github.com/biomejs/biome/issues/3080
-  useEffect(loadOutline, [outlineDispatch, pdf]);
+  useEffect(
+    function loadOutline() {
+      if (!pdf) {
+        // Impossible, but TypeScript doesn't know that
+        return;
+      }
+
+      const cancellable = makeCancellable(pdf.getOutline());
+      const runningTask = cancellable;
+
+      cancellable.promise
+        .then((nextOutline) => {
+          outlineDispatch({ type: 'RESOLVE', value: nextOutline });
+        })
+        .catch((error) => {
+          outlineDispatch({ type: 'REJECT', error });
+        });
+
+      return () => cancelRunningTask(runningTask);
+    },
+    [outlineDispatch, pdf],
+  );
 
   // biome-ignore lint/correctness/useExhaustiveDependencies: Ommitted callbacks so they are not called every time they change
   useEffect(() => {

diff --git a/packages/react-pdf/src/Page.tsx b/packages/react-pdf/src/Page.tsx
@@ -387,21 +387,22 @@ export default function Page(props: PageProps) {
     return scaleWithDefault * pageScale;
   }, [height, page, rotate, scaleProps, width]);
 
-  function hook() {
-    return () => {
-      if (!isProvided(pageIndex)) {
-        // Impossible, but TypeScript doesn't know that
-        return;
-      }
-
-      if (_enableRegisterUnregisterPage && unregisterPage) {
-        unregisterPage(pageIndex);
-      }
-    };
-  }
-
-  // biome-ignore lint/correctness/useExhaustiveDependencies: See https://github.com/biomejs/biome/issues/3080
-  useEffect(hook, [_enableRegisterUnregisterPage, pdf, pageIndex, unregisterPage]);
+  // biome-ignore lint/correctness/useExhaustiveDependencies: useEffect intentionally triggered on pdf change
+  useEffect(
+    function hook() {
+      return () => {
+        if (!isProvided(pageIndex)) {
+          // Impossible, but TypeScript doesn't know that
+          return;
+        }
+
+        if (_enableRegisterUnregisterPage && unregisterPage) {
+          unregisterPage(pageIndex);
+        }
+      };
+    },
+    [_enableRegisterUnregisterPage, pdf, pageIndex, unregisterPage],
+  );
 
   /**
    * Called when a page is loaded successfully
@@ -442,34 +443,35 @@ export default function Page(props: PageProps) {
     }
   }
 
-  function resetPage() {
-    pageDispatch({ type: 'RESET' });
-  }
-
-  // biome-ignore lint/correctness/useExhaustiveDependencies: See https://github.com/biomejs/biome/issues/3080
-  useEffect(resetPage, [pageDispatch, pdf, pageIndex]);
-
-  function loadPage() {
-    if (!pdf || !pageNumber) {
-      return;
-    }
+  // biome-ignore lint/correctness/useExhaustiveDependencies: useEffect intentionally triggered on pdf and pageIndex change
+  useEffect(
+    function resetPage() {
+      pageDispatch({ type: 'RESET' });
+    },
+    [pageDispatch, pdf, pageIndex],
+  );
 
-    const cancellable = makeCancellable(pdf.getPage(pageNumber));
-    const runningTask = cancellable;
+  useEffect(
+    function loadPage() {
+      if (!pdf || !pageNumber) {
+        return;
+      }
 
-    cancellable.promise
-      .then((nextPage) => {
-        pageDispatch({ type: 'RESOLVE', value: nextPage });
-      })
-      .catch((error) => {
-        pageDispatch({ type: 'REJECT', error });
-      });
+      const cancellable = makeCancellable(pdf.getPage(pageNumber));
+      const runningTask = cancellable;
 
-    return () => cancelRunningTask(runningTask);
-  }
+      cancellable.promise
+        .then((nextPage) => {
+          pageDispatch({ type: 'RESOLVE', value: nextPage });
+        })
+        .catch((error) => {
+          pageDispatch({ type: 'REJECT', error });
+        });
 
-  // biome-ignore lint/correctness/useExhaustiveDependencies: See https://github.com/biomejs/biome/issues/3080
-  useEffect(loadPage, [pageDispatch, pdf, pageNumber]);
+      return () => cancelRunningTask(runningTask);
+    },
+    [pageDispatch, pdf, pageNumber],
+  );
 
   // biome-ignore lint/correctness/useExhaustiveDependencies: Ommitted callbacks so they are not called every time they change
   useEffect(() => {