@nuxtjs/prismic 5.2.1 → 5.3.0-canary.365b9b8

package/README.md

@@ -27,18 +27,7 @@ Install the module to your Nuxt application with one command:
 npx nuxi@latest module add prismic
 ```
 
-Then, configure your Prismic API endpoint:
-
-```javascript
-import { defineNuxtConfig } from "nuxt"
-
-export default defineNuxtConfig({
-	modules: ["@nuxtjs/prismic"],
-	prismic: {
-		endpoint: "my-repository",
-	},
-})
-```
+The module automatically loads your repository name and `routes` from `prismic.config.json`, so for most projects all you need to do is register the module (done by the `module add` command). If needed, you can still override those values and configure the Nuxt module further in `nuxt.config.ts` or Nuxt's `runtimeConfig`.
 
 That's it! You can now use Prismic in your Nuxt app ✨
 

package/dist/module.d.mts

@@ -82,9 +82,9 @@ type PrismicModuleOptions = {
      * Controls which auto-imports are added by the module.
      *
      * - `"all"` will add all imports.
-     * - `["vue"]` will add `@nuxtjs/prismic` and `@prismicio/vue` imports.
-     * - `["javascript"]` will add `@prismicio/client` imports.
-     * - `["content"]` will add the `Content` type import.
+     * - `"vue"` will add `@nuxtjs/prismic` and `@prismicio/vue` imports.
+     * - `"javascript"` will add `@prismicio/client` imports.
+     * - `"content"` will add the `Content` type import.
      * - `false` will not add any import.
      *
      * @defaultValue `["vue"]`

package/dist/module.json

@@ -1,12 +1,12 @@
 {
   "name": "@nuxtjs/prismic",
-  "version": "5.2.1",
+  "version": "5.3.0-canary.365b9b8",
   "configKey": "prismic",
   "compatibility": {
     "nuxt": ">=3.7.0"
   },
   "builder": {
-    "@nuxt/module-builder": "1.0.2",
-    "unbuild": "3.6.1"
+    "@nuxt/module-builder": "1.0.3",
+    "unbuild": "unknown"
   }
 }

package/dist/module.mjs

@@ -1,4 +1,4 @@
-import { existsSync } from 'node:fs';
+import { existsSync, readFileSync } from 'node:fs';
 import { readFile } from 'node:fs/promises';
 import { join } from 'node:path';
 import { useLogger, defineNuxtModule, createResolver, addPlugin, addComponent, addImports, extendPages, getNuxtVersion, addTemplate } from '@nuxt/kit';
@@ -7,9 +7,10 @@ import { addDependency } from 'nypm';
 import { readPackage } from 'pkg-types';
 
 const name = "@nuxtjs/prismic";
-const version = "5.2.1";
+const version = "5.3.0-canary.365b9b8";
 
 const logger = useLogger("nuxt:prismic");
+const PRISMIC_CONFIG_FILENAME = "prismic.config.json";
 async function addPrismicClient() {
   try {
     const pkg = await readPackage();
@@ -73,6 +74,7 @@ const module$1 = defineNuxtModule({
       nuxt.options.runtimeConfig.public?.prismic,
       options
     );
+    loadPrismicConfig();
     exposeRuntimeConfig();
     transpileDependencies();
     const ok = proxyUserFiles();
@@ -81,6 +83,34 @@ const module$1 = defineNuxtModule({
     addAutoImports();
     addPreviewRoute();
     extendESLintConfig();
+    function loadPrismicConfig() {
+      const prismicConfigPath = join(
+        nuxt.options.rootDir,
+        PRISMIC_CONFIG_FILENAME
+      );
+      const prismicConfig = readPrismicConfig(prismicConfigPath);
+      const configKeys = [];
+      if (!moduleOptions.endpoint && prismicConfig.repositoryName) {
+        moduleOptions.endpoint = prismicConfig.repositoryName;
+        configKeys.push("repository name");
+      }
+      if (!moduleOptions.clientConfig?.routes && prismicConfig.routes) {
+        moduleOptions.clientConfig.routes = prismicConfig.routes;
+        configKeys.push("routes");
+      }
+      if (configKeys.length > 0) {
+        nuxt.options.watch.push(prismicConfigPath);
+        nuxt.hook("builder:watch", async (_, path) => {
+          if (path.replace(/\\/g, "/") === prismicConfigPath.replace(/\\/g, "/")) {
+            logger.info(`${PRISMIC_CONFIG_FILENAME} updated`);
+            await nuxt.callHook("restart");
+          }
+        });
+        logger.info(
+          `Loaded ${configKeys.join(" and ")} from \`${PRISMIC_CONFIG_FILENAME}\``
+        );
+      }
+    }
     function exposeRuntimeConfig() {
       nuxt.options.runtimeConfig.public ||= {};
       nuxt.options.runtimeConfig.public.prismic = moduleOptions;
@@ -263,7 +293,9 @@ const module$1 = defineNuxtModule({
               const configs = [];
               try {
                 if (existsSync(configPath)) {
-                  const config = JSON.parse(await readFile(configPath, "utf-8"));
+                  const config = JSON.parse(
+                    await readFile(configPath, "utf-8")
+                  );
                   if (config && "libraries" in config && Array.isArray(config.libraries)) {
                     configs.push(
                       JSON.stringify({
@@ -298,5 +330,27 @@ function fileExists(path, extensions = ["js", "ts"]) {
   );
   return extension ? `${path}.${extension}` : null;
 }
+function readPrismicConfig(configPath) {
+  if (!existsSync(configPath)) {
+    return {};
+  }
+  try {
+    const contents = readFileSync(configPath, "utf-8");
+    const rawConfig = JSON.parse(contents);
+    if (!rawConfig || typeof rawConfig !== "object" || Array.isArray(rawConfig)) {
+      return {};
+    }
+    const config = {};
+    if ("repositoryName" in rawConfig && typeof rawConfig.repositoryName === "string") {
+      config.repositoryName = rawConfig.repositoryName;
+    }
+    if ("routes" in rawConfig && Array.isArray(rawConfig.routes)) {
+      config.routes = rawConfig.routes;
+    }
+    return config;
+  } catch {
+    return {};
+  }
+}
 
 export { module$1 as default };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nuxtjs/prismic",
-	"version": "5.2.1",
+	"version": "5.3.0-canary.365b9b8",
 	"description": "Easily connect your Nuxt application to your content hosted on Prismic",
 	"keywords": [
 		"nuxt",
@@ -52,27 +52,26 @@
 		"test": "npm run lint && npm run types && npm run unit && npm run build"
 	},
 	"dependencies": {
-		"@nuxt/kit": "^4.4.2",
-		"@prismicio/vue": "^6.1.3",
+		"@nuxt/kit": "^4.5.2",
+		"@prismicio/vue": "^6.1.4",
 		"defu": "^6.1.7",
-		"nypm": "^0.6.5",
-		"pkg-types": "^2.3.0"
+		"nypm": "^0.6.9",
+		"pkg-types": "^2.3.1"
 	},
 	"devDependencies": {
-		"@nuxt/module-builder": "^1.0.2",
-		"@nuxt/schema": "^4.4.2",
+		"@nuxt/module-builder": "^1.0.3",
+		"@nuxt/schema": "^4.5.2",
 		"@nuxt/test-utils": "^3.23.0",
-		"@prismicio/client": "^7.21.8",
+		"@prismicio/client": "^7.22.0",
 		"@trivago/prettier-plugin-sort-imports": "^6.0.2",
-		"@types/node": "^25.5.2",
-		"@vitest/coverage-v8": "^4.1.3",
-		"nuxt": "^4.4.2",
-		"oxlint": "^1.59.0",
-		"prettier": "^3.8.1",
-		"prettier-plugin-jsdoc": "^1.8.0",
-		"typescript": "^6.0.2",
-		"vitest": "^4.1.3",
-		"vue-tsc": "^3.2.6"
+		"@types/node": "^26.4.0",
+		"@vitest/coverage-v8": "^4.1.11",
+		"nuxt": "^4.5.2",
+		"oxfmt": "^0.65.0",
+		"oxlint": "^1.80.0",
+		"typescript": "^6.0.3",
+		"vitest": "^4.1.11",
+		"vue-tsc": "^3.3.11"
 	},
 	"peerDependencies": {
 		"@prismicio/client": "^7.21.8"
@@ -83,5 +82,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"packageManager": "pnpm@10.28.0"
+	"packageManager": "pnpm@11.24.0"
 }

package/src/module.ts

@@ -1,6 +1,6 @@
-import { existsSync } from "node:fs"
-import { readFile } from "node:fs/promises"
-import { join } from "node:path"
+import { existsSync, readFileSync } from "node:fs";
+import { readFile } from "node:fs/promises";
+import { join } from "node:path";
 
 import {
 	addComponent,
@@ -12,13 +12,13 @@ import {
 	extendPages,
 	getNuxtVersion,
 	useLogger,
-} from "@nuxt/kit"
-import type { ClientConfig } from "@prismicio/client"
-import { defu } from "defu"
-import { addDependency } from "nypm"
-import { readPackage } from "pkg-types"
+} from "@nuxt/kit";
+import type { ClientConfig, Route } from "@prismicio/client";
+import { defu } from "defu";
+import { addDependency } from "nypm";
+import { readPackage } from "pkg-types";
 
-import { name, version } from "../package.json"
+import { name, version } from "../package.json";
 
 /**
  * Prismic Nuxt module options.
@@ -44,7 +44,7 @@ export type PrismicModuleOptions = {
 	 *
 	 * @see {@link https://prismic.io/docs/technical-reference/prismicio-client}
 	 */
-	endpoint?: string
+	endpoint?: string;
 
 	/**
 	 * The Prismic environment in use by Slice Machine configured through
@@ -54,7 +54,7 @@ export type PrismicModuleOptions = {
 	 *
 	 * @internal
 	 */
-	environment?: string
+	environment?: string;
 
 	/**
 	 * Configuration options that determines how content will be queries from the
@@ -62,7 +62,7 @@ export type PrismicModuleOptions = {
 	 *
 	 * @see {@link https://prismic.io/docs/technical-reference/prismicio-client}
 	 */
-	clientConfig?: ClientConfig
+	clientConfig?: ClientConfig;
 
 	/**
 	 * An optional path to a file exporting a Prismic client instance used to
@@ -74,7 +74,7 @@ export type PrismicModuleOptions = {
 	 *
 	 * @see {@link https://prismic.io/docs/technical-reference/prismicio-client}
 	 */
-	client?: string
+	client?: string;
 
 	/**
 	 * The path to a file exporting a default link resolver used to resolve links
@@ -82,7 +82,7 @@ export type PrismicModuleOptions = {
 	 *
 	 * @see {@link https://prismic.io/docs/routes}
 	 */
-	linkResolver?: string
+	linkResolver?: string;
 
 	/**
 	 * Desired path of the preview page used by Prismic to enter preview session.
@@ -92,7 +92,7 @@ export type PrismicModuleOptions = {
 	 *
 	 * @defaultValue `"/preview"`
 	 */
-	preview?: string | false
+	preview?: string | false;
 
 	/**
 	 * Whether to inject Prismic toolbar script.
@@ -102,22 +102,22 @@ export type PrismicModuleOptions = {
 	 *
 	 * @defaultValue `true`
 	 */
-	toolbar?: boolean
+	toolbar?: boolean;
 
 	/**
 	 * Controls which auto-imports are added by the module.
 	 *
 	 * - `"all"` will add all imports.
-	 * - `["vue"]` will add `@nuxtjs/prismic` and `@prismicio/vue` imports.
-	 * - `["javascript"]` will add `@prismicio/client` imports.
-	 * - `["content"]` will add the `Content` type import.
+	 * - `"vue"` will add `@nuxtjs/prismic` and `@prismicio/vue` imports.
+	 * - `"javascript"` will add `@prismicio/client` imports.
+	 * - `"content"` will add the `Content` type import.
 	 * - `false` will not add any import.
 	 *
 	 * @defaultValue `["vue"]`
 	 *
 	 * @experimental
 	 */
-	imports?: false | "all" | ("vue" | "javascript" | "content")[]
+	imports?: false | "all" | ("vue" | "javascript" | "content")[];
 
 	/** Options used by Prismic Vue components. */
 	components?: {
@@ -128,9 +128,9 @@ export type PrismicModuleOptions = {
 		 * @see {@link https://prismic.io/docs/fields/rich-text}
 		 * @see {@link https://prismic.io/docs/fields/table}
 		 */
-		richTextComponents?: string
-	}
-}
+		richTextComponents?: string;
+	};
+};
 
 /**
  * Prismic Nuxt module options.
@@ -138,27 +138,28 @@ export type PrismicModuleOptions = {
  * @see {@link https://prismic.io/docs/nuxt}
  * @see {@link https://prismic.io/docs/technical-reference/nuxtjs-prismic}
  */
-export type ModuleOptions = PrismicModuleOptions
+export type ModuleOptions = PrismicModuleOptions;
 
 declare module "@nuxt/schema" {
 	interface PublicRuntimeConfig {
 		/** The Prismic Nuxt module options. */
-		prismic: PrismicModuleOptions
+		prismic: PrismicModuleOptions;
 	}
 }
 
-const logger = useLogger("nuxt:prismic")
+const logger = useLogger("nuxt:prismic");
+const PRISMIC_CONFIG_FILENAME = "prismic.config.json";
 
 async function addPrismicClient() {
 	try {
-		const pkg = await readPackage()
+		const pkg = await readPackage();
 
 		if (
 			!pkg.dependencies?.["@prismicio/client"] &&
 			!pkg.devDependencies?.["@prismicio/client"]
 		) {
-			await addDependency("@prismicio/client")
-			logger.info("Added `@prismicio/client` required peer dependency")
+			await addDependency("@prismicio/client");
+			logger.info("Added `@prismicio/client` required peer dependency");
 		}
 	} catch {
 		// noop
@@ -173,18 +174,18 @@ export default defineNuxtModule<PrismicModuleOptions>({
 		compatibility: { nuxt: ">=3.7.0" },
 	},
 	onInstall() {
-		return addPrismicClient()
+		return addPrismicClient();
 	},
 	onUpgrade(_options: unknown, _nuxt: unknown, previousVersion: string) {
-		const previousMajor = parseInt(previousVersion.split(".")[0]!)
+		const previousMajor = parseInt(previousVersion.split(".")[0]!);
 		if (previousMajor < 4) {
-			return addPrismicClient()
+			return addPrismicClient();
 		}
 	},
 	defaults: (nuxt): Required<PrismicModuleOptions> => {
 		const nuxt3flavor =
 			getNuxtVersion(nuxt).startsWith("3") &&
-			!nuxt.options?.future?.compatibilityVersion
+			!nuxt.options?.future?.compatibilityVersion;
 
 		if (nuxt3flavor) {
 			return {
@@ -199,7 +200,7 @@ export default defineNuxtModule<PrismicModuleOptions>({
 				components: {
 					richTextComponents: "~/app/prismic/richTextComponents ",
 				},
-			}
+			};
 		}
 
 		return {
@@ -214,29 +215,65 @@ export default defineNuxtModule<PrismicModuleOptions>({
 			components: {
 				richTextComponents: "~/prismic/richTextComponents",
 			},
-		}
+		};
 	},
 	setup(options, nuxt) {
-		const resolver = createResolver(import.meta.url)
+		const resolver = createResolver(import.meta.url);
 
 		const moduleOptions: PrismicModuleOptions = defu(
-			nuxt.options.runtimeConfig.public?.prismic,
+			nuxt.options.runtimeConfig.public?.prismic as PrismicModuleOptions,
 			options,
-		)
+		);
+
+		loadPrismicConfig();
+		exposeRuntimeConfig();
+		transpileDependencies();
+		const ok = proxyUserFiles();
+		if (!ok) return;
+		addRuntimePlugins();
+		addAutoImports();
+		addPreviewRoute();
+		extendESLintConfig();
+
+		function loadPrismicConfig() {
+			const prismicConfigPath = join(
+				nuxt.options.rootDir,
+				PRISMIC_CONFIG_FILENAME,
+			);
+			const prismicConfig = readPrismicConfig(prismicConfigPath);
+
+			const configKeys: string[] = [];
+			if (!moduleOptions.endpoint && prismicConfig.repositoryName) {
+				moduleOptions.endpoint = prismicConfig.repositoryName;
+				configKeys.push("repository name");
+			}
+			if (!moduleOptions.clientConfig?.routes && prismicConfig.routes) {
+				moduleOptions.clientConfig!.routes = prismicConfig.routes;
+				configKeys.push("routes");
+			}
 
-		exposeRuntimeConfig()
-		transpileDependencies()
-		const ok = proxyUserFiles()
-		if (!ok) return
-		addRuntimePlugins()
-		addAutoImports()
-		addPreviewRoute()
-		extendESLintConfig()
+			if (configKeys.length > 0) {
+				nuxt.options.watch.push(prismicConfigPath);
+				nuxt.hook("builder:watch", async (_, path) => {
+					if (
+						path.replace(/\\/g, "/") === prismicConfigPath.replace(/\\/g, "/")
+					) {
+						logger.info(`${PRISMIC_CONFIG_FILENAME} updated`);
+						await nuxt.callHook("restart");
+					}
+				});
+
+				logger.info(
+					`Loaded ${configKeys.join(" and ")} from \`${PRISMIC_CONFIG_FILENAME}\``,
+				);
+			}
+		}
 
 		function exposeRuntimeConfig() {
 			nuxt.options.runtimeConfig.public ||=
-				{} as typeof nuxt.options.runtimeConfig.public
-			nuxt.options.runtimeConfig.public.prismic = moduleOptions
+				{} as typeof nuxt.options.runtimeConfig.public;
+			(nuxt.options.runtimeConfig.public.prismic as PrismicModuleOptions) =
+				moduleOptions;
 		}
 
 		function transpileDependencies() {
@@ -244,10 +281,10 @@ export default defineNuxtModule<PrismicModuleOptions>({
 				resolver.resolve("runtime"),
 				"@nuxtjs/prismic",
 				"@prismicio/vue",
-			)
-			nuxt.options.vite.optimizeDeps ||= {}
-			nuxt.options.vite.optimizeDeps.exclude ||= []
-			nuxt.options.vite.optimizeDeps.exclude.push("@prismicio/vue")
+			);
+			nuxt.options.vite.optimizeDeps ||= {};
+			nuxt.options.vite.optimizeDeps.exclude ||= [];
+			nuxt.options.vite.optimizeDeps.exclude.push("@prismicio/vue");
 		}
 
 		function proxyUserFiles() {
@@ -255,44 +292,44 @@ export default defineNuxtModule<PrismicModuleOptions>({
 				filename: string,
 				path: string,
 			): boolean => {
-				const resolvedFilename = `prismic/proxy/${filename}.ts`
+				const resolvedFilename = `prismic/proxy/${filename}.ts`;
 				const resolvedPath = path
 					.replace(/^(~~|@@)/, nuxt.options.rootDir)
-					.replace(/^(~|@)/, nuxt.options.srcDir)
+					.replace(/^(~|@)/, nuxt.options.srcDir);
 				const maybeUserFile = fileExists(resolvedPath, [
 					"js",
 					"mjs",
 					"ts",
 					"vue",
-				])
+				]);
 
 				if (maybeUserFile) {
 					// If user file exists, proxy it with vfs
 					logger.info(
 						`Using user-defined \`${filename}\` at \`${maybeUserFile.replace(nuxt.options.srcDir, "~").replace(nuxt.options.rootDir, "~~").replace(/\\/g, "/")}\``,
-					)
+					);
 
 					addTemplate({
 						filename: resolvedFilename,
 						getContents: () => `export { default } from '${path}'`,
-					})
+					});
 
-					return true
+					return true;
 				} else {
 					// Else provide `undefined` fallback
 					addTemplate({
 						filename: resolvedFilename,
 						getContents: () => "export default undefined",
-					})
+					});
 
-					return false
+					return false;
 				}
-			}
+			};
 
 			const proxiedUserClient = proxyUserFileWithUndefinedFallback(
 				"client",
 				moduleOptions.client!,
-			)
+			);
 			if (
 				!moduleOptions.endpoint &&
 				!proxiedUserClient &&
@@ -300,34 +337,34 @@ export default defineNuxtModule<PrismicModuleOptions>({
 			) {
 				logger.warn(
 					`\`endpoint\` option is missing and \`${moduleOptions.client}\` was not found. At least one of them is required for the module to run. Disabling module...`,
-				)
-				return false
+				);
+				return false;
 			}
 			proxyUserFileWithUndefinedFallback(
 				"linkResolver",
 				moduleOptions.linkResolver!,
-			)
+			);
 			proxyUserFileWithUndefinedFallback(
 				"richTextComponents",
 				moduleOptions.components!.richTextComponents!,
-			)
+			);
 
-			return true
+			return true;
 		}
 
 		function addRuntimePlugins() {
-			addPlugin(resolver.resolve("runtime/plugin"))
-			addPlugin(resolver.resolve("runtime/plugin.client"))
+			addPlugin(resolver.resolve("runtime/plugin"));
+			addPlugin(resolver.resolve("runtime/plugin.client"));
 		}
 
 		function addAutoImports() {
-			if (!moduleOptions.imports) return
+			if (!moduleOptions.imports) return;
 
 			if (
 				moduleOptions.imports === "all" ||
 				moduleOptions.imports.includes("vue")
 			) {
-				;[
+				[
 					"PrismicImage",
 					"PrismicLink",
 					"PrismicText",
@@ -340,8 +377,8 @@ export default defineNuxtModule<PrismicModuleOptions>({
 						name: entry,
 						export: entry,
 						filePath: "@prismicio/vue",
-					})
-				})
+					});
+				});
 
 				addImports(
 					[
@@ -355,12 +392,12 @@ export default defineNuxtModule<PrismicModuleOptions>({
 						as: entry,
 						from: "@prismicio/vue",
 					})),
-				)
+				);
 				addImports({
 					name: "usePrismicPreview",
 					as: "usePrismicPreview",
 					from: resolver.resolve("runtime/usePrismicPreview"),
-				})
+				});
 			}
 
 			if (
@@ -383,7 +420,7 @@ export default defineNuxtModule<PrismicModuleOptions>({
 						as: entry,
 						from: "@prismicio/client",
 					})),
