test: ensure we stay in sync with ionic imports

Author: danielroe

src/imports.ts

@@ -0,0 +1,109 @@
+/* Ionic Hooks and components */
+
+// If you are about to add a hook or component to one of the array below, please do so
+// in alphabetical order. This makes it easier to find and check if certain hooks & components are there
+
+export const IonicHooks = [
+  'createAnimation',
+  'createGesture',
+  'getPlatforms',
+  'getTimeGivenProgression',
+  'iosTransitionAnimation',
+  'isPlatform',
+  'mdTransitionAnimation',
+  'menuController',
+  'onIonViewDidEnter',
+  'onIonViewDidLeave',
+  'onIonViewWillEnter',
+  'onIonViewWillLeave',
+  'useBackButton',
+  'useIonRouter',
+  'useKeyboard',
+]
+
+export const IonicBuiltInComponents = [
+  'IonAccordion',
+  'IonAccordionGroup',
+  'IonActionSheet',
+  'IonAlert',
+  'IonApp',
+  'IonAvatar',
+  'IonBackButton',
+  'IonBackdrop',
+  'IonBadge',
+  'IonBreadcrumb',
+  'IonBreadcrumbs',
+  'IonButton',
+  'IonButtons',
+  'IonCard',
+  'IonCardContent',
+  'IonCardHeader',
+  'IonCardSubtitle',
+  'IonCardTitle',
+  'IonCheckbox',
+  'IonChip',
+  'IonCol',
+  'IonContent',
+  'IonDatetime',
+  'IonDatetimeButton',
+  'IonFab',
+  'IonFabButton',
+  'IonFabList',
+  'IonFooter',
+  'IonGrid',
+  'IonHeader',
+  'IonIcon',
+  'IonImg',
+  'IonInfiniteScroll',
+  'IonInfiniteScrollContent',
+  'IonInput',
+  'IonItem',
+  'IonItemDivider',
+  'IonItemGroup',
+  'IonItemOption',
+  'IonItemOptions',
+  'IonItemSliding',
+  'IonLabel',
+  'IonList',
+  'IonListHeader',
+  'IonLoading',
+  'IonMenu',
+  'IonMenuButton',
+  'IonMenuToggle',
+  'IonModal',
+  'IonNav',
+  'IonNavLink',
+  'IonNote',
+  'IonPage',
+  'IonPicker',
+  'IonPopover',
+  'IonProgressBar',
+  'IonRadio',
+  'IonRadioGroup',
+  'IonRange',
+  'IonRefresher',
+  'IonRefresherContent',
+  'IonReorder',
+  'IonReorderGroup',
+  'IonRippleEffect',
+  'IonRouterOutlet',
+  'IonRow',
+  'IonSearchbar',
+  'IonSegment',
+  'IonSegmentButton',
+  'IonSelect',
+  'IonSelectOption',
+  'IonSkeletonText',
+  'IonSpinner',
+  'IonSplitPane',
+  'IonTabBar',
+  'IonTabButton',
+  'IonTabs',
+  'IonText',
+  'IonTextarea',
+  'IonThumbnail',
+  'IonTitle',
+  'IonToast',
+  'IonToggle',
+  'IonToolbar',
+]

src/module.ts

@@ -12,6 +12,7 @@ import { readPackageJSON } from 'pkg-types'
 import { defineUnimportPreset } from 'unimport'
 
 import { runtimeDir } from './utils'
+import { IonicBuiltInComponents, IonicHooks } from './imports'
 
 import { setupUtilityComponents } from './parts/components'
 import { useCSSSetup } from './parts/css'
@@ -184,113 +185,3 @@ export default defineNuxtModule<ModuleOptions>({
     }
   },
 })
