feat: add flag for global components (#27)

Author: farnabaz

playground/components/global/TestGlobalComponent.vue

@@ -0,0 +1,3 @@
+<template>
+  <div>I am global</div>
+</template>

playground/nuxt.config.ts

@@ -2,6 +2,15 @@ import { defineNuxtConfig } from 'nuxt'
 import nuxtMetaModule from '../src/module'
 
 export default defineNuxtConfig({
+  components: {
+    dirs: [
+      {
+        path: '~/components/global',
+        global: true
+      },
+      '~/components'
+    ]
+  },
   modules: [
     nuxtMetaModule
   ]

src/module.ts

@@ -20,7 +20,13 @@ export default defineNuxtModule<ModuleOptions>({
           const path = resolveModule((component as any).filePath, { paths: nuxt.options.rootDir })
           const source = await readFile(path, { encoding: 'utf-8' })
 
-          return parseComponent(name, source)
+          const { props, slots } = parseComponent(name, source)
+          return {
+            name,
+            global: Boolean(component.global),
+            props,
+            slots
+          }
         })
       )
     })

test/fixtures/basic/components/global/TestGlobalComponent.vue

@@ -0,0 +1,3 @@
+<template>
+  <div>I am global</div>
+</template>

test/fixtures/basic/nuxt.config.ts

@@ -2,6 +2,15 @@ import { defineNuxtConfig } from 'nuxt'
 import nuxtMetaModule from '../../..'
 
 export default defineNuxtConfig({
+  components: {
+    dirs: [
+      {
+        path: '~/components/global',
+        global: true
+      },
+      '~/components'
+    ]
+  },
   modules: [
     nuxtMetaModule
   ]

test/module.test.ts

@@ -39,4 +39,18 @@ describe('fixtures:basic', async () => {
       name: 'hello'
     }])
   })
+
+  test('Global component', async () => {
+    const component = await $fetch('/api/component-meta/TestGlobalComponent')
+
+    expect(component).ownProperty('name')
+    expect(component).ownProperty('props')
+    expect(Array.isArray(component.props)).toBeTruthy()
+    expect(component).ownProperty('slots')
+    expect(Array.isArray(component.slots)).toBeTruthy()
+
+    expect(component).toMatchObject({
+      global: true
+    })
+  })
 })