-				)
+				);
 			}
 
 			if (
@@ -395,7 +432,7 @@ export default defineNuxtModule<PrismicModuleOptions>({
 					from: "@prismicio/client",
 					typeFrom: "@prismicio/client",
 					type: true,
-				})
+				});
 			}
 		}
 
@@ -408,7 +445,7 @@ export default defineNuxtModule<PrismicModuleOptions>({
 						moduleOptions.preview,
 					),
 					["js", "ts", "vue"],
-				)
+				);
 
 				if (maybeUserPreviewPage) {
 					logger.info(
@@ -419,25 +456,25 @@ export default defineNuxtModule<PrismicModuleOptions>({
 								/\\/g,
 								"/",
 							)}\`, available at \`${moduleOptions.preview}\``,
-					)
+					);
 				} else {
 					logger.info(
 						`Using default preview page, available at \`${moduleOptions.preview}\``,
-					)
+					);
 
 					extendPages((pages) => {
 						pages.unshift({
 							name: "prismic-preview",
 							path: moduleOptions.preview as string, // Checked before
 							file: resolver.resolve("runtime/PrismicPreview.vue"),
-						})
-					})
+						});
+					});
 				}
 
 				if (!moduleOptions.toolbar) {
 					logger.warn(
 						"`toolbar` option is disabled but `preview` is enabled. Previews won't work unless you manually load the toolbar.",
-					)
+					);
 				}
 			}
 		}
