feat: inject the active environment via prismic/env/register

Add the `prismic/env/register` export, which sets the framework's public
environment variable from the active environment at config-load time, and
wire `gen setup` to import it in the framework config for Next.js, Nuxt,
and SvelteKit.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Author: angeloashmore

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "prismic",
-	"version": "1.12.2",
+	"version": "1.12.0",
 	"description": "Prismic's official command line tool",
 	"keywords": [
 		"prismic",
@@ -19,6 +19,10 @@
 		"./dist"
 	],
 	"type": "module",
+	"exports": {
+		"./env/register": "./dist/env/register.mjs",
+		"./package.json": "./package.json"
+	},
 	"publishConfig": {
 		"access": "public"
 	},

src/adapters/index.ts

@@ -1,12 +1,12 @@
 import type { CustomType, SharedSlice } from "@prismicio/types-internal/lib/customtypes";
 
 import { pascalCase } from "change-case";
-import { rm } from "node:fs/promises";
+import { readFile, rm, writeFile } from "node:fs/promises";
 import { pathToFileURL } from "node:url";
 import { generateTypes } from "prismic-ts-codegen";
 import { glob } from "tinyglobby";
 
-import { readJsonFile, writeFileRecursive } from "../lib/file";
+import { findFirstFile, readJsonFile, writeFileRecursive } from "../lib/file";
 import { stringify } from "../lib/json";
 import { readPackageJson } from "../lib/packageJson";
 import { appendTrailingSlash } from "../lib/url";
@@ -206,3 +206,25 @@ export abstract class Adapter {
 		return output;
 	}
 }
+
+export async function addEnvRegisterImport(configFilenames: string[]): Promise<void> {
+	const projectRoot = await findProjectRoot();
+	const configUrl = await findFirstFile(
+		configFilenames.map((filename) => new URL(filename, projectRoot)),
+	);
+	if (!configUrl) return;
+
+	// The register module uses top-level await, so it can only be
+	// imported from an ESM config file.
+	let isEsm = configUrl.pathname.endsWith(".mjs") || configUrl.pathname.endsWith(".ts");
+	if (!isEsm) {
+		const packageJson = await readPackageJson();
+		isEsm = packageJson.type === "module";
+	}
+	if (!isEsm) return;
+
+	const statement = 'import "prismic/env/register";';
+	const contents = await readFile(configUrl, "utf8");
+	if (contents.includes(statement)) return;
+	await writeFile(configUrl, `${statement}\n\n${contents}`);
+}

src/adapters/nextjs.ts

@@ -5,7 +5,7 @@ import { createRequire } from "node:module";
 import { relative } from "node:path";
 import { fileURLToPath } from "node:url";
 
-import { Adapter } from ".";
+import { Adapter, addEnvRegisterImport } from ".";
 import { getHost, getToken } from "../auth";
 import { addPreview, getPreviews, getSimulatorUrl, setSimulatorUrl } from "../clients/core";
 import { exists, writeFileRecursive } from "../lib/file";
