@inlang/sdk 0.17.0 → 0.18.0

package/dist/createNodeishFsWithAbsolutePaths.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createNodeishFsWithAbsolutePaths.d.ts","sourceRoot":"","sources":["../src/createNodeishFsWithAbsolutePaths.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAA;AAI7D;;;;;GAKG;AACH,eAAO,MAAM,gCAAgC,SAAU;IACtD,gBAAgB,EAAE,MAAM,CAAA;IACxB,SAAS,EAAE,uBAAuB,CAAA;CAClC,KAAG,uBAyBH,CAAA"}
+{"version":3,"file":"createNodeishFsWithAbsolutePaths.d.ts","sourceRoot":"","sources":["../src/createNodeishFsWithAbsolutePaths.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAA;AAI7D;;;;;GAKG;AACH,eAAO,MAAM,gCAAgC,SAAU;IACtD,gBAAgB,EAAE,MAAM,CAAA;IACxB,SAAS,EAAE,uBAAuB,CAAA;CAClC,KAAG,uBA6BH,CAAA"}

package/dist/createNodeishFsWithAbsolutePaths.js

@@ -25,5 +25,6 @@ export const createNodeishFsWithAbsolutePaths = (args) => {
         readdir: (path) => args.nodeishFs.readdir(makeAbsolute(path)),
         mkdir: (path) => args.nodeishFs.mkdir(makeAbsolute(path)),
         writeFile: (path, data) => args.nodeishFs.writeFile(makeAbsolute(path), data),
+        watch: (path, options) => args.nodeishFs.watch(makeAbsolute(path), options),
     };
 };

package/dist/createNodeishFsWithAbsolutePaths.test.js

