@inlang/sdk 0.17.0 → 0.19.0

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/dist/resolve-modules/validateModuleSettings.test.js

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 import { expect, test } from "vitest";
-import { Plugin, MessageLintRule } from "@inlang/sdk";
+import { Plugin, MessageLintRule } from "../index.js";
 // import { createNodeishMemoryFs } from "@lix-js/fs"
 import { Type } from "@sinclair/typebox";
 import { validatedModuleSettings } from "./validatedModuleSettings.js";

package/package.json

@@ -1,57 +1,57 @@
 {
-	"name": "@inlang/sdk",
-	"type": "module",
-	"version": "0.17.0",
-	"license": "Apache-2.0",
-	"publishConfig": {
-		"access": "public"
-	},
-	"exports": {
-		".": "./dist/index.js",
-		"./test-utilities": "./dist/test-utilities/index.js",
-		"./lint": "./dist/lint/index.js",
-		"./messages": "./dist/messages/index.js"
-	},
-	"files": [
-		"./dist",
-		"./src"
-	],
-	"scripts": {
-		"build": "tsc --build",
-		"dev": "tsc --watch",
-		"test": "tsc --noEmit && vitest run --passWithNoTests --coverage",
-		"lint": "eslint ./src --fix",
-		"format": "prettier ./src --write",
-		"clean": "rm -rf ./dist ./.turbo ./node_modules"
-	},
-	"engines": {
-		"node": ">=18.0.0"
-	},
-	"dependencies": {
-		"@inlang/json-types": "*",
-		"@inlang/translatable": "*",
-		"@inlang/message-lint-rule": "*",
-		"@inlang/module": "*",
-		"@inlang/language-tag": "*",
-		"@inlang/message": "*",
-		"@inlang/plugin": "*",
-		"@inlang/project-settings": "*",
-		"@inlang/result": "*",
-		"@lix-js/fs": "*",
-		"@sinclair/typebox": "^0.31.17",
-		"deepmerge-ts": "^5.1.0",
-		"solid-js": "1.6.12",
-		"throttle-debounce": "5.0.0",
-		"dedent": "1.5.1"
-	},
-	"devDependencies": {
-		"@lix-js/fs": "*",
-		"@types/throttle-debounce": "5.0.0",
-		"@vitest/coverage-v8": "^0.33.0",
-		"jsdom": "22.1.0",
-		"patch-package": "6.5.1",
-		"tsd": "^0.25.0",
-		"typescript": "5.2.2",
-		"vitest": "^0.33.0"
-	}
-}
+  "name": "@inlang/sdk",
+  "type": "module",
+  "version": "0.19.0",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./test-utilities": "./dist/test-utilities/index.js",
+    "./lint": "./dist/lint/index.js",
+    "./messages": "./dist/messages/index.js"
+  },
+  "files": [
+    "./dist",
+    "./src"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "@sinclair/typebox": "^0.31.17",
+    "deepmerge-ts": "^5.1.0",
+    "solid-js": "1.6.12",
+    "throttle-debounce": "5.0.0",
+    "dedent": "1.5.1",
+    "@inlang/json-types": "1.1.0",
+    "@inlang/message-lint-rule": "1.4.0",
+    "@inlang/translatable": "1.2.0",
+    "@inlang/module": "1.2.0",
+    "@inlang/language-tag": "1.2.0",
+    "@inlang/message": "2.0.0",
+    "@inlang/plugin": "2.4.0",
+    "@inlang/result": "1.1.0",
+    "@inlang/project-settings": "2.2.0",
+    "@lix-js/fs": "0.4.0"
+  },
+  "devDependencies": {
+    "@types/throttle-debounce": "5.0.0",
+    "@vitest/coverage-v8": "^0.33.0",
+    "jsdom": "22.1.0",
+    "patch-package": "6.5.1",
+    "tsd": "^0.25.0",
+    "typescript": "5.2.2",
+    "vitest": "^0.33.0",
+    "@lix-js/fs": "0.4.0"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "dev": "tsc --watch",
+    "test": "tsc --noEmit && vitest run --passWithNoTests --coverage",
+    "lint": "eslint ./src --fix",
+    "format": "prettier ./src --write",
+    "clean": "rm -rf ./dist ./node_modules"
+  }
+}

package/src/adapter/solidAdapter.test.ts

@@ -90,11 +90,11 @@ const $import: ImportFunction = 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,
 			}),
@@ -123,11 +123,11 @@ 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,
 			}),
@@ -188,11 +188,11 @@ describe("messages", () => {
 
 		const mockImport: ImportFunction = 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,
 			}),
@@ -218,11 +218,11 @@ 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,
 			}),
@@ -280,10 +280,11 @@ 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,
 				}),
@@ -321,7 +322,7 @@ describe("lint", () => {
 			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,
 				}),

package/src/createNodeishFsWithAbsolutePaths.test.ts

@@ -2,16 +2,16 @@ import { it, expect, vi } from "vitest"
 import { createNodeishFsWithAbsolutePaths } from "./createNodeishFsWithAbsolutePaths.js"
 import type { NodeishFilesystemSubset } from "./versionedInterfaces.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: {} as any })
+		createNodeishFsWithAbsolutePaths({ projectPath: relativePath, nodeishFs: {} as any })
 	).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`],
@@ -28,10 +28,11 @@ 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({
-		settingsFilePath,
+		projectPath,
 		nodeishFs: mockNodeishFs,
 	})
 

package/src/createNodeishFsWithAbsolutePaths.ts

@@ -6,19 +6,19 @@ 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: {
-	settingsFilePath: string
+	projectPath: string
 	nodeishFs: NodeishFilesystemSubset
 }): NodeishFilesystemSubset => {
-	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: string) => {
 		if (isAbsolutePath(path)) {
@@ -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,58 @@
+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 `projectPath` 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,
+				})
+				if (watcher) {
+					//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/isAbsolutePath.test.ts

@@ -10,7 +10,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"))
 	})