@@ -448,8 +485,8 @@ export default defineNuxtModule<PrismicModuleOptions>({
 				"eslint:config:addons",
 				(
 					addons: {
-						name: string
-						getConfigs: () => Promise<{ configs: string[] }>
+						name: string;
+						getConfigs: () => Promise<{ configs: string[] }>;
 					}[],
 				) => {
 					addons.push({
@@ -458,13 +495,15 @@ export default defineNuxtModule<PrismicModuleOptions>({
 							const configPath = resolver.resolve(
 								nuxt.options.rootDir,
 								"slicemachine.config.json",
-							)
+							);
 
-							const configs: string[] = []
+							const configs: string[] = [];
 
 							try {
 								if (existsSync(configPath)) {
-									const config = JSON.parse(await readFile(configPath, "utf-8"))
+									const config = JSON.parse(
+										await readFile(configPath, "utf-8"),
+									);
 
 									if (
 										config &&
@@ -481,32 +520,72 @@ export default defineNuxtModule<PrismicModuleOptions>({
 													"vue/multi-word-component-names": "off",
 												},
 											}),
-										)
+										);
 									}
 								}
 							} catch {
 								// noop
 							}
 
-							return { configs }
+							return { configs };
 						},
-					})
+					});
 				},
-			)
+			);
 		}
 	},
