ESLint to enforce Actual's useNavigate hook (actualbudget#2208)

* ESLint to enforce Actual's useNavigate hook * Release notes --------- Co-authored-by: Matiss Janis Aboltins <[email protected]>
FlorianLang06 · Jan 9, 2024 · b960da8 · b960da8
1 parent 9fc2486
commit b960da8
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 1 deletion.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -201,6 +201,26 @@ module.exports = {
         ],
       },
     },
+    {
+      files: ['./packages/desktop-client/**/*'],
+      excludedFiles: [
+        './packages/desktop-client/src/hooks/useNavigate.{ts,tsx}',
+      ],
+      rules: {
+        'no-restricted-imports': [
+          'warn',
+          {
+            patterns: [
+              {
+                group: ['react-router-dom'],
+                importNames: ['useNavigate'],
+                message: 'Please use Actual’s useNavigate() hook instead.',
+              },
+            ],
+          },
+        ],
+      },
+    },
     {
       files: ['./packages/loot-core/src/**/*'],
       rules: {

diff --git a/packages/desktop-client/src/components/FinancesApp.tsx b/packages/desktop-client/src/components/FinancesApp.tsx
@@ -5,7 +5,6 @@ import {
   Route,
   Routes,
   Navigate,
-  useNavigate,
   BrowserRouter,
   useLocation,
   useHref,
@@ -20,6 +19,7 @@ import { checkForUpdateNotification } from 'loot-core/src/client/update-notifica
 import * as undo from 'loot-core/src/platform/client/undo';
 
 import { useActions } from '../hooks/useActions';
+import { useNavigate } from '../hooks/useNavigate';
 import { useResponsive } from '../ResponsiveProvider';
 import { theme } from '../style';
 import { ExposeNavigate } from '../util/router-tools';

diff --git a/upcoming-release-notes/2208.md b/upcoming-release-notes/2208.md
@@ -0,0 +1,6 @@
+---
+category: Maintenance
+authors: [joel-jeremy]
+---
+
+ESLint to enforce Actual's useNavigate hook