@inlang/sdk 0.18.0 → 0.20.0

package/README.md

@@ -13,4 +13,4 @@ Developer-first localization infrastructure that is built on git. Your git repos
 
 # @inlang/sdk
 
-The core module bundles "sdk" modules that depend on each other and is everything one needs to build [plugins](https://inlang.com/documentation/plugin) or entire [apps](https://inlang.com/documentation/develop-app) on inlang.
+The core module bundles "sdk" modules that depend on each other and is everything one needs to build [plugins](https://inlang.com/documentation/plugin) or entire [apps](https://inlang.com/documentation/build-app) on inlang.

package/dist/adapter/solidAdapter.test.js

@@ -72,10 +72,10 @@ const $import = async (name) => ({
 describe("config", () => {
     it("should react to changes in config", async () => {
         const fs = createNodeishMemoryFs();
-        await fs.mkdir("/user/project", { recursive: true });
-        await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(config));
+        await fs.mkdir("/user/project.inlang", { recursive: true });
+        await fs.writeFile("/user/project.inlang/settings.json", JSON.stringify(config));
         const project = solidAdapter(await loadProject({
-            settingsFilePath: "/user/project/project.inlang.json",
+            projectPath: "/user/project.inlang",
             nodeishFs: fs,
             _import: $import,
         }), { from });
@@ -96,10 +96,10 @@ describe("config", () => {
 describe("installed", () => {
     it("react to changes that are unrelated to installed items", async () => {
         const fs = createNodeishMemoryFs();
-        await fs.mkdir("/user/project", { recursive: true });
-        await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(config));
+        await fs.mkdir("/user/project.inlang", { recursive: true });
+        await fs.writeFile("/user/project.inlang/settings.json", JSON.stringify(config));
         const project = solidAdapter(await loadProject({
-            settingsFilePath: "/user/project/project.inlang.json",
+            projectPath: "/user/project.inlang",
             nodeishFs: fs,
             _import: $import,
         }), { from });
@@ -149,10 +149,10 @@ describe("messages", () => {
             saveMessages: () => undefined,
         };
         const mockImport = async () => ({ default: mockPlugin });
-        await fs.mkdir("/user/project", { recursive: true });
-        await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(mockConfig));
+        await fs.mkdir("/user/project.inlang.inlang", { recursive: true });
+        await fs.writeFile("/user/project.inlang.inlang/settings.json", JSON.stringify(mockConfig));
         const project = solidAdapter(await loadProject({
-            settingsFilePath: "/user/project/project.inlang.json",
+            projectPath: "/user/project.inlang.inlang",
             nodeishFs: fs,
             _import: mockImport,
         }), { from });
@@ -170,10 +170,10 @@ describe("messages", () => {
     });
     it("should react to changes in messages", async () => {
         const fs = createNodeishMemoryFs();
-        await fs.mkdir("/user/project", { recursive: true });
-        await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(config));
+        await fs.mkdir("/user/project.inlang.inlang", { recursive: true });
+        await fs.writeFile("/user/project.inlang.inlang/settings.json", JSON.stringify(config));
         const project = solidAdapter(await loadProject({
-            settingsFilePath: "/user/project/project.inlang.json",
+            projectPath: "/user/project.inlang.inlang",
             nodeishFs: fs,
             _import: $import,
         }), { from });
@@ -216,9 +216,10 @@ describe("lint", () => {
     it.todo("should react to changes in config", async () => {
         await createRoot(async () => {
             const fs = createNodeishMemoryFs();
-            await fs.writeFile("./project.config.json", JSON.stringify(config));
+            await fs.mkdir("./project.inlang", { recursive: true });
+            await fs.writeFile("./project.inlang/settings.json", JSON.stringify(config));
             const project = solidAdapter(await loadProject({
-                settingsFilePath: "./project.config.json",
+                projectPath: "./project.inlang",
                 nodeishFs: fs,
                 _import: $import,
             }), { from });
@@ -245,7 +246,7 @@ describe("lint", () => {
             const fs = createNodeishMemoryFs();
             await fs.writeFile("./project.config.json", JSON.stringify(config));
             const project = solidAdapter(await loadProject({
-                settingsFilePath: "./project.config.json",
+                projectPath: "./project.config.json",
                 nodeishFs: fs,
                 _import: $import,
             }), { from });

package/dist/createMessageLintReportsQuery.d.ts

@@ -1,9 +1,8 @@
-import type { InlangProject, InstalledMessageLintRule } from "./api.js";
+import type { InlangProject, InstalledMessageLintRule, MessageQueryApi } from "./api.js";
 import type { ProjectSettings } from "@inlang/project-settings";
 import type { resolveModules } from "./resolve-modules/index.js";
-import type { Message } from "./versionedInterfaces.js";
 /**
  * Creates a reactive query API for messages.
  */
-export declare function createMessageLintReportsQuery(messages: () => Array<Message> | undefined, settings: () => ProjectSettings, installedMessageLintRules: () => Array<InstalledMessageLintRule>, resolvedModules: () => Awaited<ReturnType<typeof resolveModules>> | undefined): InlangProject["query"]["messageLintReports"];
+export declare function createMessageLintReportsQuery(messagesQuery: MessageQueryApi, settings: () => ProjectSettings, installedMessageLintRules: () => Array<InstalledMessageLintRule>, resolvedModules: () => Awaited<ReturnType<typeof resolveModules>> | undefined, hasWatcher: boolean): InlangProject["query"]["messageLintReports"];
 //# sourceMappingURL=createMessageLintReportsQuery.d.ts.map

package/dist/createMessageLintReportsQuery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createMessageLintReportsQuery.d.ts","sourceRoot":"","sources":["../src/createMessageLintReportsQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,wBAAwB,EAA8B,MAAM,UAAU,CAAA;AACnG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAC/D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAChE,OAAO,KAAK,EAAqB,OAAO,EAAE,MAAM,0BAA0B,CAAA;AAI1E;;GAEG;AACH,wBAAgB,6BAA6B,CAC5C,QAAQ,EAAE,MAAM,KAAK,CAAC,OAAO,CAAC,GAAG,SAAS,EAC1C,QAAQ,EAAE,MAAM,eAAe,EAC/B,yBAAyB,EAAE,MAAM,KAAK,CAAC,wBAAwB,CAAC,EAChE,eAAe,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,GAAG,SAAS,GAC3E,aAAa,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,CAqD9C"}
+{"version":3,"file":"createMessageLintReportsQuery.d.ts","sourceRoot":"","sources":["../src/createMessageLintReportsQuery.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACX,aAAa,EACb,wBAAwB,EAExB,eAAe,EACf,MAAM,UAAU,CAAA;AACjB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAC/D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAOhE;;GAEG;AACH,wBAAgB,6BAA6B,CAC5C,aAAa,EAAE,eAAe,EAC9B,QAAQ,EAAE,MAAM,eAAe,EAC/B,yBAAyB,EAAE,MAAM,KAAK,CAAC,wBAAwB,CAAC,EAChE,eAAe,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,GAAG,SAAS,EAC7E,UAAU,EAAE,OAAO,GACjB,aAAa,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,CA2E9C"}

package/dist/createMessageLintReportsQuery.js

@@ -1,33 +1,54 @@
-import { createEffect } from "./reactivity/solid.js";
 import { createSubscribable } from "./loadProject.js";
 import { lintSingleMessage } from "./lint/index.js";
 import { ReactiveMap } from "./reactivity/map.js";
+import { debounce } from "throttle-debounce";
+import { createEffect } from "./reactivity/solid.js";
 /**
  * Creates a reactive query API for messages.
  */
-export function createMessageLintReportsQuery(messages, settings, installedMessageLintRules, resolvedModules) {
+export function createMessageLintReportsQuery(messagesQuery, settings, installedMessageLintRules, resolvedModules, hasWatcher) {
     // @ts-expect-error
     const index = new ReactiveMap();
+    const modules = resolvedModules();
+    const rulesArray = modules?.messageLintRules;
+    const messageLintRuleLevels = Object.fromEntries(installedMessageLintRules().map((rule) => [rule.id, rule.level]));
+    const settingsObject = () => {
+        return {
+            ...settings(),
+            messageLintRuleLevels,
+        };
+    };
+    const messages = messagesQuery.getAll();
     createEffect(() => {
-        const modules = resolvedModules();
-        const _messages = messages();
-        const _settings = settings();
-        if (_messages && _settings && modules) {
-            // index.clear()
-            for (const message of _messages) {
-                // TODO: only lint changed messages and update arrays selectively
-                lintSingleMessage({
-                    rules: modules.messageLintRules,
-                    settings: {
-                        ..._settings,
-                        messageLintRuleLevels: Object.fromEntries(installedMessageLintRules().map((rule) => [rule.id, rule.level])),
-                    },
-                    messages: _messages,
-                    message: message,
-                }).then((report) => {
-                    if (report.errors.length === 0 &&
-                        JSON.stringify(index.get(message.id)) !== JSON.stringify(report.data)) {
-                        index.set(message.id, report.data || []);
+        if (rulesArray) {
+            for (const messageId of messagesQuery.includedMessageIds()) {
+                createEffect(() => {
+                    const message = messagesQuery.get({ where: { id: messageId } });
+                    if (hasWatcher) {
+                        lintSingleMessage({
+                            rules: rulesArray,
+                            settings: settingsObject(),
+                            messages: messages,
+                            message: message,
+                        }).then((report) => {
+                            if (report.errors.length === 0 && index.get(messageId) !== report.data) {
+                                index.set(messageId, report.data);
+                            }
+                        });
+                    }
+                    else {
+                        debounce(500, (message) => {
+                            lintSingleMessage({
+                                rules: rulesArray,
+                                settings: settingsObject(),
+                                messages: messages,
+                                message: message,
+                            }).then((report) => {
+                                if (report.errors.length === 0 && index.get(messageId) !== report.data) {
+                                    index.set(messageId, report.data);
+                                }
+                            });
+                        }, { atBegin: false })(message);
                     }
                 });
             }

package/dist/createNodeishFsWithAbsolutePaths.d.ts

@@ -3,10 +3,10 @@ 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.
+ * The paths are resolved from the `projectPath` argument.
  */
 export declare const createNodeishFsWithAbsolutePaths: (args: {
-    settingsFilePath: string;
+    projectPath: string;
     nodeishFs: NodeishFilesystemSubset;
 }) => NodeishFilesystemSubset;
 //# sourceMappingURL=createNodeishFsWithAbsolutePaths.d.ts.map

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,uBA6BH,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,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,uBAAuB,CAAA;CAClC,KAAG,uBA6BH,CAAA"}

package/dist/createNodeishFsWithAbsolutePaths.js

@@ -4,15 +4,15 @@ import { isAbsolutePath } from "./isAbsolutePath.js";
  * Wraps the nodeish filesystem subset with a function that intercepts paths
  * and prepends the base path.
  *
- * The paths are resolved from the `settingsFilePath` argument.
+ * The paths are resolved from the `projectPath` argument.
  */
 export const createNodeishFsWithAbsolutePaths = (args) => {
-    if (!isAbsolutePath(args.settingsFilePath)) {
-        throw new Error(`Expected an absolute path but received "${args.settingsFilePath}".`);
+    if (!isAbsolutePath(args.projectPath)) {
+        throw new Error(`Expected an absolute path but received "${args.projectPath}".`);
     }
     // get the base path of the settings file by
     // removing the file name from the path
-    const basePath = normalizePath(args.settingsFilePath).split("/").slice(0, -1).join("/");
+    const basePath = normalizePath(args.projectPath).split("/").slice(0, -1).join("/");
     const makeAbsolute = (path) => {
         if (isAbsolutePath(path)) {
             return normalizePath(path);

package/dist/createNodeishFsWithAbsolutePaths.test.js

@@ -1,11 +1,11 @@
 import { it, expect, vi } from "vitest";
 import { createNodeishFsWithAbsolutePaths } from "./createNodeishFsWithAbsolutePaths.js";
-it("throws an error if settingsFilePath is not an absolute path", () => {
+it("throws an error if projectPath is not an absolute path", () => {
     const relativePath = "relative/path";
-    expect(() => createNodeishFsWithAbsolutePaths({ settingsFilePath: relativePath, nodeishFs: {} })).toThrow();
+    expect(() => createNodeishFsWithAbsolutePaths({ projectPath: relativePath, nodeishFs: {} })).toThrow();
 });
 it("intercepts paths correctly for readFile", async () => {
-    const settingsFilePath = `/Users/samuel/Documents/paraglide/example/project.inlang.json`;
+    const projectPath = `/Users/samuel/Documents/paraglide/example/project.inlang`;
     const filePaths = [
         ["file.txt", `/Users/samuel/Documents/paraglide/example/file.txt`],
         ["./file.txt", `/Users/samuel/Documents/paraglide/example/file.txt`],
@@ -23,7 +23,7 @@ it("intercepts paths correctly for readFile", async () => {
         watch: vi.fn(),
     };
     const interceptedFs = createNodeishFsWithAbsolutePaths({
-        settingsFilePath,
+        projectPath,
         nodeishFs: mockNodeishFs,
     });
     for (const [path, expectedPath] of filePaths) {

package/dist/createNodeishFsWithWatcher.d.ts

@@ -3,7 +3,7 @@ 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.
+ * The paths are resolved from the `projectPath` argument.
  */
 export declare const createNodeishFsWithWatcher: (args: {
     nodeishFs: NodeishFilesystemSubset;

package/dist/createNodeishFsWithWatcher.d.ts.map

@@ -1 +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"}
+{"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,uBA8CH,CAAA"}

package/dist/createNodeishFsWithWatcher.js

@@ -2,7 +2,7 @@
  * Wraps the nodeish filesystem subset with a function that intercepts paths
  * and prepends the base path.
  *
- * The paths are resolved from the `settingsFilePath` argument.
+ * The paths are resolved from the `projectPath` argument.
  */
 export const createNodeishFsWithWatcher = (args) => {
     const pathList = [];
@@ -14,9 +14,11 @@ export const createNodeishFsWithWatcher = (args) => {
                     signal: abortController.signal,
                     persistent: false,
                 });
-                //eslint-disable-next-line @typescript-eslint/no-unused-vars
-                for await (const event of watcher) {
-                    args.updateMessages();
+                if (watcher) {
+                    //eslint-disable-next-line @typescript-eslint/no-unused-vars
+                    for await (const event of watcher) {
+                        args.updateMessages();
+                    }
                 }
             }
             catch (err) {

package/dist/generateProjectId.d.ts

@@ -0,0 +1,3 @@
+import type { Repository } from "@lix-js/client";
+export declare function generateProjectId(repo: Repository, projectPath: string): Promise<string | undefined>;
+//# sourceMappingURL=generateProjectId.d.ts.map

package/dist/generateProjectId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateProjectId.d.ts","sourceRoot":"","sources":["../src/generateProjectId.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAGhD,wBAAsB,iBAAiB,CAAC,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,+BAU5E"}

package/dist/generateProjectId.js

@@ -0,0 +1,11 @@
+import { hash } from "@lix-js/client";
+export async function generateProjectId(repo, projectPath) {
+    if (!repo || !projectPath) {
+        return undefined;
+    }
+    const repoMeta = await repo.getMeta();
+    if (repoMeta && !("error" in repoMeta)) {
+        return hash(`${repoMeta.id + projectPath}`);
+    }
+    return undefined;
+}

package/dist/generateProjectId.test.d.ts

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

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

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

package/dist/generateProjectId.test.js

@@ -0,0 +1,18 @@
+import { generateProjectId } from "./generateProjectId.js";
+import { describe, it, expect } from "vitest";
+import { openRepository } from "@lix-js/client/src/openRepository.ts";
+import { mockRepo, createNodeishMemoryFs } from "@lix-js/client";
+describe("generateProjectId", async () => {
+    const repo = await mockRepo();
+    it("should generate a project id", async () => {
+        const projectId = await generateProjectId(repo, "mocked_project_path");
+        expect(projectId).toBe("0c83325bf9068eb01091c522d4b8e3765aff42e36fc781c041b44439bbe3e734");
+    });
+    it("should return undefined if repoMeta contains error", async () => {
+        const errorRepo = await openRepository("https://github.com/inlang/no-exist", {
+            nodeishFs: createNodeishMemoryFs(),
+        });
+        const projectId = await generateProjectId(errorRepo, "mocked_project_path");
+        expect(projectId).toBeUndefined();
+    });
+});

package/dist/index.d.ts

@@ -6,6 +6,7 @@
 export type { InlangProject, InstalledMessageLintRule, InstalledPlugin, MessageQueryApi, Subscribable, } from "./api.js";
 export { type ImportFunction, createImport } from "./resolve-modules/index.js";
 export { loadProject } from "./loadProject.js";
+export { listProjects } from "./listProjects.js";
 export { solidAdapter, type InlangProjectWithSolidAdapter } from "./adapter/solidAdapter.js";
 export { createMessagesQuery } from "./createMessagesQuery.js";
 export { ProjectSettingsFileJSONSyntaxError, ProjectSettingsFileNotFoundError, ProjectSettingsInvalidError, PluginLoadMessagesError, PluginSaveMessagesError, } from "./errors.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,YAAY,EACX,aAAa,EACb,wBAAwB,EACxB,eAAe,EACf,eAAe,EACf,YAAY,GACZ,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,KAAK,cAAc,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AAC9E,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,YAAY,EAAE,KAAK,6BAA6B,EAAE,MAAM,2BAA2B,CAAA;AAC5F,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAC9D,OAAO,EACN,kCAAkC,EAClC,gCAAgC,EAChC,2BAA2B,EAC3B,uBAAuB,EACvB,uBAAuB,GACvB,MAAM,aAAa,CAAA;AAEpB,cAAc,uBAAuB,CAAA;AACrC,cAAc,0BAA0B,CAAA;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,YAAY,EACX,aAAa,EACb,wBAAwB,EACxB,eAAe,EACf,eAAe,EACf,YAAY,GACZ,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,KAAK,cAAc,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AAC9E,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,KAAK,6BAA6B,EAAE,MAAM,2BAA2B,CAAA;AAC5F,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAC9D,OAAO,EACN,kCAAkC,EAClC,gCAAgC,EAChC,2BAA2B,EAC3B,uBAAuB,EACvB,uBAAuB,GACvB,MAAM,aAAa,CAAA;AAEpB,cAAc,uBAAuB,CAAA;AACrC,cAAc,0BAA0B,CAAA;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA"}

package/dist/index.js

@@ -5,6 +5,7 @@
  */
 export { createImport } from "./resolve-modules/index.js";
 export { loadProject } from "./loadProject.js";
+export { listProjects } from "./listProjects.js";
 export { solidAdapter } from "./adapter/solidAdapter.js";
 export { createMessagesQuery } from "./createMessagesQuery.js";
 export { ProjectSettingsFileJSONSyntaxError, ProjectSettingsFileNotFoundError, ProjectSettingsInvalidError, PluginLoadMessagesError, PluginSaveMessagesError, } from "./errors.js";

package/dist/isAbsolutePath.test.js

@@ -8,7 +8,7 @@ describe("isAbsolutePath", () => {
     });
     it("should correctly identify Windows absolute paths", () => {
         assert.isTrue(isAbsolutePath("C:\\Users\\User\\Documents\\File.txt"));
-        assert.isTrue(isAbsolutePath("C:/Users/user/project/project.inlang.json"));
+        assert.isTrue(isAbsolutePath("C:/Users/user/project.inlang/settings.json"));
         assert.isFalse(isAbsolutePath("Projects\\Project1\\source\\file.txt"));
     });
     it("should handle edge cases", () => {

package/dist/listProjects.d.ts

@@ -0,0 +1,5 @@
+import type { NodeishFilesystem } from "@lix-js/fs";
+export declare const listProjects: (nodeishFs: NodeishFilesystem, from: string) => Promise<Array<{
+    projectPath: string;
+}>>;
+//# sourceMappingURL=listProjects.d.ts.map

package/dist/listProjects.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listProjects.d.ts","sourceRoot":"","sources":["../src/listProjects.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAEnD,eAAO,MAAM,YAAY,cACb,iBAAiB,QACtB,MAAM,KACV,QAAQ,MAAM;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC,CAiCxC,CAAA"}

package/dist/listProjects.js

@@ -0,0 +1,31 @@
+export const listProjects = async (nodeishFs, from) => {
+    // !TODO: Remove this limit once we introduce caching
+    const recursionLimit = 5;
+    const projects = [];
+    async function searchDir(path, depth) {
+        if (depth > recursionLimit) {
+            return;
+        }
+        const files = await nodeishFs.readdir(path);
+        for (const file of files) {
+            const filePath = `${path}/${file}`;
+            const stats = await nodeishFs.stat(filePath);
+            if (stats.isDirectory()) {
+                if (file === "node_modules")
+                    continue;
+                if (file.endsWith(".inlang")) {
+                    projects.push({ projectPath: filePath });
+                }
+                else {
+                    await searchDir(filePath, depth + 1);
+                }
+            }
+        }
+    }
+    await searchDir(from, 0);
+    // remove double slashes
+    for (const project of projects) {
+        project.projectPath = project.projectPath.replace(/\/\//g, "/");
+    }
+    return projects;
+};

package/dist/listProjects.test.d.ts

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

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

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

package/dist/listProjects.test.js

@@ -0,0 +1,56 @@
+import { assert, describe, it } from "vitest";
+import { listProjects } from "./listProjects.js";
+import { createNodeishMemoryFs } from "@lix-js/fs";
+const settings = {
+    sourceLanguageTag: "en",
+    languageTags: ["en"],
+    modules: ["plugin.js", "lintRule.js"],
+    messageLintRuleLevels: {
+        "messageLintRule.project.missingTranslation": "error",
+    },
+    "plugin.project.i18next": {
+        pathPattern: "./examples/example01/{languageTag}.json",
+        variableReferencePattern: ["{", "}"],
+    },
+};
+describe("listProjects", () => {
+    it("should find all projects a given path", async () => {
+        const fs = createNodeishMemoryFs();
+        await fs.mkdir("/user/dir1/project.inlang", { recursive: true });
+        await fs.writeFile("/user/dir1/project.inlang/settings.json", JSON.stringify(settings));
+        await fs.mkdir("/user/dir2/project.inlang", { recursive: true });
+        await fs.writeFile("/user/dir2/project.inlang/settings.json", JSON.stringify(settings));
+        await listProjects(fs, "/user").then((projects) => {
+            assert(projects.length === 2);
+        });
+    });
+    it("should return objects inside of an array with the projectPath", async () => {
+        const fs = createNodeishMemoryFs();
+        await fs.mkdir("/user/dir1/project.inlang", { recursive: true });
+        await fs.writeFile("/user/dir1/project.inlang/settings.json", JSON.stringify(settings));
+        await fs.mkdir("/user/dir2/project.inlang", { recursive: true });
+        await fs.writeFile("/user/dir2/project.inlang/settings.json", JSON.stringify(settings));
+        await listProjects(fs, "/user").then((projects) => {
+            assert.isTrue(typeof projects[0] === "object");
+            assert.isTrue(typeof projects[0]?.projectPath === "string");
+        });
+    });
+    it("should limit the recursion depth to 5", async () => {
+        const fs = createNodeishMemoryFs();
+        await fs.mkdir("/user/dir1/dir2/dir3/dir4/dir5/dir6/project.inlang", { recursive: true });
+        await fs.writeFile("/user/dir1/dir2/dir3/dir4/dir5/dir6/project.inlang/settings.json", JSON.stringify(settings));
+        await listProjects(fs, "/user").then((projects) => {
+            assert(projects.length === 0);
+        });
+    });
+    it("should also find files inside of a dir that ends with *.inlang", async () => {
+        const fs = createNodeishMemoryFs();
+        await fs.mkdir("/user/dir1/go.inlang", { recursive: true });
+        await fs.writeFile("/user/dir1/go.inlang/settings.json", JSON.stringify(settings));
+        await fs.mkdir("/user/dir2/flutter.inlang", { recursive: true });
+        await fs.writeFile("/user/dir2/flutter.inlang/settings.json", JSON.stringify(settings));
+        await listProjects(fs, "/user").then((projects) => {
+            assert(projects.length === 2);
+        });
+    });
+});

package/dist/loadProject.d.ts

@@ -1,10 +1,11 @@
 import type { InlangProject, Subscribable } from "./api.js";
 import { type ImportFunction } from "./resolve-modules/index.js";
-import { type NodeishFilesystemSubset } from "./versionedInterfaces.js";
+import { type NodeishFilesystem } from "@lix-js/fs";
+import type { Repository } from "@lix-js/client";
 /**
  * Creates an inlang instance.
  *
- * @param settingsFilePath - Absolute path to the inlang settings file.
+ * @param projectPath - 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.
@@ -12,8 +13,9 @@ import { type NodeishFilesystemSubset } from "./versionedInterfaces.js";
  *
  */
 export declare const loadProject: (args: {
-    settingsFilePath: string;
-    nodeishFs: NodeishFilesystemSubset;
+    projectPath: string;
+    repo?: Repository | undefined;
+    nodeishFs: NodeishFilesystem;
     _import?: ImportFunction | undefined;
     _capture?: ((id: string, props: Record<string, unknown>) => void) | undefined;
 }) => Promise<InlangProject>;

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;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"}
+{"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;AAkBhF,OAAO,EAAiB,KAAK,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAIlE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAKhD;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW;iBACV,MAAM;;eAER,iBAAiB;;qBAEZ,MAAM,SAAS,OAAO,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI;MAC5D,QAAQ,aAAa,CAkQxB,CAAA;AAwHD,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAQtE"}