-
-/* Ionic Hooks and components */
-
-// If you are about to add a hook or component to one of the array below, please do so
-// in alphabetical order. This makes it easier to find and check if certain hooks & components are there
-
-const IonicHooks = [
-  'createAnimation',
-  'createGesture',
-  'getPlatforms',
-  'getTimeGivenProgression',
-  'iosTransitionAnimation',
-  'isPlatform',
-  'mdTransitionAnimation',
-  'menuController',
-  'onIonViewDidEnter',
-  'onIonViewDidLeave',
-  'onIonViewWillEnter',
-  'onIonViewWillLeave',
-  'useBackButton',
-  'useIonRouter',
-  'useKeyboard',
-]
-
-const IonicBuiltInComponents = [
-  'IonAccordion',
-  'IonAccordionGroup',
-  'IonActionSheet',
-  'IonAlert',
-  'IonApp',
-  'IonAvatar',
-  'IonBackButton',
-  'IonBackdrop',
-  'IonBadge',
-  'IonBreadcrumb',
-  'IonBreadcrumbs',
-  'IonButton',
-  'IonButtons',
-  'IonCard',
-  'IonCardContent',
-  'IonCardHeader',
-  'IonCardSubtitle',
-  'IonCardTitle',
-  'IonCheckbox',
-  'IonChip',
-  'IonCol',
-  'IonContent',
-  'IonDatetime',
-  'IonDatetimeButton',
-  'IonFab',
-  'IonFabButton',
-  'IonFabList',
-  'IonFooter',
-  'IonGrid',
-  'IonHeader',
-  'IonIcon',
-  'IonImg',
-  'IonInfiniteScroll',
-  'IonInfiniteScrollContent',
-  'IonInput',
-  'IonItem',
-  'IonItemDivider',
-  'IonItemGroup',
-  'IonItemOption',
-  'IonItemOptions',
-  'IonItemSliding',
-  'IonLabel',
-  'IonList',
-  'IonListHeader',
-  'IonLoading',
-  'IonMenu',
-  'IonMenuButton',
-  'IonMenuToggle',
-  'IonModal',
-  'IonNav',
-  'IonNavLink',
-  'IonNote',
-  'IonPage',
-  'IonPicker',
-  'IonPopover',
-  'IonProgressBar',
-  'IonRadio',
-  'IonRadioGroup',
-  'IonRange',
-  'IonRefresher',
-  'IonRefresherContent',
-  'IonReorder',
-  'IonReorderGroup',
-  'IonRippleEffect',
-  'IonRouterOutlet',
-  'IonRow',
-  'IonSearchbar',
-  'IonSegment',
-  'IonSegmentButton',
-  'IonSelect',
-  'IonSelectOption',
-  'IonSkeletonText',
-  'IonSpinner',
-  'IonSplitPane',
-  'IonTabBar',
-  'IonTabButton',
-  'IonTabs',
-  'IonText',
-  'IonTextarea',
-  'IonThumbnail',
-  'IonTitle',
-  'IonToast',
-  'IonToggle',
-  'IonToolbar',
-]

test/unit/imports.spec.ts

@@ -0,0 +1,33 @@
+import { expect, describe, it } from 'vitest'
+import * as ionicVue from '@ionic/vue'
+import { IonicBuiltInComponents, IonicHooks } from '../../src/imports'
+
+const ExportedHelpers = Object.keys(ionicVue) as Array<keyof typeof ionicVue>
+const RegisteredHelpers = [...IonicBuiltInComponents, ...IonicHooks]
+
+const ExcludedHelpers: Array<keyof typeof ionicVue> = [
+  'IonicSafeString',
+  'IonicSlides',
+  'IonicVue',
+  'actionSheetController',
+  'alertController',
+  'loadingController',
+  'modalController',
+  'pickerController',
+  'popoverController',
+  'toastController',
+]
+
+describe('imports:ionic', () => {
+  it('should not register anything that is not exported', () => {
+    for (const helper of RegisteredHelpers) {
+      expect(ExportedHelpers).toContain(helper)
+    }
+  })
+  it('should register everything that is exported', () => {
+    for (const helper of ExportedHelpers) {
+      if (ExcludedHelpers.includes(helper)) continue
+      expect(RegisteredHelpers).toContain(helper)
+    }
+  })
+})