-})
+});
 
 function fileExists(path?: string, extensions = ["js", "ts"]): string | null {
 	if (!path) {
-		return null
+		return null;
 	} else if (existsSync(path)) {
-		return path
+		return path;
 	}
 
 	const extension = extensions.find((extension) =>
 		existsSync(`${path}.${extension}`),
-	)
+	);
+
+	return extension ? `${path}.${extension}` : null;
+}
+
+type PrismicConfig = {
+	repositoryName?: string;
+	routes?: Route[];
+};
+
+function readPrismicConfig(configPath: string): PrismicConfig {
+	if (!existsSync(configPath)) {
+		return {};
+	}
 
-	return extension ? `${path}.${extension}` : null
+	try {
+		const contents = readFileSync(configPath, "utf-8");
+		const rawConfig = JSON.parse(contents) as unknown;
+
+		if (
+			!rawConfig ||
+			typeof rawConfig !== "object" ||
+			Array.isArray(rawConfig)
+		) {
+			return {};
+		}
+
+		const config: PrismicConfig = {};
+		if (
+			"repositoryName" in rawConfig &&
+			typeof rawConfig.repositoryName === "string"
+		) {
+			config.repositoryName = rawConfig.repositoryName;
+		}
+
+		if ("routes" in rawConfig && Array.isArray(rawConfig.routes)) {
+			config.routes = rawConfig.routes;
+		}
+
+		return config;
+	} catch {
+		return {};
+	}
 }

