Switch popups to $lib/skeletonExtensions and add ESLint rule to warn …

…about using the wrong one
satisfactorymodding · Sep 15, 2024 · 28db601 · 28db601
1 parent ec3c272
commit 28db601
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 5 deletions.
diff --git a/frontend/.eslintrc.cjs b/frontend/.eslintrc.cjs
@@ -90,6 +90,15 @@ module.exports = {
     'import/order': ['error', { 'newlines-between': 'always', alphabetize: { order: 'asc' } }],
     'import/newline-after-import': ['error'],
     'import/no-duplicates': ['error'],
-    'no-restricted-imports': ['error', { patterns: ['*/lib/*', '..*', '**/wailsjs/**/*'] }],
+    'no-restricted-imports': ['error', {
+      patterns: [
+        { group: ['*/lib/*'] },
+        { group: ['..*'], message: 'No relative imports' }, 
+        { group: ['**/wailsjs/**/*'], message: 'Use $wailsjs/runtime instead' },
+      ],
+      paths: [
+        { name: '@skeletonlabs/skeleton', importNames: ['popup', 'PopupSettings'], message: 'Use $lib/skeletonExtensions instead to properly handle hover popups.' },
+      ],
+    }],
   },
 };
diff --git a/frontend/src/lib/components/left-bar/LeftBar.svelte b/frontend/src/lib/components/left-bar/LeftBar.svelte
@@ -1,6 +1,5 @@
 <script lang="ts">
   import { mdiAlert, mdiCheckCircle, mdiCloseCircle, mdiDownload, mdiFolderOpen, mdiHelp, mdiHelpCircle, mdiLoading, mdiMonitor, mdiPencil, mdiPlusCircle, mdiServer, mdiServerNetwork, mdiTrashCan, mdiUpload, mdiWeb } from '@mdi/js';
-  import { type PopupSettings, popup } from '@skeletonlabs/skeleton';
   import _ from 'lodash';
   import { siDiscord, siGithub } from 'simple-icons/icons';
 
@@ -14,7 +13,7 @@
   import Tooltip from '$lib/components/Tooltip.svelte';
   import DeleteProfile from '$lib/components/modals/profiles/DeleteProfile.svelte';
   import RenameProfile from '$lib/components/modals/profiles/RenameProfile.svelte';
-  import { getModalStore } from '$lib/skeletonExtensions';
+  import { type PopupSettings, getModalStore, popup } from '$lib/skeletonExtensions';
   import { queuedMods } from '$lib/store/actionQueue';
   import { canChangeInstall, canModify, installs, installsMetadata, modsEnabled, profiles, selectedInstall, selectedProfile } from '$lib/store/ficsitCLIStore';
   import { error, siteURL } from '$lib/store/generalStore';

diff --git a/frontend/src/lib/components/modals/ErrorDetails.svelte b/frontend/src/lib/components/modals/ErrorDetails.svelte
@@ -1,11 +1,11 @@
 <script lang="ts">
-  import { type PopupSettings, popup } from '@skeletonlabs/skeleton';
   import { getTranslate } from '@tolgee/svelte';
 
   import T from '$lib/components/T.svelte';
   import Tooltip from '$lib/components/Tooltip.svelte';
+  import { type PopupSettings, popup } from '$lib/skeletonExtensions';
   import { GenerateDebugInfo } from '$wailsjs/go/app/app';
-  import { BrowserOpenURL, LogError } from '$wailsjs/runtime/runtime';
+  import { BrowserOpenURL } from '$wailsjs/runtime/runtime';
 
   export let onClose: (() => void) | null = null;