@@ -38,6 +38,7 @@ export class NextJsAdapter extends Adapter {
 		await createPreviewRoute();
 		await createExitPreviewRoute();
 		await createRevalidateRoute();
+		await addEnvRegisterImport(["next.config.mjs", "next.config.ts", "next.config.js"]);
 	}
 
 	async onProjectInitialized(): Promise<void> {

src/adapters/nuxt.ts

@@ -6,7 +6,7 @@ import { readFile, rm } from "node:fs/promises";
 import { relative } from "node:path";
 import { fileURLToPath } from "node:url";
 
-import { Adapter } from ".";
+import { Adapter, addEnvRegisterImport } from ".";
 import { getHost, getToken } from "../auth";
 import { addPreview, getPreviews, getSimulatorUrl, setSimulatorUrl } from "../clients/core";
 import { exists, writeFileRecursive } from "../lib/file";
@@ -31,6 +31,7 @@ export class NuxtAdapter extends Adapter {
 		await createSliceSimulatorPage();
 		await moveOrDeleteAppVue();
 		await modifySliceLibraryPath(this);
+		await addEnvRegisterImport(["nuxt.config.ts", "nuxt.config.js"]);
 	}
 
 	async onProjectInitialized(): Promise<void> {

src/adapters/sveltekit.ts

@@ -7,7 +7,7 @@ import { createRequire } from "node:module";
 import { relative } from "node:path";
 import { fileURLToPath } from "node:url";
 
-import { Adapter } from ".";
+import { Adapter, addEnvRegisterImport } from ".";
 import { getHost, getToken } from "../auth";
 import { addPreview, getPreviews, getSimulatorUrl, setSimulatorUrl } from "../clients/core";
 import { exists, writeFileRecursive } from "../lib/file";
@@ -42,6 +42,7 @@ export class SvelteKitAdapter extends Adapter {
 		await createRootLayoutServerFile();
 		await createRootLayoutFile();
 		await modifyViteConfig();
+		await addEnvRegisterImport(["vite.config.ts", "vite.config.js"]);
 	}
 
 	async onProjectInitialized(): Promise<void> {

src/exports/env/register.ts

@@ -0,0 +1,8 @@
+import { getEnvironment } from "../../environments";
+
+const environment = await getEnvironment();
+if (environment) {
+	process.env.NEXT_PUBLIC_PRISMIC_ENVIRONMENT ??= environment;
+	process.env.PUBLIC_PRISMIC_ENVIRONMENT ??= environment;
+	process.env.NUXT_PUBLIC_PRISMIC_ENVIRONMENT ??= environment;
+}

src/lib/file.ts

@@ -49,6 +49,12 @@ export async function exists(path: URL): Promise<boolean> {
 	}
 }
 
+export async function findFirstFile(candidates: URL[]): Promise<URL | undefined> {
+	for (const candidate of candidates) {
+		if (await exists(candidate)) return candidate;
+	}
+}
+
 export async function writeFileRecursive(
 	path: URL,
 	data: Parameters<typeof writeFile>[1],

src/lib/packageJson.ts

@@ -12,6 +12,7 @@ const PackageJsonSchema = z.object({
 	devDependencies: z.optional(z.record(z.string(), z.string())),
 	peerDependencies: z.optional(z.record(z.string(), z.string())),
 	packageManager: z.optional(z.string()),
+	type: z.optional(z.string()),
 });
 type PackageJson = z.infer<typeof PackageJsonSchema>;
 

test/env-register.serial.test.ts

@@ -0,0 +1,34 @@
+import { mkdir, writeFile } from "node:fs/promises";
+import { fileURLToPath } from "node:url";
+import { vi } from "vitest";
+
+import { it } from "./it";
+
+const REGISTER = fileURLToPath(new URL("../dist/env/register.mjs", import.meta.url));
+
+const ENV_VARS = [
+	"NEXT_PUBLIC_PRISMIC_ENVIRONMENT",
+	"PUBLIC_PRISMIC_ENVIRONMENT",
+	"NUXT_PUBLIC_PRISMIC_ENVIRONMENT",
+] as const;
+
+it("does not set env vars when no environment is configured", async ({ expect, home, project }) => {
+	process.chdir(fileURLToPath(project));
+	vi.stubEnv("PRISMIC_CONFIG_DIR", fileURLToPath(new URL(".config/prismic/", home)));
+	vi.resetModules();
+	await import(REGISTER);
+	for (const key of ENV_VARS) expect(process.env[key]).toBeUndefined();
+});
+
+it("sets env vars when an environment is configured", async ({ expect, home, project }) => {
+	process.chdir(fileURLToPath(project));
+	vi.stubEnv("PRISMIC_CONFIG_DIR", fileURLToPath(new URL(".config/prismic/", home)));
+	await mkdir(new URL(".config/prismic/", home), { recursive: true });
+	await writeFile(
+		new URL(".config/prismic/environments.json", home),
+		JSON.stringify({ [project.toString()]: "my-stage-env" }),
+	);
+	vi.resetModules();
+	await import(REGISTER);
+	for (const key of ENV_VARS) expect(process.env[key]).toBe("my-stage-env");
+});

test/gen-setup.test.ts

@@ -1,4 +1,4 @@
-import { mkdir, writeFile } from "node:fs/promises";
+import { mkdir, readFile, writeFile } from "node:fs/promises";
 
 import { it } from "./it";
 
@@ -61,6 +61,37 @@ it("generates valid script tags for SvelteKit", { timeout: 30_000 }, async ({
 	});
 });
 
+it("adds the env register import to the framework config", { timeout: 30_000 }, async ({
+	expect,
+	project,
+	prismic,
+}) => {
+	const configPath = new URL("next.config.mjs", project);
+	await writeFile(configPath, "export default {};\n");
+
+	const { exitCode } = await prismic("gen", ["setup", "--no-install"]);
+	expect(exitCode).toBe(0);
+
+	const contents = await readFile(configPath, "utf8");
+	expect(contents).toBe('import "prismic/env/register";\n\nexport default {};\n');
+});
+
+it("skips the env register import for a CommonJS config", { timeout: 30_000 }, async ({
+	expect,
+	project,
+	prismic,
+}) => {
+	// The fixture's package.json has no "type": "module", so a .js config is CommonJS.
+	const configPath = new URL("next.config.js", project);
+	await writeFile(configPath, "module.exports = {};\n");
+
+	const { exitCode } = await prismic("gen", ["setup", "--no-install"]);
+	expect(exitCode).toBe(0);
+
+	const contents = await readFile(configPath, "utf8");
+	expect(contents).toBe("module.exports = {};\n");
+});
+
 it("skips installation with --no-install", async ({ expect, project, prismic }) => {
 	const { exitCode, stdout } = await prismic("gen", ["setup", "--no-install"]);
 	expect(exitCode).toBe(0);