package/src/runtime/PrismicPreview.vue

@@ -1,8 +1,8 @@
 <script setup>
-import { usePrismicPreview, useSeoMeta } from "#imports"
+import { usePrismicPreview, useSeoMeta } from "#imports";
 
-useSeoMeta({ title: "Prismic Preview - Loading" })
-usePrismicPreview()
+useSeoMeta({ title: "Prismic Preview - Loading" });
+usePrismicPreview();
 </script>
 
 <template>

package/src/runtime/plugin.client.ts

@@ -1,5 +1,5 @@
-import { defineNuxtPlugin } from "#app"
-import { refreshNuxtData, useRuntimeConfig } from "#imports"
+import { defineNuxtPlugin } from "#app";
+import { refreshNuxtData, useRuntimeConfig } from "#imports";
 
 export default defineNuxtPlugin({
 	name: "prismic:plugin:client",
@@ -7,9 +7,9 @@ export default defineNuxtPlugin({
 	setup() {
 		if (useRuntimeConfig().public.prismic?.preview) {
 			window.addEventListener("prismicPreviewUpdate", (event) => {
-				event.preventDefault()
-				refreshNuxtData()
-			})
+				event.preventDefault();
+				refreshNuxtData();
+			});
 		}
 	},
-})
+});

package/src/runtime/plugin.ts