@@ -20,6 +20,7 @@ it("intercepts paths correctly for readFile", async () => {
         readdir: vi.fn(),
         mkdir: vi.fn(),
         writeFile: vi.fn(),
+        watch: vi.fn(),
     };
     const interceptedFs = createNodeishFsWithAbsolutePaths({
         settingsFilePath,

package/dist/createNodeishFsWithWatcher.d.ts

@@ -0,0 +1,12 @@
+import type { NodeishFilesystemSubset } from "@inlang/plugin";
+/**
+ * Wraps the nodeish filesystem subset with a function that intercepts paths
+ * and prepends the base path.
+ *
+ * The paths are resolved from the `settingsFilePath` argument.
+ */
+export declare const createNodeishFsWithWatcher: (args: {
+    nodeishFs: NodeishFilesystemSubset;
+    updateMessages: () => void;
+}) => NodeishFilesystemSubset;
+//# sourceMappingURL=createNodeishFsWithWatcher.d.ts.map

package/dist/createNodeishFsWithWatcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createNodeishFsWithWatcher.d.ts","sourceRoot":"","sources":["../src/createNodeishFsWithWatcher.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAA;AAE7D;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,SAAU;IAChD,SAAS,EAAE,uBAAuB,CAAA;IAClC,cAAc,EAAE,MAAM,IAAI,CAAA;CAC1B,KAAG,uBA4CH,CAAA"}

package/dist/createNodeishFsWithWatcher.js

@@ -0,0 +1,50 @@
+/**
+ * Wraps the nodeish filesystem subset with a function that intercepts paths
+ * and prepends the base path.
+ *
+ * The paths are resolved from the `settingsFilePath` argument.
+ */
+export const createNodeishFsWithWatcher = (args) => {
+    const pathList = [];
+    const makeWatcher = (path) => {
+        const abortController = new AbortController();
+        (async () => {
+            try {
+                const watcher = args.nodeishFs.watch(path, {
+                    signal: abortController.signal,
+                    persistent: false,
+                });
+                //eslint-disable-next-line @typescript-eslint/no-unused-vars
+                for await (const event of watcher) {
+                    args.updateMessages();
+                }
+            }
+            catch (err) {
+                if (err.name === "AbortError")
+                    return;
+                // https://github.com/inlang/monorepo/issues/1647
+                // the file does not exist (yet)
+                // this is not testable beacause the fs.watch api differs
+                // from node and lix. lenghty
+                else if (err.code === "ENOENT")
+                    return;
+                throw err;
+            }
+        })();
+    };
+    const readFileAndExtractPath = (path, options) => {
+        if (!pathList.includes(path)) {
+            makeWatcher(path);
+            pathList.push(path);
+        }
+        return args.nodeishFs.readFile(path, options);
+    };
+    return {
+        // @ts-expect-error
+        readFile: (path, options) => readFileAndExtractPath(path, options),
+        readdir: args.nodeishFs.readdir,
+        mkdir: args.nodeishFs.mkdir,
+        writeFile: args.nodeishFs.writeFile,
+        watch: args.nodeishFs.watch,
+    };
+};

package/dist/createNodeishFsWithWatcher.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=createNodeishFsWithWatcher.test.d.ts.map

package/dist/createNodeishFsWithWatcher.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createNodeishFsWithWatcher.test.d.ts","sourceRoot":"","sources":["../src/createNodeishFsWithWatcher.test.ts"],"names":[],"mappings":""}

package/dist/createNodeishFsWithWatcher.test.js

@@ -0,0 +1,32 @@
+import { createNodeishMemoryFs } from "@lix-js/fs";
+import { describe, it, expect } from "vitest";
+import { createNodeishFsWithWatcher } from "./createNodeishFsWithWatcher.js";
+describe("watcher", () => {
+    it("should trigger the update function when file changes", async () => {
+        let counter = 0;
+        const fs = createNodeishFsWithWatcher({
+            nodeishFs: createNodeishMemoryFs(),
+            updateMessages: () => {
+                counter++;
+            },
+        });
+        // establish watcher
+        await fs.writeFile("file.txt", "a");
+        await fs.readFile("file.txt", { encoding: "utf-8" });
+        expect(counter).toBe(0);
+        // initial file change
+        await fs.writeFile("file.txt", "b");
+        await new Promise((resolve) => setTimeout(resolve, 0));
+        expect(counter).toBe(1);
+        // change file
+        await fs.writeFile("file.txt", "a");
+        await new Promise((resolve) => setTimeout(resolve, 0));
+        //check if update function was called
+        expect(counter).toBe(2);
+        // change file
+        await fs.readFile("file.txt");
+        await new Promise((resolve) => setTimeout(resolve, 0));
+        //check if update function was called
+        expect(counter).toBe(2);
+    });
+});

package/dist/loadProject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"loadProject.d.ts","sourceRoot":"","sources":["../src/loadProject.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACX,aAAa,EAGb,YAAY,EACZ,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,KAAK,cAAc,EAAkB,MAAM,4BAA4B,CAAA;AAchF,OAAO,EAA4B,KAAK,uBAAuB,EAAE,MAAM,0BAA0B,CAAA;AASjG;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW;sBACL,MAAM;eACb,uBAAuB;;qBAElB,MAAM,SAAS,OAAO,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI;MAC5D,QAAQ,aAAa,CAuMxB,CAAA;AAuHD,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAQtE"}
+{"version":3,"file":"loadProject.d.ts","sourceRoot":"","sources":["../src/loadProject.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACX,aAAa,EAGb,YAAY,EACZ,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,KAAK,cAAc,EAAkB,MAAM,4BAA4B,CAAA;AAchF,OAAO,EAA4B,KAAK,uBAAuB,EAAE,MAAM,0BAA0B,CAAA;AAUjG;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW;sBACL,MAAM;eACb,uBAAuB;;qBAElB,MAAM,SAAS,OAAO,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI;MAC5D,QAAQ,aAAa,CAsNxB,CAAA;AAuHD,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAQtE"}

package/dist/loadProject.js

@@ -11,6 +11,7 @@ import { migrateIfOutdated } from "@inlang/project-settings/migration";
 import { createNodeishFsWithAbsolutePaths } from "./createNodeishFsWithAbsolutePaths.js";
 import { normalizePath } from "@lix-js/fs";
 import { isAbsolutePath } from "./isAbsolutePath.js";
+import { createNodeishFsWithWatcher } from "./createNodeishFsWithWatcher.js";
 const settingsCompiler = TypeCompiler.Compile(ProjectSettings);
 /**
  * Creates an inlang instance.
@@ -95,14 +96,24 @@ export const loadProject = async (args) => {
                 markInitAsFailed(undefined);
                 return;
             }
-            makeTrulyAsync(_resolvedModules.resolvedPluginApi.loadMessages({
-                settings: settingsValue,
-            }))
-                .then((messages) => {
-                setMessages(messages);
-                markInitAsComplete();
-            })
-                .catch((err) => markInitAsFailed(new PluginLoadMessagesError({ cause: err })));
+            const loadAndSetMessages = async (fs) => {
+                makeTrulyAsync(_resolvedModules.resolvedPluginApi.loadMessages({
+                    settings: settingsValue,
+                    nodeishFs: fs,
+                }))
+                    .then((messages) => {
+                    setMessages(messages);
+                    markInitAsComplete();
+                })
+                    .catch((err) => markInitAsFailed(new PluginLoadMessagesError({ cause: err })));
+            };
+            const fsWithWatcher = createNodeishFsWithWatcher({
+                nodeishFs: nodeishFs,
+                updateMessages: () => {
+                    loadAndSetMessages(nodeishFs);
+                },
+            });
+            loadAndSetMessages(fsWithWatcher);
         });
         // -- installed items ----------------------------------------------------
         const installedMessageLintRules = () => {
@@ -135,20 +146,24 @@ export const loadProject = async (args) => {
         const lintReportsQuery = createMessageLintReportsQuery(messages, settings, installedMessageLintRules, resolvedModules);
         const debouncedSave = skipFirst(debounce(500, async (newMessages) => {
             try {
-                await resolvedModules()?.resolvedPluginApi.saveMessages({
-                    settings: settingsValue,
-                    messages: newMessages,
-                });
+                if (JSON.stringify(newMessages) !== JSON.stringify(messages())) {
+                    await resolvedModules()?.resolvedPluginApi.saveMessages({
+                        settings: settingsValue,
+                        messages: newMessages,
+                    });
+                }
             }
             catch (err) {
                 throw new PluginSaveMessagesError({
                     cause: err,
                 });
             }
-            if (newMessages.length !== 0 &&
-                JSON.stringify(newMessages) !== JSON.stringify(messages())) {
-                setMessages(newMessages);
-            }
+            // if (
+            // 	newMessages.length !== 0 &&
+            // 	JSON.stringify(newMessages) !== JSON.stringify(messages())
+            // ) {
+            // 	setMessages(newMessages)
+            // }
         }, { atBegin: false }));
         createEffect(() => {
             debouncedSave(messagesQuery.getAll());

package/dist/loadProject.test.js

@@ -2,7 +2,7 @@
 import { describe, it, expect, vi } from "vitest";
 import { loadProject } from "./loadProject.js";
 import { LoadProjectInvalidArgument, ProjectSettingsFileJSONSyntaxError, ProjectSettingsFileNotFoundError, ProjectSettingsInvalidError, } from "./errors.js";
-import { createNodeishMemoryFs } from "@lix-js/fs";
+import { createNodeishMemoryFs, normalizePath } from "@lix-js/fs";
 import { createMessage } from "./test-utilities/createMessage.js";
 import { tryCatch } from "@inlang/result";
 // ------------------------------------------------------------------------------------------------
@@ -699,4 +699,72 @@ describe("functionality", () => {
             project.query.messageLintReports.getAll.subscribe((r) => expect(r).toEqual([]));
         });
     });
+    describe("watcher", () => {
+        it("changing files in resources should trigger callback of message query", async () => {
+            const fs = createNodeishMemoryFs();
+            const messages = {
+                $schema: "https://inlang.com/schema/inlang-message-format",
+                data: [
+                    {
+                        id: "test",
+                        selectors: [],
+                        variants: [
+                            {
+                                match: [],
+                                languageTag: "en",
+                                pattern: [
+                                    {
+                                        type: "Text",
+                                        value: "test",
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                ],
+            };
+            await fs.writeFile("./messages.json", JSON.stringify(messages));
+            const getMessages = async (customFs) => {
+                const file = await customFs.readFile("./messages.json", { encoding: "utf-8" });
+                return JSON.parse(file.toString()).data;
+            };
+            const mockMessageFormatPlugin = {
+                id: "plugin.inlang.messageFormat",
+                description: { en: "Mock plugin description" },
+                displayName: { en: "Mock Plugin" },
+                loadMessages: async (args) => await getMessages(args.nodeishFs),
+                saveMessages: () => undefined,
+            };
+            const settings = {
+                sourceLanguageTag: "en",
+                languageTags: ["en"],
+                modules: ["plugin.js"],
+                "plugin.inlang.messageFormat": {
+                    filePath: "./messages.json",
+                },
+            };
+            await fs.writeFile("./project.inlang.json", JSON.stringify(settings));
+            // establish watcher
+            const project = await loadProject({
+                settingsFilePath: normalizePath("/project.inlang.json"),
+                nodeishFs: fs,
+                _import: async () => ({
+                    default: mockMessageFormatPlugin,
+                }),
+            });
+            let counter = 0;
+            project.query.messages.getAll.subscribe(() => {
+                counter = counter + 1;
+            });
+            expect(counter).toBe(1);
+            // change file
+            await fs.writeFile("./messages.json", JSON.stringify(messages));
+            await new Promise((resolve) => setTimeout(resolve, 0));
+            expect(counter).toBe(2);
+            // change file
+            await fs.writeFile("./messages.json", JSON.stringify(messages));
+            await new Promise((resolve) => setTimeout(resolve, 0));
+            expect(counter).toBe(3);
+        });
+    });
 });

package/dist/resolve-modules/plugins/resolvePlugins.js

@@ -64,7 +64,7 @@ export const resolvePlugins = async (args) => {
         if (typeof plugin.loadMessages === "function") {
             result.data.loadMessages = (_args) => plugin.loadMessages({
                 ..._args,
-                nodeishFs: args.nodeishFs,
+                // renoved nodeishFs from args because we need to pass custom wrapped fs that establishes a watcher
             });
         }
         if (typeof plugin.saveMessages === "function") {

package/dist/resolve-modules/plugins/resolvePlugins.test.js

@@ -48,7 +48,7 @@ it("should expose the project settings including the plugin settings", async ()
         settings: settings,
         nodeishFs: {},
     });
-    await resolved.data.loadMessages({ settings });
+    await resolved.data.loadMessages({ settings, nodeishFs: {} });
     await resolved.data.saveMessages({ settings, messages: [] });
 });
 describe("loadMessages", () => {
@@ -66,6 +66,7 @@ describe("loadMessages", () => {
         });
         expect(await resolved.data.loadMessages({
             settings: {},
+            nodeishFs: {},
         })).toEqual([{ id: "test", expressions: [], selectors: [], variants: [] }]);
     });
     it("should collect an error if function is defined twice in multiple plugins", async () => {

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

@@ -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<NodeishFilesystem, "readFile" | "readdir" | "mkdir" | "writeFile">;
+export type NodeishFilesystemSubset = Pick<NodeishFilesystem, "readFile" | "readdir" | "mkdir" | "writeFile" | "watch">;
 /**
  * Function that resolves (imports and initializes) the plugins.
  */
@@ -26,6 +26,7 @@ export type ResolvePluginsFunction = (args: {
 export type ResolvedPluginApi = {
     loadMessages: (args: {
         settings: ProjectSettings;
+        nodeishFs: NodeishFilesystemSubset;
     }) => Promise<Message[]> | Message[];
     saveMessages: (args: {
         settings: ProjectSettings;

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,EAAE,MAAM,YAAY,CAAA;AACnD,OAAO,KAAK,EACX,mCAAmC,EACnC,6CAA6C,EAC7C,6CAA6C,EAC7C,uBAAuB,EACvB,2BAA2B,EAC3B,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,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,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,GAAG,OAAO,CACxD,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,0CAA0C,CAC5C,CAAA;CACD,CAAC,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC/B,YAAY,EAAE,CAAC,IAAI,EAAE;QACpB,QAAQ,EAAE,eAAe,CAAA;QACzB,SAAS,EAAE,uBAAuB,CAAA;KAClC,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,GAAG,OAAO,EAAE,CAAA;IACpC,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.17.0",
+	"version": "0.18.0",
 	"license": "Apache-2.0",
 	"publishConfig": {
 		"access": "public"
@@ -22,7 +22,7 @@
 		"test": "tsc --noEmit && vitest run --passWithNoTests --coverage",
 		"lint": "eslint ./src --fix",
 		"format": "prettier ./src --write",
-		"clean": "rm -rf ./dist ./.turbo ./node_modules"
+		"clean": "rm -rf ./dist ./node_modules"
 	},
 	"engines": {
 		"node": ">=18.0.0"

package/src/createNodeishFsWithAbsolutePaths.test.ts

@@ -28,6 +28,7 @@ it("intercepts paths correctly for readFile", async () => {
 		readdir: vi.fn(),
 		mkdir: vi.fn(),
 		writeFile: vi.fn(),
+		watch: vi.fn(),
 	} satisfies Record<keyof NodeishFilesystemSubset, any>
 
 	const interceptedFs = createNodeishFsWithAbsolutePaths({

package/src/createNodeishFsWithAbsolutePaths.ts

@@ -35,5 +35,9 @@ export const createNodeishFsWithAbsolutePaths = (args: {
 		readdir: (path: string) => args.nodeishFs.readdir(makeAbsolute(path)),
 		mkdir: (path: string) => args.nodeishFs.mkdir(makeAbsolute(path)),
 		writeFile: (path: string, data: string) => args.nodeishFs.writeFile(makeAbsolute(path), data),
+		watch: (
+			path: string,
+			options: { signal: AbortSignal | undefined; recursive: boolean | undefined }
+		) => args.nodeishFs.watch(makeAbsolute(path), options),
 	}
 }

package/src/createNodeishFsWithWatcher.test.ts

@@ -0,0 +1,40 @@
+import { createNodeishMemoryFs } from "@lix-js/fs"
+import { describe, it, expect } from "vitest"
+import { createNodeishFsWithWatcher } from "./createNodeishFsWithWatcher.js"
+
+describe("watcher", () => {
+	it("should trigger the update function when file changes", async () => {
+		let counter = 0
+		const fs = createNodeishFsWithWatcher({
+			nodeishFs: createNodeishMemoryFs(),
+			updateMessages: () => {
+				counter++
+			},
+		})
+
+		// establish watcher
+		await fs.writeFile("file.txt", "a")
+		await fs.readFile("file.txt", { encoding: "utf-8" })
+		expect(counter).toBe(0)
+
+		// initial file change
+		await fs.writeFile("file.txt", "b")
+		await new Promise((resolve) => setTimeout(resolve, 0))
+
+		expect(counter).toBe(1)
+
+		// change file
+		await fs.writeFile("file.txt", "a")
+		await new Promise((resolve) => setTimeout(resolve, 0))
+
+		//check if update function was called
+		expect(counter).toBe(2)
+
+		// change file
+		await fs.readFile("file.txt")
+		await new Promise((resolve) => setTimeout(resolve, 0))
+
+		//check if update function was called
+		expect(counter).toBe(2)
+	})
+})

package/src/createNodeishFsWithWatcher.ts

@@ -0,0 +1,56 @@
+import type { NodeishFilesystemSubset } from "@inlang/plugin"
+
+/**
+ * Wraps the nodeish filesystem subset with a function that intercepts paths
+ * and prepends the base path.
+ *
+ * The paths are resolved from the `settingsFilePath` argument.
+ */
+export const createNodeishFsWithWatcher = (args: {
+	nodeishFs: NodeishFilesystemSubset
+	updateMessages: () => void
+}): NodeishFilesystemSubset => {
+	const pathList: string[] = []
+
+	const makeWatcher = (path: string) => {
+		const abortController = new AbortController()
+		;(async () => {
+			try {
+				const watcher = args.nodeishFs.watch(path, {
+					signal: abortController.signal,
+					persistent: false,
+				})
+				//eslint-disable-next-line @typescript-eslint/no-unused-vars
+				for await (const event of watcher) {
+					args.updateMessages()
+				}
+			} catch (err: any) {
+				if (err.name === "AbortError") return
+				// https://github.com/inlang/monorepo/issues/1647
+				// the file does not exist (yet)
+				// this is not testable beacause the fs.watch api differs
+				// from node and lix. lenghty
+				else if (err.code === "ENOENT") return
+				throw err
+			}
+		})()
+	}
+
+	const readFileAndExtractPath = (path: string, options: { encoding: "utf-8" | "binary" }) => {
+		if (!pathList.includes(path)) {
+			makeWatcher(path)
+			pathList.push(path)
+		}
+		return args.nodeishFs.readFile(path, options)
+	}
+
+	return {
+		// @ts-expect-error
+		readFile: (path: string, options: { encoding: "utf-8" | "binary" }) =>
+			readFileAndExtractPath(path, options),
+		readdir: args.nodeishFs.readdir,
+		mkdir: args.nodeishFs.mkdir,
+		writeFile: args.nodeishFs.writeFile,
+		watch: args.nodeishFs.watch,
+	}
+}

package/src/loadProject.test.ts

@@ -1,7 +1,13 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 import { describe, it, expect, vi } from "vitest"
 import { loadProject } from "./loadProject.js"
-import type { ProjectSettings, Plugin, MessageLintRule, Message } from "./versionedInterfaces.js"
+import type {
+	ProjectSettings,
+	Plugin,
+	MessageLintRule,
+	Message,
+	NodeishFilesystemSubset,
+} from "./versionedInterfaces.js"
 import type { ImportFunction } from "./resolve-modules/index.js"
 import type { InlangModule } from "@inlang/module"
 import {
@@ -10,7 +16,7 @@ import {
 	ProjectSettingsFileNotFoundError,
 	ProjectSettingsInvalidError,
 } from "./errors.js"
-import { createNodeishMemoryFs } from "@lix-js/fs"
+import { createNodeishMemoryFs, normalizePath } from "@lix-js/fs"
 import { createMessage } from "./test-utilities/createMessage.js"
 import { tryCatch } from "@inlang/result"
 
@@ -826,4 +832,88 @@ describe("functionality", () => {
 			project.query.messageLintReports.getAll.subscribe((r) => expect(r).toEqual([]))
 		})
 	})
+
+	describe("watcher", () => {
+		it("changing files in resources should trigger callback of message query", async () => {
+			const fs = createNodeishMemoryFs()
+
+			const messages = {
+				$schema: "https://inlang.com/schema/inlang-message-format",
+				data: [
+					{
+						id: "test",
+						selectors: [],
+						variants: [
+							{
+								match: [],
+								languageTag: "en",
+								pattern: [
+									{
+										type: "Text",
+										value: "test",
+									},
+								],
+							},
+						],
+					},
+				],
+			}
+
+			await fs.writeFile("./messages.json", JSON.stringify(messages))
+
+			const getMessages = async (customFs: NodeishFilesystemSubset) => {
+				const file = await customFs.readFile("./messages.json", { encoding: "utf-8" })
+				return JSON.parse(file.toString()).data
+			}
+
+			const mockMessageFormatPlugin: Plugin = {
+				id: "plugin.inlang.messageFormat",
+				description: { en: "Mock plugin description" },
+				displayName: { en: "Mock Plugin" },
+
+				loadMessages: async (args) => await getMessages(args.nodeishFs),
+				saveMessages: () => undefined as any,
+			}
+
+			const settings: ProjectSettings = {
+				sourceLanguageTag: "en",
+				languageTags: ["en"],
+				modules: ["plugin.js"],
+				"plugin.inlang.messageFormat": {
+					filePath: "./messages.json",
+				},
+			}
+
+			await fs.writeFile("./project.inlang.json", JSON.stringify(settings))
+
+			// establish watcher
+			const project = await loadProject({
+				settingsFilePath: normalizePath("/project.inlang.json"),
+				nodeishFs: fs,
+				_import: async () => ({
+					default: mockMessageFormatPlugin,
+				}),
+			})
+
+			let counter = 0
+
+			project.query.messages.getAll.subscribe(() => {
+				counter = counter + 1
+			})
+
+			expect(counter).toBe(1)
+
+			// change file
+			await fs.writeFile("./messages.json", JSON.stringify(messages))
+			await new Promise((resolve) => setTimeout(resolve, 0))
+
+			expect(counter).toBe(2)
+
+			// change file
+			await fs.writeFile("./messages.json", JSON.stringify(messages))
+			await new Promise((resolve) => setTimeout(resolve, 0))
+
+			expect(counter).toBe(3)
+		})
+	})
 })

package/src/loadProject.ts

@@ -25,6 +25,7 @@ import { migrateIfOutdated } from "@inlang/project-settings/migration"
 import { createNodeishFsWithAbsolutePaths } from "./createNodeishFsWithAbsolutePaths.js"
 import { normalizePath } from "@lix-js/fs"
 import { isAbsolutePath } from "./isAbsolutePath.js"
+import { createNodeishFsWithWatcher } from "./createNodeishFsWithWatcher.js"
 
 const settingsCompiler = TypeCompiler.Compile(ProjectSettings)
 
@@ -126,6 +127,7 @@ export const loadProject = async (args: {
 		createEffect(() => (settingsValue = settings()!)) // workaround to not run effects twice (e.g. settings change + modules change) (I'm sure there exists a solid way of doing this, but I haven't found it yet)
 
 		const [messages, setMessages] = createSignal<Message[]>()
+
 		createEffect(() => {
 			const conf = settings()
 			if (!conf) return
@@ -138,16 +140,28 @@ export const loadProject = async (args: {
 				return
 			}
 
-			makeTrulyAsync(
-				_resolvedModules.resolvedPluginApi.loadMessages({
-					settings: settingsValue,
-				})
-			)
-				.then((messages) => {
-					setMessages(messages)
-					markInitAsComplete()
-				})
-				.catch((err) => markInitAsFailed(new PluginLoadMessagesError({ cause: err })))
+			const loadAndSetMessages = async (fs: NodeishFilesystemSubset) => {
+				makeTrulyAsync(
+					_resolvedModules.resolvedPluginApi.loadMessages({
+						settings: settingsValue,
+						nodeishFs: fs,
+					})
+				)
+					.then((messages) => {
+						setMessages(messages)
+						markInitAsComplete()
+					})
+					.catch((err) => markInitAsFailed(new PluginLoadMessagesError({ cause: err })))
+			}
+
+			const fsWithWatcher = createNodeishFsWithWatcher({
+				nodeishFs: nodeishFs,
+				updateMessages: () => {
+					loadAndSetMessages(nodeishFs)
+				},
+			})
+
+			loadAndSetMessages(fsWithWatcher)
 		})
 
 		// -- installed items ----------------------------------------------------
@@ -198,21 +212,23 @@ export const loadProject = async (args: {
 				500,
 				async (newMessages) => {
 					try {
-						await resolvedModules()?.resolvedPluginApi.saveMessages({
-							settings: settingsValue,
-							messages: newMessages,
-						})
+						if (JSON.stringify(newMessages) !== JSON.stringify(messages())) {
+							await resolvedModules()?.resolvedPluginApi.saveMessages({
+								settings: settingsValue,
+								messages: newMessages,
+							})
+						}
 					} catch (err) {
 						throw new PluginSaveMessagesError({
 							cause: err,
 						})
 					}
-					if (
-						newMessages.length !== 0 &&
-						JSON.stringify(newMessages) !== JSON.stringify(messages())
-					) {
-						setMessages(newMessages)
-					}
+					// if (
+					// 	newMessages.length !== 0 &&
+					// 	JSON.stringify(newMessages) !== JSON.stringify(messages())
+					// ) {
+					// 	setMessages(newMessages)
+					// }
 				},
 				{ atBegin: false }
 			)

package/src/resolve-modules/plugins/resolvePlugins.test.ts

@@ -60,7 +60,7 @@ it("should expose the project settings including the plugin settings", async ()
 		settings: settings,
 		nodeishFs: {} as any,
 	})
-	await resolved.data.loadMessages!({ settings })
+	await resolved.data.loadMessages!({ settings, nodeishFs: {} as any })
 	await resolved.data.saveMessages!({ settings, messages: [] })
 })
 
@@ -82,6 +82,7 @@ describe("loadMessages", () => {
 		expect(
 			await resolved.data.loadMessages!({
 				settings: {} as any,
+				nodeishFs: {} as any,
 			})
 		).toEqual([{ id: "test", expressions: [], selectors: [], variants: [] }])
 	})

package/src/resolve-modules/plugins/resolvePlugins.ts

@@ -91,7 +91,7 @@ export const resolvePlugins: ResolvePluginsFunction = async (args) => {
 			result.data.loadMessages = (_args) =>
 				plugin.loadMessages!({
 					..._args,
-					nodeishFs: args.nodeishFs,
+					// renoved nodeishFs from args because we need to pass custom wrapped fs that establishes a watcher
 				})
 		}
 

package/src/resolve-modules/plugins/types.ts

@@ -18,7 +18,7 @@ import type { ProjectSettings } from "@inlang/project-settings"
  */
 export type NodeishFilesystemSubset = Pick<
 	NodeishFilesystem,
-	"readFile" | "readdir" | "mkdir" | "writeFile"
+	"readFile" | "readdir" | "mkdir" | "writeFile" | "watch"
 >
 
 /**
@@ -44,7 +44,10 @@ export type ResolvePluginsFunction = (args: {
  * The API after resolving the plugins.
  */
 export type ResolvedPluginApi = {
-	loadMessages: (args: { settings: ProjectSettings }) => Promise<Message[]> | Message[]
+	loadMessages: (args: {
+		settings: ProjectSettings
+		nodeishFs: NodeishFilesystemSubset
+	}) => Promise<Message[]> | Message[]
 	saveMessages: (args: { settings: ProjectSettings; messages: Message[] }) => Promise<void> | void
 	/**
 	 * App specific APIs.