@inlang/sdk 2.9.1 → 2.9.3

package/src/project/saveProjectToDirectory.ts

@@ -1,3 +1,4 @@
+import type nodeFs from "node:fs";
 import type fs from "node:fs/promises";
 import type { InlangProject } from "./api.js";
 import path from "node:path";
@@ -18,6 +19,33 @@ async function fileExists(fsModule: typeof fs, filePath: string) {
 	}
 }
 
+type SaveProjectFs = typeof fs | typeof nodeFs;
+
+function getPromisesFs(fsModule: SaveProjectFs): typeof fs {
+	return "promises" in fsModule ? fsModule.promises : fsModule;
+}
+
+async function assertTranslationDataCanBeExported(project: InlangProject) {
+	const plugins = await project.plugins.get();
+	const hasExporter = plugins.some(
+		(plugin) => plugin.exportFiles || plugin.saveMessages
+	);
+	if (hasExporter) {
+		return;
+	}
+
+	const [bundle, message, variant] = await Promise.all([
+		project.db.selectFrom("bundle").select("id").limit(1).executeTakeFirst(),
+		project.db.selectFrom("message").select("id").limit(1).executeTakeFirst(),
+		project.db.selectFrom("variant").select("id").limit(1).executeTakeFirst(),
+	]);
+	if (bundle || message || variant) {
+		throw new Error(
+			"saveProjectToDirectory cannot write bundles, messages, or variants without an import/export plugin. Add a plugin to settings.modules/providePlugins, or save the canonical .inlang file with project.toBlob()."
+		);
+	}
+}
+
 /**
  * Saves a project to a directory.
  *
@@ -26,7 +54,7 @@ async function fileExists(fsModule: typeof fs, filePath: string) {
  *
  * @example
  *   await saveProjectToDirectory({
- *     fs: await import("node:fs/promises"),
+ *     fs: await import("node:fs"),
  *     project,
  *     path: "./project.inlang",
  *   });
@@ -34,8 +62,10 @@ async function fileExists(fsModule: typeof fs, filePath: string) {
 export async function saveProjectToDirectory(args: {
 	/**
 	 * The file system module to use for writing files.
+	 *
+	 * Accepts either `node:fs` or `node:fs/promises`.
 	 */
-	fs: typeof fs;
+	fs: SaveProjectFs;
 	/**
 	 * The inlang project to save.
 	 */
@@ -55,6 +85,11 @@ export async function saveProjectToDirectory(args: {
 	if (args.path.endsWith(".inlang") === false) {
 		throw new Error("The path must end with .inlang");
 	}
+	if (!args.skipExporting) {
+		await assertTranslationDataCanBeExported(args.project);
+	}
+	const fsModule = getPromisesFs(args.fs);
+
 	const files = await args.project.lix.db
 		.selectFrom("file")
 		.selectAll()
@@ -65,7 +100,7 @@ export async function saveProjectToDirectory(args: {
 	);
 
 	const existingMeta = await readProjectMeta({
-		fs: args.fs,
+		fs: fsModule,
 		projectPath: args.path,
 	});
 	const highestSdkVersion =
@@ -83,9 +118,9 @@ export async function saveProjectToDirectory(args: {
 	const readmePath = path.join(args.path, "README.md");
 	const gitignorePath = path.join(args.path, ".gitignore");
 	const shouldWriteReadme =
-		shouldWriteMetadata || !(await fileExists(args.fs, readmePath));
+		shouldWriteMetadata || !(await fileExists(fsModule, readmePath));
 	const shouldWriteGitignore =
-		shouldWriteMetadata || !(await fileExists(args.fs, gitignorePath));
+		shouldWriteMetadata || !(await fileExists(fsModule, gitignorePath));
 
 	// write all files to the directory
 	for (const file of files) {
@@ -93,17 +128,17 @@ export async function saveProjectToDirectory(args: {
 			continue;
 		}
 		const p = path.join(args.path, file.path);
-		await args.fs.mkdir(path.dirname(p), { recursive: true });
-		await args.fs.writeFile(p, new Uint8Array(file.data));
+		await fsModule.mkdir(path.dirname(p), { recursive: true });
+		await fsModule.writeFile(p, new Uint8Array(file.data));
 	}
 
 	if (shouldWriteGitignore) {
-		await args.fs.writeFile(gitignorePath, gitignoreContent);
+		await fsModule.writeFile(gitignorePath, gitignoreContent);
 	}
 
 	if (shouldWriteReadme) {
 		// Write README.md for coding agents
-		await args.fs.writeFile(
+		await fsModule.writeFile(
 			readmePath,
 			new TextEncoder().encode(README_CONTENT)
 		);
@@ -111,7 +146,7 @@ export async function saveProjectToDirectory(args: {
 
 	if (shouldWriteMetadata) {
 		const metaContent = JSON.stringify({ highestSdkVersion }, null, 2);
-		await args.fs.writeFile(
+		await fsModule.writeFile(
 			path.join(args.path, ".meta.json"),
 			new TextEncoder().encode(metaContent)
 		);
@@ -161,15 +196,12 @@ export async function saveProjectToDirectory(args: {
 								pathPattern.replace(/\{(languageTag|locale)\}/g, file.locale)
 							)
 						: absolutePathFromProject(args.path, file.name);
-					const dirname = path.dirname(p);
-					if ((await args.fs.stat(dirname)).isDirectory() === false) {
-						await args.fs.mkdir(dirname, { recursive: true });
-					}
+					await fsModule.mkdir(path.dirname(p), { recursive: true });
 					if (p.endsWith(".json")) {
 						try {
-							const existing = await args.fs.readFile(p, "utf-8");
+							const existing = await fsModule.readFile(p, "utf-8");
 							const stringify = detectJsonFormatting(existing);
-							await args.fs.writeFile(
+							await fsModule.writeFile(
 								p,
 								new TextEncoder().encode(
 									stringify(JSON.parse(new TextDecoder().decode(file.content)))
@@ -178,10 +210,10 @@ export async function saveProjectToDirectory(args: {
 						} catch {
 							// write the file to disk (json doesn't exist yet)
 							// yeah ugly duplication of write file but it works.
-							await args.fs.writeFile(p, new Uint8Array(file.content));
+							await fsModule.writeFile(p, new Uint8Array(file.content));
 						}
 					} else {
-						await args.fs.writeFile(p, new Uint8Array(file.content));
+						await fsModule.writeFile(p, new Uint8Array(file.content));
 					}
 				}
 			}
@@ -194,7 +226,7 @@ export async function saveProjectToDirectory(args: {
 			await plugin.saveMessages({
 				messages: bundlesNested.map((b) => toMessageV1(b)),
 				// @ts-expect-error - legacy
-				nodeishFs: withAbsolutePaths(args.fs, args.path),
+				nodeishFs: withAbsolutePaths(fsModule, args.path),
 				settings,
 			});
 		}