@@ -1,10 +1,10 @@
-import { defineNuxtPlugin } from "#app"
-import NuxtLink from "#app/components/nuxt-link"
-import _client from "#build/prismic/proxy/client"
+import { defineNuxtPlugin } from "#app";
+import NuxtLink from "#app/components/nuxt-link";
+import _client from "#build/prismic/proxy/client";
 // @ts-expect-error - Proxy file
-import linkResolver from "#build/prismic/proxy/linkResolver"
+import linkResolver from "#build/prismic/proxy/linkResolver";
 // @ts-expect-error - Proxy file
-import richTextComponents from "#build/prismic/proxy/richTextComponents"
+import richTextComponents from "#build/prismic/proxy/richTextComponents";
 import {
 	onNuxtReady,
 	refreshNuxtData,
@@ -13,57 +13,57 @@ import {
 	useRequestEvent,
 	useRouter,
 	useRuntimeConfig,
-} from "#imports"
-import { Client, cookie, createClient, getToolbarSrc } from "@prismicio/client"
-import { createPrismic } from "@prismicio/vue"
+} from "#imports";
+import { Client, cookie, createClient, getToolbarSrc } from "@prismicio/client";
+import { createPrismic } from "@prismicio/vue";
 
 export default defineNuxtPlugin({
 	name: "prismic:setup",
 	parallel: true,
 	async setup(nuxtApp) {
-		const options = useRuntimeConfig().public.prismic
+		const options = useRuntimeConfig().public.prismic;
 
-		const client = await resolveClient()
-		handlePreview()
-		addToolbar()
+		const client = await resolveClient();
+		handlePreview();
+		addToolbar();
 
 		async function resolveClient() {
 			if ((_client as unknown) instanceof Client) {
-				return _client!
+				return _client!;
 			} else if (typeof _client === "function") {
 				try {
 					return await nuxtApp.runWithContext(() =>
 						(_client as unknown as () => Client)(),
-					)
+					);
 				} catch (error) {
 					console.error(
 						"[@nuxtjs/prismic] An error happened while resolving your Prismic custom client, disabling Prismic module gracefully...",
 						error,
-					)
+					);
 
 					// The Vue plugin still requires a client to work, we're providing an obviously broken one.
 					return createClient(
 						"error-resolving-custom-client",
 						options.clientConfig,
-					)
+					);
 				}
 			} else {
 				return createClient(
 					options.environment || options.endpoint || "endpoint-not-provided",
 					options.clientConfig,
-				)
+				);
 			}
 		}
 
 		function handlePreview() {
 			if (options.preview) {
-				const previewCookie = useCookie("io.prismic.preview").value
+				const previewCookie = useCookie("io.prismic.preview").value;
 
 				// Update client with req when running server side
 				if (import.meta.server) {
-					const req = useRequestEvent()?.node.req
+					const req = useRequestEvent()?.node.req;
 					if (req) {
-						client.enableAutoPreviewsFromReq(req)
+						client.enableAutoPreviewsFromReq(req);
 					}
 				}
 
@@ -72,7 +72,7 @@ export default defineNuxtPlugin({
 						const session =
 							typeof previewCookie === "string"
 								? JSON.parse(decodeURIComponent(previewCookie))
-								: previewCookie
+								: previewCookie;
 
 						if (
 							Object.keys(session).some(
@@ -84,19 +84,19 @@ export default defineNuxtPlugin({
 									session[key].preview,
 							)
 						) {
-							let afterEachCalled = false
+							let afterEachCalled = false;
 							onNuxtReady(() => {
 								if (!afterEachCalled) {
-									refreshNuxtData()
+									refreshNuxtData();
 								}
-							})
+							});
 							useRouter().afterEach(() => {
-								afterEachCalled = true
-								refreshNuxtData()
-							})
+								afterEachCalled = true;
+								refreshNuxtData();
+							});
 						}
 					} catch (error) {
-						console.warn("Failed to parse Prismic preview cookie", error)
+						console.warn("Failed to parse Prismic preview cookie", error);
 					}
 				}
 			}
