From 5012012cb28c4b5d246ea7fc9b863db34fb3f7e7 Mon Sep 17 00:00:00 2001
From: Anthony Fu <anthonyfu117@hotmail.com>
Date: Thu, 10 Aug 2023 15:31:37 +0200
Subject: [PATCH] feat: filter for used/unused components, close #358

---
 .../devtools-kit/src/_types/integrations.ts   |  7 ++
 .../src/components/NSelectTabs.vue            |  2 +-
 .../client/components/ComponentItem.vue       | 20 ++---
 .../client/components/ComponentsList.vue      | 74 ++++++++++++-------
 packages/devtools/client/composables/utils.ts | 20 ++++-
 .../devtools/client/pages/modules/imports.vue | 25 +++++--
 6 files changed, 97 insertions(+), 51 deletions(-)

diff --git a/packages/devtools-kit/src/_types/integrations.ts b/packages/devtools-kit/src/_types/integrations.ts
index 55cb4f19e..e446d60fc 100644
--- a/packages/devtools-kit/src/_types/integrations.ts
+++ b/packages/devtools-kit/src/_types/integrations.ts
@@ -1,5 +1,6 @@
 import type { RouteRecordNormalized } from 'vue-router'
 import type { Import, UnimportMeta } from 'unimport'
+import type { Component } from 'nuxt/schema'
 
 export interface HookInfo {
   name: string
@@ -195,3 +196,9 @@ export interface ComponentRelationship {
   id: string
   deps: string[]
 }
+
+export interface ComponentWithRelationships {
+  component: Component
+  dependencies?: string[]
+  dependents?: string[]
+}
diff --git a/packages/devtools-ui-kit/src/components/NSelectTabs.vue b/packages/devtools-ui-kit/src/components/NSelectTabs.vue
index d079510e3..c0ffaf44f 100644
--- a/packages/devtools-ui-kit/src/components/NSelectTabs.vue
+++ b/packages/devtools-ui-kit/src/components/NSelectTabs.vue
@@ -18,7 +18,7 @@ const input = useVModel(props, 'modelValue', emit, { passive: true })
 
 <template>
   <fieldset
-    class="n-select-tabs flex flex-inline flex-wrap items-center border n-border-base rounded focus-within:n-focus-base focus-within:border-context n-bg-base"
+    class="n-select-tabs flex flex-inline flex-wrap items-center border n-border-base rounded n-bg-base"
   >
     <label
       v-for="i, idx of options"
diff --git a/packages/devtools/client/components/ComponentItem.vue b/packages/devtools/client/components/ComponentItem.vue
index 1e60ce7d3..aa32ffc6b 100644
--- a/packages/devtools/client/components/ComponentItem.vue
+++ b/packages/devtools/client/components/ComponentItem.vue
@@ -1,22 +1,12 @@
 <script setup lang="ts">
 import type { Component } from 'nuxt/schema'
-import type { ComponentRelationship } from '../../types'
 
 const props = defineProps<{
   component: Component
-  relationships?: ComponentRelationship[] | null
+  dependencies?: string[]
+  dependents?: string[]
 }>()
 
-const dependencies = computed(() => {
-  const deps = props.relationships?.find(i => i.id === props.component.filePath)?.deps
-  return deps?.map(i => props.relationships?.find(j => j.id === i)?.id).filter(Boolean) as string[]
-})
-
-const dependents = computed(() => {
-  const deps = props.relationships?.filter(i => i.deps.includes(props.component.filePath))
-  return deps?.map(i => props.relationships?.find(j => j.id === i.id)?.id).filter(Boolean) as string[]
-})
-
 // @ts-expect-error types
 const filePath = computed(() => props.component.filePath || props.component.file || props.component.__file || '')
 </script>
@@ -29,7 +19,7 @@ const filePath = computed(() => props.component.filePath || props.component.file
     w-full items-center rounded px2 py1
   >
     <VDropdown>
-      <button hover:text-primary>
+      <button hover:text-primary :class="dependents && dependents.length === 0 ? 'op50' : ''">
         <ComponentName :component="component" />
       </button>
       <template #popper>
@@ -41,8 +31,8 @@ const filePath = computed(() => props.component.filePath || props.component.file
         />
       </template>
     </VDropdown>
-    <sup v-if="dependents?.length" ml--1 op50>
-      {{ dependents?.length }}
+    <sup v-if="dependents?.length" ml--1 text-primary>
+      x{{ dependents?.length }}
     </sup>
     <Badge
       v-if="component.global"
diff --git a/packages/devtools/client/components/ComponentsList.vue b/packages/devtools/client/components/ComponentsList.vue
index 5707f7dd8..d6df7cee8 100644
--- a/packages/devtools/client/components/ComponentsList.vue
+++ b/packages/devtools/client/components/ComponentsList.vue
@@ -1,7 +1,7 @@
 <script setup lang="ts">
 import type { Component } from 'nuxt/schema'
 import Fuse from 'fuse.js'
-import type { ComponentRelationship } from '../../types'
+import type { ComponentRelationship, ComponentWithRelationships } from '../../types'
 
 const props = defineProps<{
   components: Component[]
@@ -9,20 +9,31 @@ const props = defineProps<{
 }>()
 
 const search = ref('')
+const filterMode = ref<'all' | 'using' | 'not-used'>('all')
 
-const fuse = computed(() => new Fuse(props.components, {
+const componentWithRelationships = computed(() => {
+  const components = props.components
+    .map(c => getComponentRelationships(c, props.relationships))
+  if (filterMode.value === 'using')
+    return components.filter(c => c.dependents?.length)
+  else if (filterMode.value === 'not-used')
+    return components.filter(c => !c.dependents?.length)
+  return components
+})
+
+const fuse = computed(() => new Fuse(componentWithRelationships.value, {
   keys: [
-    'pascalName',
-    'filePath',
-    'kebabName',
+    'component.pascalName',
+    'component.filePath',
+    'component.kebabName',
   ],
 }))
 
 const filtered = computed(() => {
-  const user: Component[] = []
-  const lib = new Map<string, Component[]>()
-  const builtin: Component[] = []
-  const runtime: Component[] = []
+  const user: ComponentWithRelationships[] = []
+  const lib = new Map<string, ComponentWithRelationships[]>()
+  const builtin: ComponentWithRelationships[] = []
+  const runtime: ComponentWithRelationships[] = []
 
   const count = {
     user: 0,
@@ -33,12 +44,13 @@ const filtered = computed(() => {
 
   const result = search.value
     ? fuse.value.search(search.value).map(i => i.item)
-    : props.components
+    : componentWithRelationships.value
 
   result
     .forEach((component) => {
-      if (component.filePath && isNodeModulePath(component.filePath)) {
-        const name = getModuleNameFromPath(component.filePath)
+      const c = component.component
+      if (c.filePath && isNodeModulePath(c.filePath)) {
+        const name = getModuleNameFromPath(c.filePath)
         if (!name)
           return
         if (name === 'nuxt') {
@@ -52,7 +64,7 @@ const filtered = computed(() => {
           count.lib++
         }
       }
-      else if (component.global && !component.filePath) {
+      else if (c.global && !c.filePath) {
         runtime.push(component)
         count.runtime++
       }
@@ -64,7 +76,6 @@ const filtered = computed(() => {
 
   return {
     count,
-
     user,
     builtin,
     lib,
@@ -74,10 +85,22 @@ const filtered = computed(() => {
 </script>
 
 <template>
-  <Navbar v-model:search="search">
+  <Navbar v-model:search="search" pb3>
     <template #actions>
       <slot />
     </template>
+    <div flex="~ gap-2 items-center">
+      <NIcon icon="carbon-filter" op50 />
+      <NSelectTabs
+        v-model="filterMode"
+        n="primary sm"
+        :options="[
+          { label: 'All', value: 'all' },
+          { label: 'Using', value: 'using' },
+          { label: 'Not used', value: 'not-used' },
+        ]"
+      />
+    </div>
   </Navbar>
   <NSectionBlock
     v-if="filtered.user.length"
@@ -88,9 +111,8 @@ const filtered = computed(() => {
   >
     <ComponentItem
       v-for="c of filtered.user"
-      :key="c.filePath"
-      :component="c"
-      :relationships="relationships"
+      :key="c.component.filePath"
+      v-bind="c"
     />
   </NSectionBlock>
   <NSectionBlock
@@ -101,9 +123,9 @@ const filtered = computed(() => {
     :description="`Total components: ${filtered.count.runtime}`"
   >
     <ComponentItem
-      v-for="c of filtered.runtime" :key="c.filePath"
-      :component="c"
-      :relationships="relationships"
+      v-for="c of filtered.runtime"
+      :key="c.component.filePath"
+      v-bind="c"
     />
   </NSectionBlock>
   <NSectionBlock
@@ -114,9 +136,8 @@ const filtered = computed(() => {
   >
     <ComponentItem
       v-for="c of filtered.builtin"
-      :key="c.filePath"
-      :component="c"
-      :relationships="relationships"
+      :key="c.component.filePath"
+      v-bind="c"
     />
   </NSectionBlock>
   <NSectionBlock
@@ -131,9 +152,8 @@ const filtered = computed(() => {
       <div pl4>
         <ComponentItem
           v-for="c of value"
-          :key="c.filePath"
-          :component="c"
-          :relationships="relationships"
+          :key="c.component.filePath"
+          v-bind="c"
         />
       </div>
     </div>
diff --git a/packages/devtools/client/composables/utils.ts b/packages/devtools/client/composables/utils.ts
index 327c93b6a..61fc7173e 100644
--- a/packages/devtools/client/composables/utils.ts
+++ b/packages/devtools/client/composables/utils.ts
@@ -1,7 +1,8 @@
 import { relative } from 'pathe'
 import type { Ref } from 'vue'
+import type { Component } from 'nuxt/schema'
+import type { ComponentRelationship, ComponentWithRelationships, NormalizedHeadTag, SocialPreviewCard, SocialPreviewResolved } from '~/../src/types'
 import type { AsyncDataOptions } from '#app'
-import type { NormalizedHeadTag, SocialPreviewCard, SocialPreviewResolved } from '~/../src/types'
 
 export function isNodeModulePath(path: string) {
   return !!path.match(/[/\\]node_modules[/\\]/) || isPackageName(path)
@@ -141,3 +142,20 @@ export function useSessionState<T>(name: string, initialValue: T) {
     return useSessionStorage(name, initialValue, { listenToStorageChanges: false })
   })
 }
+
+export function getComponentRelationships(component: Component, relationships?: ComponentRelationship[] | null): ComponentWithRelationships {
+  const dependencies = relationships
+    ?.find(i => i.id === component.filePath)
+    ?.deps
+    ?.map(i => relationships?.find(j => j.id === i)?.id)
+    .filter(Boolean) as string[] | undefined
+  const dependents = relationships
+    ?.filter(i => i.deps.includes(component.filePath))
+    .map(i => i.id)
+
+  return {
+    component,
+    dependencies,
+    dependents,
+  }
+}
diff --git a/packages/devtools/client/pages/modules/imports.vue b/packages/devtools/client/pages/modules/imports.vue
index 116fc1d7c..a0afe4786 100644
--- a/packages/devtools/client/pages/modules/imports.vue
+++ b/packages/devtools/client/pages/modules/imports.vue
@@ -9,7 +9,7 @@ definePageMeta({
 })
 
 const config = useServerConfig()
-const onlyUsed = ref(false)
+const filterMode = ref<'all' | 'using' | 'not-used'>('all')
 
 const search = ref('')
 const autoImports = useAutoImports()
@@ -37,10 +37,14 @@ const filtered = computed(() => {
     ? fuse.value.search(search.value).map(i => i.item)
     : functions.value
 
-  if (onlyUsed.value && importsMetadata.value) {
+  if (filterMode.value === 'using' && importsMetadata.value) {
     result = result
       .filter(i => (i.as || i.name) in importsMetadata.value!.injectionUsage)
   }
+  else if (filterMode.value === 'not-used' && importsMetadata.value) {
+    result = result
+      .filter(i => !((i.as || i.name) in importsMetadata.value!.injectionUsage))
+  }
 
   const count = {
     user: 0,
@@ -72,11 +76,18 @@ const filtered = computed(() => {
 
 <template>
   <div v-if="config" relative h-full of-auto>
-    <Navbar v-model:search="search" pb2>
-      <div v-if="importsMetadata">
-        <NSwitch v-model="onlyUsed" n="primary sm">
-          Show used only
-        </NSwitch>
+    <Navbar v-model:search="search" pb3>
+      <div v-if="importsMetadata" flex="~ gap-2 items-center">
+        <NIcon icon="carbon-filter" op50 />
+        <NSelectTabs
+          v-model="filterMode"
+          n="primary sm"
+          :options="[
+            { label: 'All', value: 'all' },
+            { label: 'Using', value: 'using' },
+            { label: 'Not used', value: 'not-used' },
+          ]"
+        />
       </div>
     </Navbar>
     <NSectionBlock