@inlang/sdk 0.10.0 → 0.11.0

package/dist/resolve-modules/plugins/types.d.ts

@@ -1,4 +1,4 @@
-import type { NodeishFilesystem as LisaNodeishFilesystem } from "@lix-js/fs";
+import type { NodeishFilesystem } from "@lix-js/fs";
 import type { PluginReturnedInvalidCustomApiError, PluginLoadMessagesFunctionAlreadyDefinedError, PluginSaveMessagesFunctionAlreadyDefinedError, PluginHasInvalidIdError, PluginHasInvalidSchemaError, PluginUsesReservedNamespaceError, PluginsDoNotProvideLoadOrSaveMessagesError } from "./errors.js";
 import type { Message } from "@inlang/message";
 import type { CustomApiInlangIdeExtension, Plugin } from "@inlang/plugin";
@@ -8,7 +8,7 @@ import type { ProjectSettings } from "@inlang/project-settings";
  *
  * - only uses minimally required functions to decrease the API footprint on the ecosystem.
  */
-export type NodeishFilesystemSubset = Pick<LisaNodeishFilesystem, "readFile" | "readdir" | "mkdir" | "writeFile">;
+export type NodeishFilesystemSubset = Pick<NodeishFilesystem, "readFile" | "readdir" | "mkdir" | "writeFile">;
 /**
  * Function that resolves (imports and initializes) the plugins.
  */

package/dist/resolve-modules/plugins/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/resolve-modules/plugins/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,IAAI,qBAAqB,EAAE,MAAM,YAAY,CAAA;AAC5E,OAAO,KAAK,EACX,mCAAmC,EACnC,6CAA6C,EAC7C,6CAA6C,EAC7C,uBAAuB,EACvB,2BAA2B,EAC3B,gCAAgC,EAChC,0CAA0C,EAC1C,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACzE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAE/D;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,IAAI,CACzC,qBAAqB,EACrB,UAAU,GAAG,SAAS,GAAG,OAAO,GAAG,WAAW,CAC9C,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,IAAI,EAAE;IAC3C,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IACtB,QAAQ,EAAE,eAAe,CAAA;IACzB,SAAS,EAAE,uBAAuB,CAAA;CAClC,KAAK,OAAO,CAAC;IACb,IAAI,EAAE,iBAAiB,CAAA;IACvB,MAAM,EAAE,KAAK,CACV,mCAAmC,GACnC,6CAA6C,GAC7C,6CAA6C,GAC7C,uBAAuB,GACvB,2BAA2B,GAC3B,gCAAgC,GAChC,0CAA0C,CAC5C,CAAA;CACD,CAAC,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC/B,YAAY,EAAE,CAAC,IAAI,EAAE;QAAE,QAAQ,EAAE,eAAe,CAAA;KAAE,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,GAAG,OAAO,EAAE,CAAA;IACrF,YAAY,EAAE,CAAC,IAAI,EAAE;QAAE,QAAQ,EAAE,eAAe,CAAC;QAAC,QAAQ,EAAE,OAAO,EAAE,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IAChG;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,EAAE,MAAM,CAAC,OAAO,MAAM,IAAI,MAAM,EAAE,GAAG,WAAW,MAAM,IAAI,MAAM,EAAE,EAAE,OAAO,CAAC,GAAG;QACvF,yBAAyB,CAAC,EAAE,2BAA2B,CAAA;KACvD,CAAA;CACD,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/resolve-modules/plugins/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AACnD,OAAO,KAAK,EACX,mCAAmC,EACnC,6CAA6C,EAC7C,6CAA6C,EAC7C,uBAAuB,EACvB,2BAA2B,EAC3B,gCAAgC,EAChC,0CAA0C,EAC1C,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACzE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAE/D;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,IAAI,CACzC,iBAAiB,EACjB,UAAU,GAAG,SAAS,GAAG,OAAO,GAAG,WAAW,CAC9C,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,IAAI,EAAE;IAC3C,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IACtB,QAAQ,EAAE,eAAe,CAAA;IACzB,SAAS,EAAE,uBAAuB,CAAA;CAClC,KAAK,OAAO,CAAC;IACb,IAAI,EAAE,iBAAiB,CAAA;IACvB,MAAM,EAAE,KAAK,CACV,mCAAmC,GACnC,6CAA6C,GAC7C,6CAA6C,GAC7C,uBAAuB,GACvB,2BAA2B,GAC3B,gCAAgC,GAChC,0CAA0C,CAC5C,CAAA;CACD,CAAC,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC/B,YAAY,EAAE,CAAC,IAAI,EAAE;QAAE,QAAQ,EAAE,eAAe,CAAA;KAAE,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,GAAG,OAAO,EAAE,CAAA;IACrF,YAAY,EAAE,CAAC,IAAI,EAAE;QAAE,QAAQ,EAAE,eAAe,CAAC;QAAC,QAAQ,EAAE,OAAO,EAAE,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IAChG;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,EAAE,MAAM,CAAC,OAAO,MAAM,IAAI,MAAM,EAAE,GAAG,WAAW,MAAM,IAAI,MAAM,EAAE,EAAE,OAAO,CAAC,GAAG;QACvF,yBAAyB,CAAC,EAAE,2BAA2B,CAAA;KACvD,CAAA;CACD,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@inlang/sdk",
 	"type": "module",