@@ -115,10 +115,10 @@ export default defineNuxtPlugin({
 							crossorigin: "anonymous",
 						},
 					],
-				})
+				});
 			} else {
 				// TODO: We might want to let user disable this behavior because it might have unexpected side effects
-				useCookie(cookie.preview).value = null
+				useCookie(cookie.preview).value = null;
 			}
 		}
 
@@ -130,11 +130,11 @@ export default defineNuxtPlugin({
 				linkExternalComponent: NuxtLink,
 				richTextComponents,
 			},
-		})
+		});
 
-		nuxtApp.vueApp.use(prismicPlugin)
+		nuxtApp.vueApp.use(prismicPlugin);
 		return {
 			provide: { prismic: prismicPlugin },
-		}
+		};
 	},
-})
+});

package/src/runtime/usePrismicPreview.ts

@@ -1,17 +1,17 @@
 // @ts-expect-error - Proxy file
-import { usePrismic, useRouter } from "#imports"
-import { onMounted } from "vue"
+import { usePrismic, useRouter } from "#imports";
+import { onMounted } from "vue";
 
 /** Resolves Prismic previews on the preview entry page (`/preview`) */
 export const usePrismicPreview = (defaultURL = "/"): void => {
-	const { client, linkResolver } = usePrismic()
-	const { push } = useRouter()
+	const { client, linkResolver } = usePrismic();
+	const { push } = useRouter();
 	onMounted(async () => {
 		const redirectURL = await client.resolvePreviewURL({
 			linkResolver,
 			defaultURL,
-		})
+		});
 
-		push(redirectURL)
-	})
-}
+		push(redirectURL);
+	});
+};