fix: auto imports for linkRel, richTextComponents, and `sliceZone…

…DefaultComponent` in nuxt 4
nuxt-modules · Jan 13, 2025 · bbec245 · bbec245
1 parent 5b754e4
commit bbec245
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 21 deletions.
diff --git a/src/module.ts b/src/module.ts
@@ -49,6 +49,12 @@ export default defineNuxtModule<PrismicModuleOptions>({
 			richTextSerializer: '~/app/prismic/richTextSerializer',
 		}
 
+		let prismicComponentsFiles = {
+			linkRel: '~/app/prismic/linkRel',
+			richTextComponents: '~/app/prismic/richTextComponents',
+			sliceZoneDefaultComponent: '~/app/prismic/sliceZoneDefaultComponent',
+		}
+
 		// Nuxt 4 sets `app` as its `srcDir`, so we're just using the `prismic` folder there.
 		if (
 			nuxt.options?.future?.compatibilityVersion === 4
@@ -59,6 +65,11 @@ export default defineNuxtModule<PrismicModuleOptions>({
 				linkResolver: '~/prismic/linkResolver',
 				richTextSerializer: '~/prismic/richTextSerializer',
 			}
+			prismicComponentsFiles = {
+				linkRel: '~/prismic/linkRel',
+				richTextComponents: '~/prismic/richTextComponents',
+				sliceZoneDefaultComponent: '~/prismic/sliceZoneDefaultComponent',
+			}
 		}
 
 		return {
@@ -67,11 +78,7 @@ export default defineNuxtModule<PrismicModuleOptions>({
 			clientConfig: {},
 			...prismicFiles,
 			injectComponents: true,
-			components: {
-				linkRel: '~/prismic/linkRel',
-				richTextComponents: '~/prismic/richTextComponents',
-				sliceZoneDefaultComponent: '~/prismic/sliceZoneDefaultComponent',
-			},
+			components: prismicComponentsFiles,
 			preview: '/preview',
 			toolbar: true,
 			devtools: true,

diff --git a/src/types.ts b/src/types.ts
@@ -9,7 +9,7 @@ import type { PrismicPluginOptions, SliceComponentProps, TODOSliceComponent } fr
  */
 export type PrismicModuleOptions = Omit<
 	PrismicPluginOptions,
-	'endpoint' | 'client' | 'linkResolver' | 'htmlSerializer' | 'richTextSerializer' | 'components'
+	'endpoint' | 'client' | 'linkResolver' | 'richTextSerializer' | 'components'
 > & {
 	/**
 	 * A Prismic repository endpoint to init the module's `@prismicio/client`

diff --git a/test/module-options.test.ts b/test/module-options.test.ts
@@ -39,9 +39,9 @@ it('exposes options in runtime config', () => {
 		  "client": "~/app/prismic/client",
 		  "clientConfig": {},
 		  "components": {
-		    "linkRel": "~/prismic/linkRel",
-		    "richTextComponents": "~/prismic/richTextComponents",
-		    "sliceZoneDefaultComponent": "~/prismic/sliceZoneDefaultComponent",
+		    "linkRel": "~/app/prismic/linkRel",
+		    "richTextComponents": "~/app/prismic/richTextComponents",
+		    "sliceZoneDefaultComponent": "~/app/prismic/sliceZoneDefaultComponent",
 		  },
 		  "devtools": true,
 		  "endpoint": "qwerty",

diff --git a/test/module-userFileProxy.test.ts b/test/module-userFileProxy.test.ts
@@ -87,15 +87,15 @@ it('proxies user files from default location', () => {
 		  ],
 		  [
 		    "prismic/proxy/linkRel.ts",
-		    "export default undefined",
+		    "export { default } from '~/app/prismic/linkRel'",
 		  ],
 		  [
 		    "prismic/proxy/richTextComponents.ts",
-		    "export default undefined",
+		    "export { default } from '~/app/prismic/richTextComponents'",
 		  ],
 		  [
 		    "prismic/proxy/sliceZoneDefaultComponent.ts",
-		    "export default undefined",
+		    "export { default } from '~/app/prismic/sliceZoneDefaultComponent'",
 		  ],
 		]
 	`)
@@ -131,15 +131,15 @@ it('proxies user files from default location (Nuxt 4)', () => {
 		  ],
 		  [
 		    "prismic/proxy/linkRel.ts",
-		    "export default undefined",
+		    "export { default } from '~/app/prismic/linkRel'",
 		  ],
 		  [
 		    "prismic/proxy/richTextComponents.ts",
-		    "export default undefined",
+		    "export { default } from '~/app/prismic/richTextComponents'",
 		  ],
 		  [
 		    "prismic/proxy/sliceZoneDefaultComponent.ts",
-		    "export default undefined",
+		    "export { default } from '~/app/prismic/sliceZoneDefaultComponent'",
 		  ],
 		]
 	`)
@@ -150,9 +150,9 @@ it('proxies user files from provided location', () => {
 		'/tmp/nuxt/custom/client.ts': '',
 		'/tmp/nuxt/custom/linkResolver.ts': '',
 		'/tmp/nuxt/custom/richTextSerializer.ts': '',
-		'/tmp/nuxt/custom/prismic/linkRel.ts': '',
-		'/tmp/nuxt/custom/prismic/richTextComponents.ts': '',
-		'/tmp/nuxt/custom/prismic/sliceZoneDefaultComponent.vue': '',
+		'/tmp/nuxt/custom/linkRel.ts': '',
+		'/tmp/nuxt/custom/richTextComponents.ts': '',
+		'/tmp/nuxt/custom/sliceZoneDefaultComponent.vue': '',
 	})
 
 	mockedPrismicModule({
@@ -185,15 +185,15 @@ it('proxies user files from provided location', () => {
 		  ],
 		  [
 		    "prismic/proxy/linkRel.ts",
-		    "export default undefined",
+		    "export { default } from '~/custom/linkRel'",
 		  ],
 		  [
 		    "prismic/proxy/richTextComponents.ts",
-		    "export default undefined",
+		    "export { default } from '~/custom/richTextComponents'",
 		  ],
 		  [
 		    "prismic/proxy/sliceZoneDefaultComponent.ts",
-		    "export default undefined",
+		    "export { default } from '~/custom/sliceZoneDefaultComponent'",
 		  ],
 		]
 	`)