@inlang/sdk 0.3.0 → 0.5.0

package/dist/resolve-modules/resolveModules.test.js

@@ -2,18 +2,17 @@ import { expect, it } from "vitest";
 import { ModuleError, ModuleExportIsInvalidError, ModuleHasNoExportsError, ModuleImportError, } from "./errors.js";
 import { resolveModules } from "./resolveModules.js";
 it("should return an error if a plugin cannot be imported", async () => {
-    const config = {
+    const settings = {
         sourceLanguageTag: "en",
         languageTags: ["de", "en"],
         modules: ["https://myplugin.com/index.js"],
-        settings: {},
     };
     const resolved = await resolveModules({
-        config,
+        settings,
         nodeishFs: {},
         _import: () => {
             throw new ModuleImportError("Could not import", {
-                module: config.modules[0],
+                module: settings.modules[0],
                 cause: new Error("Could not import"),
             });
         },
@@ -23,11 +22,9 @@ it("should return an error if a plugin cannot be imported", async () => {
 it("should resolve plugins and message lint rules successfully", async () => {
     // Define mock data
     const mockPlugin = {
-        meta: {
-            id: "plugin.namespace.mock",
-            description: { en: "Mock plugin description" },
-            displayName: { en: "Mock Plugin" },
-        },
+        id: "plugin.namespace.mock",
+        description: { en: "Mock plugin description" },
+        displayName: { en: "Mock Plugin" },
         loadMessages: () => undefined,
         saveMessages: () => undefined,
         addCustomApi: () => ({
@@ -37,18 +34,15 @@ it("should resolve plugins and message lint rules successfully", async () => {
         }),
     };
     const mockMessageLintRule = {
-        meta: {
-            id: "messageLintRule.namespace.mock",
-            description: { en: "Mock lint rule description" },
-            displayName: { en: "Mock Lint Rule" },
-        },
-        message: () => undefined,
+        id: "messageLintRule.namespace.mock",
+        description: { en: "Mock lint rule description" },
+        displayName: { en: "Mock Lint Rule" },
+        run: () => undefined,
     };
-    const config = {
+    const settings = {
         sourceLanguageTag: "en",
         languageTags: ["de", "en"],
         modules: ["lint-rule.js", "plugin.js"],
-        settings: {},
     };
     const _import = async (name) => {
         if (name === "lint-rule.js") {
@@ -63,81 +57,73 @@ it("should resolve plugins and message lint rules successfully", async () => {
         }
     };
     // Call the function
-    const resolved = await resolveModules({ config, _import, nodeishFs: {} });
+    const resolved = await resolveModules({ settings, _import, nodeishFs: {} });
     // Assert results
     expect(resolved.errors).toHaveLength(0);
     // Check for the meta data of the plugin
-    expect(resolved.plugins.some((module) => module.meta.id === mockPlugin.meta.id)).toBeDefined();
+    expect(resolved.plugins.some((module) => module.id === mockPlugin.id)).toBeDefined();
     // Check for the app specific api
     expect(resolved.resolvedPluginApi["customApi"]?.["app.inlang.ideExtension"]).toBeDefined();
     // Check for the lint rule
-    expect(resolved.messageLintRules[0]?.meta.id).toBe(mockMessageLintRule.meta.id);
+    expect(resolved.messageLintRules[0]?.id).toBe(mockMessageLintRule.id);
 });
 it("should return an error if a module cannot be imported", async () => {
-    const config = {
+    const settings = {
         sourceLanguageTag: "en",
         languageTags: ["de", "en"],
         modules: ["https://myplugin.com/index.js"],
-        settings: {},
     };
     const _import = async () => {
         throw new ModuleImportError("Could not import", {
-            module: config.modules[0],
+            module: settings.modules[0],
             cause: new Error(),
         });
     };
     // Call the function
-    const resolved = await resolveModules({ config, _import, nodeishFs: {} });
+    const resolved = await resolveModules({ settings, _import, nodeishFs: {} });
     // Assert results
     expect(resolved.errors[0]).toBeInstanceOf(ModuleImportError);
 });
-it("should return an error if a module does not export any plugins or lint rules", async () => {
-    const config = {
+it("should return an error if a module does not export anything", async () => {
+    const settings = {
         sourceLanguageTag: "en",
         languageTags: ["de", "en"],
         modules: ["https://myplugin.com/index.js"],
-        settings: {},
     };
-    const _import = async () => ({
-        default: {},
-    });
+    const _import = async () => ({});
     // Call the function
-    const resolved = await resolveModules({ config, _import, nodeishFs: {} });
+    const resolved = await resolveModules({ settings, _import, nodeishFs: {} });
     // Assert results
     expect(resolved.errors[0]).toBeInstanceOf(ModuleHasNoExportsError);
 });
 it("should return an error if a module exports an invalid plugin or lint rule", async () => {
-    const config = {
+    const settings = {
         sourceLanguageTag: "en",
         languageTags: ["de", "en"],
         modules: ["https://myplugin.com/index.js"],
-        settings: {},
     };
     const _import = async () => ({
+        // @ts-expect-error - invalid meta of a plugin
         default: {
-            // @ts-expect-error - invalid meta of a plugin
-            meta: {
-                id: "plugin.namespace.mock",
-                description: { en: "Mock plugin description" },
-            },
+            id: "plugin.namespace.mock",
+            description: { en: "Mock plugin description" },
         },
     });
-    const resolved = await resolveModules({ config, _import, nodeishFs: {} });
+    const resolved = await resolveModules({ settings, _import, nodeishFs: {} });
     expect(resolved.errors[0]).toBeInstanceOf(ModuleExportIsInvalidError);
 });
 it("should handle other unhandled errors during plugin resolution", async () => {
     const errorMessage = "Unhandled error during plugin resolution";
-    const config = {
+    const settings = {
         sourceLanguageTag: "en",
         languageTags: ["de", "en"],
         modules: ["https://myplugin.com/index.js"],
-        settings: {},
     };
     const _import = async () => {
         throw new Error(errorMessage);
     };
     // Call the function
-    const resolved = await resolveModules({ config, _import, nodeishFs: {} });
+    const resolved = await resolveModules({ settings, _import, nodeishFs: {} });
     // Assert results
     expect(resolved.errors[0]).toBeInstanceOf(ModuleError);
 });

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

@@ -1,4 +1,4 @@
-import type { ProjectConfig } from "@inlang/project-config";
+import type { ProjectSettings } from "@inlang/project-settings";
 import type { MessageLintRule } from "@inlang/message-lint-rule";
 import type { Plugin } from "@inlang/plugin";
 import type { NodeishFilesystemSubset, ResolvePluginsFunction, ResolvedPluginApi } from "./plugins/types.js";
@@ -11,7 +11,7 @@ import type { resolveMessageLintRules } from "./message-lint-rules/resolveMessag
  * Pass a custom `_import` function to override the default import function.
  */
 export type ResolveModuleFunction = (args: {
-    config: ProjectConfig;
+    settings: ProjectSettings;
     nodeishFs: NodeishFilesystemSubset;
     _import?: ImportFunction;
 }) => Promise<{
@@ -34,7 +34,7 @@ export type ResolveModuleFunction = (args: {
         /**
          * The resolved item id of the module.
          */
-        id: Plugin["meta"]["id"] | MessageLintRule["meta"]["id"];
+        id: Plugin["id"] | MessageLintRule["id"];
     }>;
     /**
      * The resolved plugins.

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/resolve-modules/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EACX,uBAAuB,EACvB,sBAAsB,EACtB,iBAAiB,EACjB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAC7E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,iDAAiD,CAAA;AAE9F;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,IAAI,EAAE;IAC1C,MAAM,EAAE,aAAa,CAAA;IACrB,SAAS,EAAE,uBAAuB,CAAA;IAClC,OAAO,CAAC,EAAE,cAAc,CAAA;CACxB,KAAK,OAAO,CAAC;IACb;;;;;;;;OAQG;IACH,IAAI,EAAE,KAAK,CAAC;QACX;;;;WAIG;QACH,MAAM,EAAE,MAAM,CAAA;QACd;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAA;KACxD,CAAC,CAAA;IACF;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IACtB;;OAEG;IACH,gBAAgB,EAAE,KAAK,CAAC,eAAe,CAAC,CAAA;IACxC;;OAEG;IACH,iBAAiB,EAAE,iBAAiB,CAAA;IACpC;;;;;;;;OAQG;IACH,MAAM,EAAE,KAAK,CACV,uBAAuB,GACvB,iBAAiB,GACjB,OAAO,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,GAC7D,OAAO,CAAC,UAAU,CAAC,OAAO,uBAAuB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CACvE,CAAA;CACD,CAAC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/resolve-modules/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EACX,uBAAuB,EACvB,sBAAsB,EACtB,iBAAiB,EACjB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAC7E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,iDAAiD,CAAA;AAE9F;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,IAAI,EAAE;IAC1C,QAAQ,EAAE,eAAe,CAAA;IACzB,SAAS,EAAE,uBAAuB,CAAA;IAClC,OAAO,CAAC,EAAE,cAAc,CAAA;CACxB,KAAK,OAAO,CAAC;IACb;;;;;;;;OAQG;IACH,IAAI,EAAE,KAAK,CAAC;QACX;;;;WAIG;QACH,MAAM,EAAE,MAAM,CAAA;QACd;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,IAAI,CAAC,CAAA;KACxC,CAAC,CAAA;IACF;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IACtB;;OAEG;IACH,gBAAgB,EAAE,KAAK,CAAC,eAAe,CAAC,CAAA;IACxC;;OAEG;IACH,iBAAiB,EAAE,iBAAiB,CAAA;IACpC;;;;;;;;OAQG;IACH,MAAM,EAAE,KAAK,CACV,uBAAuB,GACvB,iBAAiB,GACjB,OAAO,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,GAC7D,OAAO,CAAC,UAAU,CAAC,OAAO,uBAAuB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CACvE,CAAA;CACD,CAAC,CAAA"}

package/dist/versionedInterfaces.d.ts

@@ -3,6 +3,6 @@ export * from "@inlang/language-tag";
 export * from "@inlang/message-lint-rule";
 export * from "@inlang/message";
 export * from "@inlang/plugin";
-export * from "@inlang/project-config";
+export * from "@inlang/project-settings";
 export * from "@inlang/translatable";
 //# sourceMappingURL=versionedInterfaces.d.ts.map

package/dist/versionedInterfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"versionedInterfaces.d.ts","sourceRoot":"","sources":["../src/versionedInterfaces.ts"],"names":[],"mappings":"AAEA,cAAc,oBAAoB,CAAA;AAClC,cAAc,sBAAsB,CAAA;AACpC,cAAc,2BAA2B,CAAA;AACzC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,wBAAwB,CAAA;AACtC,cAAc,sBAAsB,CAAA"}
+{"version":3,"file":"versionedInterfaces.d.ts","sourceRoot":"","sources":["../src/versionedInterfaces.ts"],"names":[],"mappings":"AAEA,cAAc,oBAAoB,CAAA;AAClC,cAAc,sBAAsB,CAAA;AACpC,cAAc,2BAA2B,CAAA;AACzC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,0BAA0B,CAAA;AACxC,cAAc,sBAAsB,CAAA"}

package/dist/versionedInterfaces.js

@@ -4,5 +4,5 @@ export * from "@inlang/language-tag";
 export * from "@inlang/message-lint-rule";
 export * from "@inlang/message";
 export * from "@inlang/plugin";
-export * from "@inlang/project-config";
+export * from "@inlang/project-settings";
 export * from "@inlang/translatable";

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@inlang/sdk",
 	"type": "module",
-	"version": "0.3.0",
+	"version": "0.5.0",
 	"license": "Apache-2.0",
 	"publishConfig": {
 		"access": "public"
@@ -35,14 +35,14 @@
 		"@inlang/language-tag": "*",
 		"@inlang/message": "*",
 		"@inlang/plugin": "*",
-		"@inlang/project-config": "*",
+		"@inlang/project-settings": "*",
 		"@inlang/result": "*",
 		"@lix-js/fs": "*",
 		"@sinclair/typebox": "^0.31.0",
 		"deepmerge-ts": "^5.1.0",
 		"solid-js": "1.6.12",
 		"throttle-debounce": "5.0.0",
-		"ts-dedent": "2.2.0"
+		"dedent": "1.5.1"
 	},
 	"devDependencies": {
 		"@lix-js/fs": "*",

package/src/adapter/solidAdapter.test.ts

@@ -3,11 +3,11 @@ import { describe, it, expect } from "vitest"
 import type { ImportFunction } from "../resolve-modules/index.js"
 import { createEffect, from, createRoot } from "../reactivity/solid.js"
 import { solidAdapter } from "./solidAdapter.js"
-import { openInlangProject } from "../openInlangProject.js"
+import { loadProject } from "../loadProject.js"
 import { createNodeishMemoryFs } from "@lix-js/fs"
 import type {
 	Message,
-	ProjectConfig,
+	ProjectSettings,
 	Plugin,
 	MessageLintRule,
 	Text,
@@ -15,27 +15,23 @@ import type {
 
 // ------------------------------------------------------------------------------------------------
 
-const config: ProjectConfig = {
+const config: ProjectSettings = {
 	sourceLanguageTag: "en",
 	languageTags: ["en"],
 	modules: ["plugin.js", "plugin2.js"],
-	settings: {
-		"project.messageLintRuleLevels": {
-			"messageLintRule.inlang.missingTranslation": "error",
-		},
-		"plugin.inlang.i18next": {
-			pathPattern: "./examples/example01/{languageTag}.json",
-			variableReferencePattern: ["{", "}"],
-		},
+	messageLintRuleLevels: {
+		"messageLintRule.project.missingTranslation": "error",
+	},
+	"plugin.project.i18next": {
+		pathPattern: "./examples/example01/{languageTag}.json",
+		variableReferencePattern: ["{", "}"],
 	},
 }
 
 const mockPlugin: Plugin = {
-	meta: {
-		id: "plugin.inlang.i18next",
-		description: { en: "Mock plugin description" },
-		displayName: { en: "Mock Plugin" },
-	},
+	id: "plugin.project.i18next",
+	description: { en: "Mock plugin description" },
+	displayName: { en: "Mock Plugin" },
 	loadMessages: () => exampleMessages,
 	saveMessages: () => undefined,
 }
@@ -77,12 +73,10 @@ const exampleMessages: Message[] = [
 ]
 
 const mockLintRule: MessageLintRule = {
-	meta: {
-		id: "messageLintRule.namespace.mock",
-		description: { en: "Mock lint rule description" },
-		displayName: { en: "Mock Lint Rule" },
-	},
-	message: () => undefined,
+	id: "messageLintRule.namespace.mock",
+	description: { en: "Mock lint rule description" },
+	displayName: { en: "Mock Lint Rule" },
+	run: () => undefined,
 }
 
 const $import: ImportFunction = async (name) => ({
@@ -95,9 +89,9 @@ describe("config", () => {
 	it("should react to changes in config", async () => {
 		const fs = createNodeishMemoryFs()
 		await fs.writeFile("./project.inlang.json", JSON.stringify(config))
-		const inlang = solidAdapter(
-			await openInlangProject({
-				projectFilePath: "./project.inlang.json",
+		const project = solidAdapter(
+			await loadProject({
+				settingsFilePath: "./project.inlang.json",
 				nodeishFs: fs,
 				_import: $import,
 			}),
@@ -106,18 +100,18 @@ describe("config", () => {
 
 		let counter = 0
 		createEffect(() => {
-			inlang.config()
+			project.settings()
 			counter += 1
 		})
 
 		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-		const newConfig = { ...inlang.config()!, languageTags: ["en", "de"] }
+		const newConfig = { ...project.settings()!, languageTags: ["en", "de"] }
 
-		inlang.setConfig(newConfig)
+		project.setSettings(newConfig)
 		// TODO: how can we await `setConfig` correctly
 		await new Promise((resolve) => setTimeout(resolve, 0))
 		expect(counter).toBe(2) // 2 times because effect creation + set
-		expect(inlang.config()).toStrictEqual(newConfig)
+		expect(project.settings()).toStrictEqual(newConfig)
 	})
 })
 
@@ -125,9 +119,9 @@ 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))
-		const inlang = solidAdapter(
-			await openInlangProject({
-				projectFilePath: "./project.inlang.json",
+		const project = solidAdapter(
+			await loadProject({
+				settingsFilePath: "./project.inlang.json",
 				nodeishFs: fs,
 				_import: $import,
 			}),
@@ -137,16 +131,16 @@ describe("installed", () => {
 		let counterLint = 0
 
 		createEffect(() => {
-			inlang.installed.plugins()
+			project.installed.plugins()
 			counterPlugins += 1
 		})
 
 		createEffect(() => {
-			inlang.installed.messageLintRules()
+			project.installed.messageLintRules()
 			counterLint += 1
 		})
 
-		inlang.setConfig({ ...inlang.config()!, languageTags: ["en", "fr"] })
+		project.setSettings({ ...project.settings()!, languageTags: ["en", "fr"] })
 
 		// TODO: how can we await `setConfig` correctly
 		await new Promise((resolve) => setTimeout(resolve, 0))
@@ -159,31 +153,27 @@ describe("installed", () => {
 describe("messages", () => {
 	it("should react to changes in config", async () => {
 		const fs = createNodeishMemoryFs()
-		const mockConfig: ProjectConfig = {
+		const mockConfig: ProjectSettings = {
 			sourceLanguageTag: "en",
 			languageTags: ["en", "de"],
 			modules: ["./plugin-a.js"],
-			settings: {
-				"library.inlang.paraglideJsSveltekit": {
-					languageNegotiation: {
-						strategies: [
-							{
-								type: "localStorage",
-							} as any,
-						],
-					},
+			"library.project.paraglideJsSveltekit": {
+				languageNegotiation: {
+					strategies: [
+						{
+							type: "localStorage",
+						} as any,
+					],
 				},
 			},
 		}
 		const mockPlugin: Plugin = {
-			meta: {
-				id: "plugin.mock.id",
-				displayName: {
-					en: "hello",
-				},
-				description: {
-					en: "wo",
-				},
+			id: "plugin.mock.id",
+			displayName: {
+				en: "hello",
+			},
+			description: {
+				en: "wo",
 			},
 			loadMessages: ({ languageTags }) => (languageTags.length ? exampleMessages : []),
 			saveMessages: () => undefined,
@@ -192,9 +182,9 @@ describe("messages", () => {
 		const mockImport: ImportFunction = async () => ({ default: mockPlugin })
 
 		await fs.writeFile("./project.inlang.json", JSON.stringify(mockConfig))
-		const inlang = solidAdapter(
-			await openInlangProject({
-				projectFilePath: "./project.inlang.json",
+		const project = solidAdapter(
+			await loadProject({
+				settingsFilePath: "./project.inlang.json",
 				nodeishFs: fs,
 				_import: mockImport,
 			}),
@@ -203,27 +193,27 @@ describe("messages", () => {
 
 		let counter = 0
 		createEffect(() => {
-			inlang.query.messages.getAll()
+			project.query.messages.getAll()
 			counter += 1
 		})
 
-		expect(Object.values(inlang.query.messages.getAll()).length).toBe(2)
+		expect(Object.values(project.query.messages.getAll()).length).toBe(2)
 
-		inlang.setConfig({ ...inlang.config()!, languageTags: [] })
+		project.setSettings({ ...project.settings()!, languageTags: [] })
 
 		// TODO: how can we await `setConfig` correctly
 		await new Promise((resolve) => setTimeout(resolve, 0))
 
 		expect(counter).toBe(2) // 2 times because effect creation + set
-		expect(Object.values(inlang.query.messages.getAll()).length).toBe(0)
+		expect(Object.values(project.query.messages.getAll()).length).toBe(0)
 	})
 
 	it("should react to changes in messages", async () => {
 		const fs = createNodeishMemoryFs()
 		await fs.writeFile("./project.inlang.json", JSON.stringify(config))
-		const inlang = solidAdapter(
-			await openInlangProject({
-				projectFilePath: "./project.inlang.json",
+		const project = solidAdapter(
+			await loadProject({
+				settingsFilePath: "./project.inlang.json",
 				nodeishFs: fs,
 				_import: $import,
 			}),
@@ -232,11 +222,11 @@ describe("messages", () => {
 
 		let counter = 0
 		createEffect(() => {
-			inlang.query.messages.getAll()
+			project.query.messages.getAll()
 			counter += 1
 		})
 
-		const messagesBefore = inlang.query.messages.getAll
+		const messagesBefore = project.query.messages.getAll
 		expect(Object.values(messagesBefore()).length).toBe(2)
 		expect(
 			(
@@ -245,7 +235,7 @@ describe("messages", () => {
 			).value,
 		).toBe("test")
 
-		inlang.query.messages.update({
+		project.query.messages.update({
 			where: { id: "a" },
 			// TODO: use `createMessage` utility
 			data: {
@@ -266,7 +256,7 @@ describe("messages", () => {
 		})
 
 		expect(counter).toBe(2) // 2 times because effect creation + set
-		const messagesAfter = inlang.query.messages.getAll
+		const messagesAfter = project.query.messages.getAll
 		expect(Object.values(messagesAfter()).length).toBe(2)
 		expect(
 			(
@@ -281,10 +271,10 @@ describe("lint", () => {
 	it.todo("should react to changes in config", async () => {
 		await createRoot(async () => {
 			const fs = createNodeishMemoryFs()
-			await fs.writeFile("./inlang.config.json", JSON.stringify(config))
-			const inlang = solidAdapter(
-				await openInlangProject({
-					projectFilePath: "./inlang.config.json",
+			await fs.writeFile("./project.config.json", JSON.stringify(config))
+			const project = solidAdapter(
+				await loadProject({
+					settingsFilePath: "./project.config.json",
 					nodeishFs: fs,
 					_import: $import,
 				}),
@@ -293,23 +283,23 @@ describe("lint", () => {
 
 			let counter = 0
 			createEffect(() => {
-				inlang.query.messageLintReports.getAll()
+				project.query.messageLintReports.getAll()
 				counter += 1
 			})
 
-			const newConfig = { ...inlang.config()!, languageTags: ["en", "de"] }
-			inlang.setConfig(newConfig)
+			const newConfig = { ...project.settings()!, languageTags: ["en", "de"] }
+			project.setSettings(newConfig)
 
 			expect(counter).toBe(1)
-			expect(inlang.query.messageLintReports.getAll()).toEqual([])
+			expect(project.query.messageLintReports.getAll()).toEqual([])
 
 			await new Promise((resolve) => setTimeout(resolve, 510))
 
-			const newConfig2 = { ...inlang.config()!, languageTags: ["en", "de", "fr"] }
-			inlang.setConfig(newConfig2)
+			const newConfig2 = { ...project.settings()!, languageTags: ["en", "de", "fr"] }
+			project.setSettings(newConfig2)
 
 			expect(counter).toBe(9)
-			expect(inlang.query.messageLintReports.getAll()).toEqual([])
+			expect(project.query.messageLintReports.getAll()).toEqual([])
 		})
 	})
 
@@ -319,10 +309,10 @@ describe("lint", () => {
 	it.todo("should react to changes to messages", async () => {
 		await createRoot(async () => {
 			const fs = createNodeishMemoryFs()
-			await fs.writeFile("./inlang.config.json", JSON.stringify(config))
-			const inlang = solidAdapter(
-				await openInlangProject({
-					projectFilePath: "./inlang.config.json",
+			await fs.writeFile("./project.config.json", JSON.stringify(config))
+			const project = solidAdapter(
+				await loadProject({
+					settingsFilePath: "./project.config.json",
 					nodeishFs: fs,
 					_import: $import,
 				}),
@@ -331,11 +321,11 @@ describe("lint", () => {
 
 			let counter = 0
 			createEffect(() => {
-				inlang.query.messageLintReports.getAll()
+				project.query.messageLintReports.getAll()
 				counter += 1
 			})
 
-			inlang.query.messages.update({
+			project.query.messages.update({
 				where: { id: "a" },
 				data: {
 					...exampleMessages[0],
@@ -344,11 +334,11 @@ describe("lint", () => {
 			})
 
 			expect(counter).toBe(1)
-			expect(inlang.query.messageLintReports.getAll()).toEqual([])
+			expect(project.query.messageLintReports.getAll()).toEqual([])
 
 			await new Promise((resolve) => setTimeout(resolve, 510))
 
-			inlang.query.messages.update({
+			project.query.messages.update({
 				where: { id: "a" },
 				data: {
 					...exampleMessages[0],
@@ -357,7 +347,7 @@ describe("lint", () => {
 			})
 
 			expect(counter).toBe(6)
-			expect(inlang.query.messageLintReports.getAll()).toEqual([])
+			expect(project.query.messageLintReports.getAll()).toEqual([])
 		})
 	})
 })

package/src/adapter/solidAdapter.ts

@@ -14,13 +14,13 @@ export const solidAdapter = (
 
 	return {
 		customApi: convert(project.customApi),
-		config: convert(project.config),
+		settings: convert(project.settings),
 		errors: convert(project.errors),
 		installed: {
 			messageLintRules: convert(project.installed.messageLintRules),
 			plugins: convert(project.installed.plugins),
 		},
-		setConfig: project.setConfig,
+		setSettings: project.setSettings,
 		query: {
 			messages: {
 				create: project.query.messages.create,
@@ -51,8 +51,8 @@ export type InlangProjectWithSolidAdapter = {
 		messageLintRules: () => ReturnType<InlangProject["installed"]["messageLintRules"]>
 	}
 	errors: () => ReturnType<InlangProject["errors"]>
-	config: () => ReturnType<InlangProject["config"]>
-	setConfig: InlangProject["setConfig"]
+	settings: () => ReturnType<InlangProject["settings"]>
+	setSettings: InlangProject["setSettings"]
 	query: {
 		messages: {
 			create: MessageQueryApi["create"]

package/src/api.test-d.ts

@@ -0,0 +1,8 @@
+import type { ProjectSettings } from "@inlang/project-settings"
+import type { InlangProject } from "./api.js"
+import { expectType } from "tsd"
+
+const project: InlangProject = {} as any
+
+// it should not have potentially undefined settings.
+expectType<ProjectSettings>(project.settings())