-	"version": "0.10.0",
+	"version": "0.11.0",
 	"license": "Apache-2.0",
 	"publishConfig": {
 		"access": "public"

package/src/adapter/solidAdapter.test.ts

@@ -88,10 +88,11 @@ const $import: ImportFunction = async (name) => ({
 describe("config", () => {
 	it("should react to changes in config", async () => {
 		const fs = createNodeishMemoryFs()
-		await fs.writeFile("./project.inlang.json", JSON.stringify(config))
+		await fs.mkdir("/user/project", { recursive: true })
+		await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(config))
 		const project = solidAdapter(
 			await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import: $import,
 			}),
@@ -118,10 +119,11 @@ describe("config", () => {
 describe("installed", () => {
 	it("react to changes that are unrelated to installed items", async () => {
 		const fs = createNodeishMemoryFs()
-		await fs.writeFile("./project.inlang.json", JSON.stringify(config))
+		await fs.mkdir("/user/project", { recursive: true })
+		await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(config))
 		const project = solidAdapter(
 			await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import: $import,
 			}),
@@ -181,10 +183,11 @@ describe("messages", () => {
 
 		const mockImport: ImportFunction = async () => ({ default: mockPlugin })
 
-		await fs.writeFile("./project.inlang.json", JSON.stringify(mockConfig))
+		await fs.mkdir("/user/project", { recursive: true })
+		await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(mockConfig))
 		const project = solidAdapter(
 			await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import: mockImport,
 			}),
@@ -210,10 +213,11 @@ describe("messages", () => {
 
 	it("should react to changes in messages", async () => {
 		const fs = createNodeishMemoryFs()
-		await fs.writeFile("./project.inlang.json", JSON.stringify(config))
+		await fs.mkdir("/user/project", { recursive: true })
+		await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(config))
 		const project = solidAdapter(
 			await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import: $import,
 			}),

package/src/loadProject.test.ts

@@ -10,6 +10,7 @@ import {
 	ProjectSettingsInvalidError,
 } from "./errors.js"
 import { createNodeishMemoryFs } from "@lix-js/fs"
+import { createMessage } from "./test-utilities/createMessage.js"
 
 // ------------------------------------------------------------------------------------------------
 
@@ -99,9 +100,10 @@ describe("initialization", () => {
 	describe("settings", () => {
 		it("should return an error if settings file is not found", async () => {
 			const fs = createNodeishMemoryFs()
+			fs.mkdir("/user/project", { recursive: true })
 
 			const project = await loadProject({
-				settingsFilePath: "./test.json",
+				settingsFilePath: "/user/project/test.json",
 				nodeishFs: fs,
 				_import,
 			})
@@ -111,10 +113,11 @@ describe("initialization", () => {
 
 		it("should return an error if settings file is not a valid JSON", async () => {
 			const fs = await createNodeishMemoryFs()
-			await fs.writeFile("./project.inlang.json", "invalid json")
+			await fs.mkdir("/user/project", { recursive: true })
+			await fs.writeFile("/user/project/project.inlang.json", "invalid json")
 
 			const project = await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import,
 			})
@@ -124,10 +127,11 @@ describe("initialization", () => {
 
 		it("should return an error if settings file is does not match schema", async () => {
 			const fs = await createNodeishMemoryFs()
-			await fs.writeFile("./project.inlang.json", JSON.stringify({}))
+			await fs.mkdir("/user/project", { recursive: true })
+			await fs.writeFile("/user/project/project.inlang.json", JSON.stringify({}))
 
 			const project = await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import,
 			})
@@ -137,9 +141,10 @@ describe("initialization", () => {
 
 		it("should return the parsed settings", async () => {
 			const fs = await createNodeishMemoryFs()
-			await fs.writeFile("./project.inlang.json", JSON.stringify(settings))
+			await fs.mkdir("/user/project", { recursive: true })
+			await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(settings))
 			const project = await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import,
 			})
@@ -150,22 +155,27 @@ describe("initialization", () => {
 		it("should not re-write the settings to disk when initializing", async () => {
 			const fs = await createNodeishMemoryFs()
 			const settingsWithDeifferentFormatting = JSON.stringify(settings, undefined, 4)
-			await fs.writeFile("./project.inlang.json", settingsWithDeifferentFormatting)
+			await fs.mkdir("/user/project", { recursive: true })
+			await fs.writeFile("/user/project/project.inlang.json", settingsWithDeifferentFormatting)
 
 			const project = await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import,
 			})
 
-			const settingsOnDisk = await fs.readFile("./project.inlang.json", { encoding: "utf-8" })
+			const settingsOnDisk = await fs.readFile("/user/project/project.inlang.json", {
+				encoding: "utf-8",
+			})
 			expect(settingsOnDisk).toBe(settingsWithDeifferentFormatting)
 
 			project.setSettings(project.settings())
 			// TODO: how can we await `setsettings` correctly
 			await new Promise((resolve) => setTimeout(resolve, 0))
 
-			const newsettingsOnDisk = await fs.readFile("./project.inlang.json", { encoding: "utf-8" })
+			const newsettingsOnDisk = await fs.readFile("/user/project/project.inlang.json", {
+				encoding: "utf-8",
+			})
 			expect(newsettingsOnDisk).not.toBe(settingsWithDeifferentFormatting)
 		})
 	})
@@ -178,10 +188,11 @@ describe("initialization", () => {
 				} satisfies InlangModule)
 
 			const fs = createNodeishMemoryFs()
-			await fs.writeFile("./project.inlang.json", JSON.stringify(settings))
+			await fs.mkdir("/user/project", { recursive: true })
+			await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(settings))
 
 			const project = await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import: $badImport,
 			})
@@ -210,9 +221,10 @@ describe("functionality", () => {
 	describe("settings", () => {
 		it("should return the settings", async () => {
 			const fs = await createNodeishMemoryFs()
-			await fs.writeFile("./project.inlang.json", JSON.stringify(settings))
+			await fs.mkdir("/user/project", { recursive: true })
+			await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(settings))
 			const project = await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import,
 			})
@@ -222,9 +234,10 @@ describe("functionality", () => {
 
 		it("should set a new settings", async () => {
 			const fs = await createNodeishMemoryFs()
-			await fs.writeFile("./project.inlang.json", JSON.stringify(settings))
+			await fs.mkdir("/user/project", { recursive: true })
+			await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(settings))
 			const project = await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import,
 			})
@@ -247,9 +260,10 @@ describe("functionality", () => {
 	describe("setSettings", () => {
 		it("should fail if settings is not valid", async () => {
 			const fs = await createNodeishMemoryFs()
-			await fs.writeFile("./project.inlang.json", JSON.stringify(settings))
+			await fs.mkdir("/user/project", { recursive: true })
+			await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(settings))
 			const project = await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import,
 			})
@@ -261,14 +275,15 @@ describe("functionality", () => {
 
 		it("should write settings to disk", async () => {
 			const fs = await createNodeishMemoryFs()
-			await fs.writeFile("./project.inlang.json", JSON.stringify(settings))
+			await fs.mkdir("/user/project", { recursive: true })
+			await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(settings))
 			const project = await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import,
 			})
 
-			const before = await fs.readFile("./project.inlang.json", { encoding: "utf-8" })
+			const before = await fs.readFile("/user/project/project.inlang.json", { encoding: "utf-8" })
 			expect(before).toBeDefined()
 
 			const result = project.setSettings({ ...settings, languageTags: [] })
@@ -278,7 +293,7 @@ describe("functionality", () => {
 			// TODO: how to wait for fs.writeFile to finish?
 			await new Promise((resolve) => setTimeout(resolve, 0))
 
-			const after = await fs.readFile("./project.inlang.json", { encoding: "utf-8" })
+			const after = await fs.readFile("/user/project/project.inlang.json", { encoding: "utf-8" })
 			expect(after).toBeDefined()
 			expect(after).not.toBe(before)
 		})
@@ -292,9 +307,10 @@ describe("functionality", () => {
 				languageTags: ["en"],
 				modules: ["plugin.js", "lintRule.js"],
 			}
-			await fs.writeFile("./project.inlang.json", JSON.stringify(settings))
+			await fs.mkdir("/user/project", { recursive: true })
+			await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(settings))
 			const project = await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import,
 			})
@@ -324,10 +340,11 @@ describe("functionality", () => {
 				modules: ["plugin.js", "lintRule.js"],
 			}
 
-			await fs.writeFile("./project.inlang.json", JSON.stringify(settings))
+			await fs.mkdir("/user/project", { recursive: true })
+			await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(settings))
 
 			const project = await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import,
 			})
@@ -357,8 +374,9 @@ describe("functionality", () => {
 				saveMessages: () => undefined,
 			}
 			const fs = await createNodeishMemoryFs()
+			await fs.mkdir("/user/project", { recursive: true })
 			await fs.writeFile(
-				"./project.inlang.json",
+				"/user/project/project.inlang.json",
 				JSON.stringify({
 					sourceLanguageTag: "en",
 					languageTags: ["en"],
@@ -372,7 +390,7 @@ describe("functionality", () => {
 				} satisfies InlangModule
 			}
 			const project = await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import,
 			})
@@ -405,8 +423,9 @@ describe("functionality", () => {
 				saveMessages: () => undefined,
 			}
 			const fs = await createNodeishMemoryFs()
+			await fs.mkdir("/user/project", { recursive: true })
 			await fs.writeFile(
-				"./project.settings.json",
+				"/user/project/project.inlang.json",
 				JSON.stringify({
 					sourceLanguageTag: "en",
 					languageTags: ["en"],
@@ -420,7 +439,7 @@ describe("functionality", () => {
 			}
 
 			const project = await loadProject({
-				settingsFilePath: "./project.settings.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import,
 			})
@@ -436,9 +455,10 @@ describe("functionality", () => {
 	describe("errors", () => {
 		it("should return the errors", async () => {
 			const fs = await createNodeishMemoryFs()
-			await fs.writeFile("./project.inlang.json", JSON.stringify(settings))
+			await fs.mkdir("/user/project", { recursive: true })
+			await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(settings))
 			const project = await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import,
 			})
@@ -451,9 +471,10 @@ describe("functionality", () => {
 	describe("customApi", () => {
 		it("should return the app specific api", async () => {
 			const fs = await createNodeishMemoryFs()
-			await fs.writeFile("./project.inlang.json", JSON.stringify(settings))
+			await fs.mkdir("/user/project", { recursive: true })
+			await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(settings))
 			const project = await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import,
 			})
@@ -467,9 +488,10 @@ describe("functionality", () => {
 	describe("messages", () => {
 		it("should return the messages", async () => {
 			const fs = await createNodeishMemoryFs()
-			await fs.writeFile("./project.inlang.json", JSON.stringify(settings))
+			await fs.mkdir("/user/project", { recursive: true })
+			await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(settings))
 			const project = await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import,
 			})
@@ -491,7 +513,8 @@ describe("functionality", () => {
 				},
 			}
 
-			await fs.writeFile("./project.inlang.json", JSON.stringify(settings))
+			await fs.mkdir("/user/project", { recursive: true })
+			await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(settings))
 
 			await fs.mkdir("./resources")
 
@@ -512,7 +535,7 @@ describe("functionality", () => {
 			}
 
 			const project = await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import,
 			})
@@ -639,14 +662,79 @@ describe("functionality", () => {
 				},
 			])
 		})
+
+		/*
+		 * Passing all messages to saveMessages() simplifies plugins by an order of magnitude.
+		 *
+		 * The alternative would be to pass only the messages that changed to saveMessages().
+		 * But, this would require plugins to maintain a separate data structure of messages
+		 * and create optimizations, leading to (unjustified) complexity for plugin authors.
+		 *
+		 * Pros:
+		 *   - plugins don't need to transform the data (time complexity).
+		 *   - plugins don't to maintain a separate data structure (space complexity).
+		 *   - plugin authors don't need to deal with optimizations (ecosystem complexity).
+		 *
+		 * Cons:
+		 *  - Might be slow for a large number of messages. The requirement hasn't popped up yet though.
+		 */
+		it("should pass all messages, regardless of which message changed, to saveMessages()", async () => {
+			const fs = createNodeishMemoryFs()
+
+			const settings: ProjectSettings = {
+				sourceLanguageTag: "en",
+				languageTags: ["en", "de"],
+				modules: ["plugin.js"],
+				"plugin.project.json": {
+					pathPattern: "./resources/{languageTag}.json",
+				},
+			}
+
+			await fs.mkdir("/user/project", { recursive: true })
+			await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(settings))
+
+			const mockSaveFn = vi.fn()
+
+			const _mockPlugin: Plugin = {
+				id: "plugin.project.json",
+				description: "Mock plugin description",
+				displayName: "Mock Plugin",
+				loadMessages: () => [
+					createMessage("first", { en: "first message" }),
+					createMessage("second", { en: "second message" }),
+					createMessage("third", { en: "third message" }),
+				],
+				saveMessages: mockSaveFn,
+			}
+
+			const _import = async () => {
+				return {
+					default: _mockPlugin,
+				} satisfies InlangModule
+			}
+
+			const project = await loadProject({
+				settingsFilePath: "/user/project/project.inlang.json",
+				nodeishFs: fs,
+				_import,
+			})
+
+			project.query.messages.create({ data: createMessage("fourth", { en: "fourth message" }) })
+
+			await new Promise((resolve) => setTimeout(resolve, 510))
+
+			expect(mockSaveFn.mock.calls.length).toBe(1)
+			expect(mockSaveFn.mock.calls[0][0].messages).toHaveLength(4)
+		})
 	})
 
 	describe("lint", () => {
 		it.todo("should throw if lint reports are not initialized yet", async () => {
 			const fs = await createNodeishMemoryFs()
-			await fs.writeFile("./project.inlang.json", JSON.stringify(settings))
+			await fs.mkdir("/user/project", { recursive: true })
+			await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(settings))
 			const project = await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import,
 			})
@@ -665,9 +753,10 @@ describe("functionality", () => {
 				modules: ["lintRule.js"],
 			}
 			const fs = createNodeishMemoryFs()
-			await fs.writeFile("./project.inlang.json", JSON.stringify(settings))
+			await fs.mkdir("/user/project", { recursive: true })
+			await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(settings))
 			const project = await loadProject({
-				settingsFilePath: "./project.inlang.json",
+				settingsFilePath: "/user/project/project.inlang.json",
 				nodeishFs: fs,
 				_import: async () => ({
 					default: mockMessageLintRule,

package/src/loadProject.ts

@@ -21,14 +21,18 @@ import { createMessageLintReportsQuery } from "./createMessageLintReportsQuery.j
 import { ProjectSettings, Message, type NodeishFilesystemSubset } from "./versionedInterfaces.js"
 import { tryCatch, type Result } from "@inlang/result"
 import { migrateIfOutdated } from "@inlang/project-settings/migration"
+import { createNodeishFsWithAbsolutePaths } from "./resolve-modules/createNodeishFsWithAbsolutePaths.js"
 
 const settingsCompiler = TypeCompiler.Compile(ProjectSettings)
 
 /**
  * Creates an inlang instance.
  *
- * - Use `_import` to pass a custom import function for testing,
+ * @param settingsFilePath - Absolute path to the inlang settings file.
+ * @param nodeishFs - Filesystem that implements the NodeishFilesystemSubset interface.
+ * @param _import - Use `_import` to pass a custom import function for testing,
  *   and supporting legacy resolvedModules such as CJS.
+ * @param _capture - Use `_capture` to capture events for analytics.
  *
  */
 export const loadProject = async (args: {
@@ -40,11 +44,18 @@ export const loadProject = async (args: {
 	return await createRoot(async () => {
 		const [initialized, markInitAsComplete, markInitAsFailed] = createAwaitable()
 
+		// -- absolute path env -----------------------------------------------
+
+		const nodeishFs = createNodeishFsWithAbsolutePaths({
+			nodeishFs: args.nodeishFs,
+			basePath: args.settingsFilePath.replace(/(.*?)[^/]*\..*$/, "$1"), // get directory of settings file
+		})
+
 		// -- settings ------------------------------------------------------------
 
 		const [settings, _setSettings] = createSignal<ProjectSettings>()
 		createEffect(() => {
-			loadSettings({ settingsFilePath: args.settingsFilePath, nodeishFs: args.nodeishFs })
+			loadSettings({ settingsFilePath: args.settingsFilePath, nodeishFs })
 				.then((settings) => {
 					setSettings(settings)
 					// rename settings to get a convenient access to the data in Posthog
@@ -58,7 +69,7 @@ export const loadProject = async (args: {
 		// TODO: create FS watcher and update settings on change
 
 		const writeSettingsToDisk = skipFirst((settings: ProjectSettings) =>
-			_writeSettingsToDisk({ nodeishFs: args.nodeishFs, settings })
+			_writeSettingsToDisk({ nodeishFs, settings })
 		)
 
 		const setSettings = (settings: ProjectSettings): Result<void, ProjectSettingsInvalidError> => {
@@ -88,7 +99,7 @@ export const loadProject = async (args: {
 			const _settings = settings()
 			if (!_settings) return
 
-			resolveModules({ settings: _settings, nodeishFs: args.nodeishFs, _import: args._import })
+			resolveModules({ settings: _settings, nodeishFs, _import: args._import })
 				.then((resolvedModules) => {
 					setResolvedModules(resolvedModules)
 				})
@@ -327,3 +338,5 @@ export function createSubscribable<T>(signal: () => T): Subscribable<T> {
 		},
 	})
 }
+
+

package/src/resolve-modules/createNodeishFsWithAbsolutePaths.test.ts

@@ -0,0 +1,102 @@
+import type { NodeishFilesystemSubset } from "@inlang/plugin"
+import { describe, it, expect } from "vitest"
+import { createNodeishFsWithAbsolutePaths } from "./createNodeishFsWithAbsolutePaths.js"
+
+describe("createNodeishFsWithAbsolutePaths", () => {
+	it("throws an error if basePath is not an absolute path", () => {
+		const invalidBasePath = "relative/path"
+		const nodeishFs: NodeishFilesystemSubset = {
+			// @ts-expect-error
+			readFile: async () => Promise.resolve(new Uint8Array(0)),
+			readdir: async () => Promise.resolve([]),
+			mkdir: async () => Promise.resolve(""),
+			writeFile: async () => Promise.resolve(),
+		}
+
+		expect(() =>
+			createNodeishFsWithAbsolutePaths({ basePath: invalidBasePath, nodeishFs })
+		).toThrowError("The argument `settingsFilePath` of `loadProject()` must be an absolute path.")
+	})
+
+	it("intercepts paths correctly for readFile", async () => {
+		const basePath = "/absolute/path"
+		const filePath = "file.txt"
+		const expectedPath = "/absolute/path/file.txt"
+
+		const nodeishFs: NodeishFilesystemSubset = {
+			// @ts-expect-error
+			readFile: async (path) => {
+				expect(path).toBe(expectedPath)
+				return Promise.resolve(new Uint8Array(0))
+			},
+			readdir: async () => Promise.resolve([]),
+			mkdir: async () => Promise.resolve(""),
+			writeFile: async () => Promise.resolve(),
+		}
+
+		const interceptedFs = createNodeishFsWithAbsolutePaths({ basePath, nodeishFs })
+		await interceptedFs.readFile(filePath, { encoding: "utf-8" })
+	})
+
+	it("intercepts paths correctly for readdir", async () => {
+		const basePath = "/absolute/path"
+		const dirPath = "dir"
+		const expectedPath = "/absolute/path/dir"
+
+		const nodeishFs: NodeishFilesystemSubset = {
+			// @ts-expect-error
+			readFile: async () => Promise.resolve(new Uint8Array(0)),
+			readdir: async (path) => {
+				expect(path).toBe(expectedPath)
+				return Promise.resolve([])
+			},
+			mkdir: async () => Promise.resolve(""),
+			writeFile: async () => Promise.resolve(),
+		}
+
+		const interceptedFs = createNodeishFsWithAbsolutePaths({ basePath, nodeishFs })
+		await interceptedFs.readdir(dirPath)
+	})
+
+	it("intercepts paths correctly for mkdir", async () => {
+		const basePath = "/absolute/path"
+		const dirPath = "newDir"
+		const expectedPath = "/absolute/path/newDir"
+
+		const nodeishFs: NodeishFilesystemSubset = {
+			// @ts-expect-error
+			readFile: async () => Promise.resolve(new Uint8Array(0)),
+			readdir: async () => Promise.resolve([]),
+			mkdir: async (path) => {
+				expect(path).toBe(expectedPath)
+				return Promise.resolve("")
+			},
+			writeFile: async () => Promise.resolve(),
+		}
+
+		const interceptedFs = createNodeishFsWithAbsolutePaths({ basePath, nodeishFs })
+		await interceptedFs.mkdir(dirPath)
+	})
+
+	it("intercepts paths correctly for writeFile", async () => {
+		const basePath = "/absolute/path"
+		const filePath = "file.txt"
+		const expectedPath = "/absolute/path/file.txt"
+		const data = "Hello, World!"
+
+		const nodeishFs: NodeishFilesystemSubset = {
+			// @ts-expect-error
+			readFile: async () => Promise.resolve(new Uint8Array(0)),
+			readdir: async () => Promise.resolve([]),
+			mkdir: async () => Promise.resolve(""),
+			writeFile: async (path, content) => {
+				expect(path).toBe(expectedPath)
+				expect(content).toBe(data)
+				return Promise.resolve()
+			},
+		}
+
+		const interceptedFs = createNodeishFsWithAbsolutePaths({ basePath, nodeishFs })
+		await interceptedFs.writeFile(filePath, data)
+	})
+})