fix: add slicemachine.config.json to vite.config.js

Author: angeloashmore

packages/adapter-sveltekit/package.json

@@ -69,6 +69,7 @@
 		"fp-ts": "^2.13.1",
 		"io-ts": "^2.2.20",
 		"io-ts-types": "^0.5.19",
+		"magicast": "0.3.5",
 		"monocle-ts": "^2.3.13",
 		"newtype-ts": "^0.3.5",
 		"pascal-case": "^3.1.2"

packages/adapter-sveltekit/src/hooks/project-init.ts

@@ -9,6 +9,7 @@ import {
 	writeProjectFile,
 } from "@slicemachine/plugin-kit/fs";
 import { source } from "common-tags";
+import { loadFile } from "magicast";
 
 import { checkIsTypeScriptProject } from "../lib/checkIsTypeScriptProject";
 import { getJSFileExtension } from "../lib/getJSFileExtension";
@@ -289,6 +290,46 @@ const upsertSliceLibraryIndexFiles = async (
 	);
 };
 
+const modifyViteConfig = async ({
+	helpers,
+	options,
+}: SliceMachineContext<PluginOptions>) => {
+	let filename = "vite.config.js";
+	if (!(await checkHasProjectFile({ filename, helpers }))) {
+		filename = "vite.config.ts";
+	}
+	if (!(await checkHasProjectFile({ filename, helpers }))) {
+		// Couldn't find the config file.
+		return;
+	}
+	const filepath = helpers.joinPathFromRoot(filename);
+
+	const mod = await loadFile(filepath);
+	if (mod.exports.default.$type !== "function-call") {
+		// Invalid config file.
+		return;
+	}
+
+	// Add `./slicemachine.config.json` to allowed files.
+	const config = mod.exports.default.$args[0];
+	config.server ??= {};
+	config.server.fs ??= {};
+	config.server.fs.allow ??= [];
+	if (!config.server.fs.allow.includes("./slicemachine.config.json")) {
+		config.server.fs.allow.push("./slicemachine.config.json");
+	}
+
+	// Remove an empty line above the `server` property.
+	const contents = mod.generate().code.replace(/\n\s*\n(?=\s*server:)/, "\n");
+
+	await writeProjectFile({
+		filename,
+		contents,
+		format: options.format,
+		helpers,
+	});
+};
+
 export const projectInit: ProjectInitHook<PluginOptions> = async (
 	{ installDependencies: _installDependencies },
 	context,
@@ -304,6 +345,7 @@ export const projectInit: ProjectInitHook<PluginOptions> = async (
 			createPreviewRouteMatcherFile(context),
 			createRootLayoutServerFile(context),
 			createRootLayoutFile(context),
+			modifyViteConfig(context),
 		]),
 	);
 

packages/adapter-sveltekit/test/__setup__.ts

@@ -48,6 +48,18 @@ beforeEach(async (ctx) => {
 		JSON.stringify(config),
 	);
 
+	await fs.writeFile(
+		path.join(tmpRoot, "vite.config.js"),
+		`
+import { sveltekit } from "@sveltejs/kit/vite";
+import { defineConfig } from "vite";
+
+export default defineConfig({
+  plugins: [sveltekit()],
+});
+`.trim(),
+	);
+
 	ctx.project = {
 		root: tmpRoot,
 		config,

packages/adapter-sveltekit/test/plugin-project-init.test.ts

@@ -169,6 +169,46 @@ describe("modify slicemachine.config.json", () => {
 	});
 });
 
+describe("modify vite.config.js file", () => {
+	it("adds ./slicemachine.config.json to server.fs.allow", async (ctx) => {
+		const log = vi.fn();
+		const installDependencies = vi.fn();
+
+		const configPath = path.resolve(ctx.project.root, "./vite.config.js");
+
+		const preContents = await fs.readFile(configPath, "utf8");
+		expect(preContents).toMatchInlineSnapshot(`
+			"import { sveltekit } from \\"@sveltejs/kit/vite\\";
+			import { defineConfig } from \\"vite\\";
+
+			export default defineConfig({
+			  plugins: [sveltekit()],
+			});"
+		`);
+
+		await ctx.pluginRunner.callHook("project:init", {
+			log,
+			installDependencies,
+		});
+
+		const postContents = await fs.readFile(configPath, "utf8");
+		expect(postContents).toMatchInlineSnapshot(`
+			"import { sveltekit } from \\"@sveltejs/kit/vite\\";
+			import { defineConfig } from \\"vite\\";
+
+			export default defineConfig({
+			  plugins: [sveltekit()],
+			  server: {
+			    fs: {
+			      allow: [\\"./slicemachine.config.json\\"],
+			    },
+			  },
+			});
+			"
+		`);
+	});
+});
+
 describe("prismicio.js file", () => {
 	it("does not overwrite prismicio file if it already exists", async (ctx) => {
 		const log = vi.fn();

yarn.lock

@@ -9821,6 +9821,7 @@ __metadata:
     fp-ts: ^2.13.1
     io-ts: ^2.2.20
     io-ts-types: ^0.5.19
+    magicast: 0.3.5
     monocle-ts: ^2.3.13
     newtype-ts: ^0.3.5
     pascal-case: ^3.1.2
@@ -24685,6 +24686,17 @@ __metadata:
   languageName: node
   linkType: hard
 
+"magicast@npm:0.3.5, magicast@npm:^0.3.5":
+  version: 0.3.5
+  resolution: "magicast@npm:0.3.5"
+  dependencies:
+    "@babel/parser": ^7.25.4
+    "@babel/types": ^7.25.4
+    source-map-js: ^1.2.0
+  checksum: 668f07ade907a44bccfc9a9321588473f6d5fa25329aa26b9ad9a3bf87cc2e6f9c482cbdd3e33c0b9ab9b79c065630c599cc055a12f881c8c924ee0d7282cdce
+  languageName: node
+  linkType: hard
+
 "magicast@npm:^0.3.4":
   version: 0.3.4
   resolution: "magicast@npm:0.3.4"
@@ -24696,17 +24708,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"magicast@npm:^0.3.5":
-  version: 0.3.5
-  resolution: "magicast@npm:0.3.5"
-  dependencies:
-    "@babel/parser": ^7.25.4
-    "@babel/types": ^7.25.4
-    source-map-js: ^1.2.0
-  checksum: 668f07ade907a44bccfc9a9321588473f6d5fa25329aa26b9ad9a3bf87cc2e6f9c482cbdd3e33c0b9ab9b79c065630c599cc055a12f881c8c924ee0d7282cdce
-  languageName: node
-  linkType: hard
-
 "make-dir@npm:^1.0.0":
   version: 1.3.0
   resolution: "make-dir@npm:1.3.0"