@x18n/lsp 0.0.14 → 0.0.15

package/dist/index.d.mts

@@ -95,6 +95,22 @@ export interface UsageReportResult {
     readonly locations: readonly Location[];
   }[];
 }
+export interface SearchParams {
+  /** Text of a value in any locale, ignoring case. */
+  readonly query: string;
+  /** Only values containing the query; by default a fuzzy match also counts. */
+  readonly exact?: boolean | undefined;
+}
+export interface SearchMatch {
+  readonly project: string;
+  readonly key: string;
+  /** The best-matching locale, source first on ties. */
+  readonly locale: string;
+  readonly value: string;
+  /** The entry holding the matched value. */
+  readonly definition: Location | undefined;
+  readonly usages: readonly Location[];
+}
 export interface Decoration {
   readonly range: Range;
   /** The whole call holding the key, when the scanner knows it. */
@@ -122,6 +138,42 @@ export interface TranslatePromptParams {
   readonly locale: string;
   readonly keys?: readonly string[] | undefined;
 }
+export interface ReviewsParams {
+  readonly project?: string | undefined;
+  readonly key?: string | undefined;
+  readonly locale?: string | undefined;
+  /** Only unresolved comments, and only threads that have some. */
+  readonly open?: boolean | undefined;
+}
+export interface ReviewCommentInfo {
+  readonly id: string;
+  readonly type: "comment" | "approve" | "request-change" | "suggestion";
+  readonly author?: {
+    readonly name?: string | undefined;
+    readonly email?: string | undefined;
+  } | undefined;
+  /** ISO 8601. */
+  readonly time: string;
+  readonly text?: string | undefined;
+  readonly suggestion?: string | undefined;
+  /** The value an approval approved. */
+  readonly value?: string | undefined;
+  readonly resolved?: boolean | undefined;
+  /** An approval of a value the message no longer has. */
+  readonly stale: boolean;
+}
+export interface ReviewThreadInfo {
+  readonly project: string;
+  readonly key: string;
+  readonly locale: string;
+  readonly state: "changes-requested" | "approved" | "stale-approval" | "suggested" | "commented" | undefined;
+  readonly comments: readonly ReviewCommentInfo[];
+  /** The key in the locale's resource; undefined while the locale lacks the message. */
+  readonly location: Location | undefined;
+}
+export interface ReviewsResult {
+  readonly threads: readonly ReviewThreadInfo[];
+}
 export interface ChangedParams {
   readonly project: string;
   readonly revision: number;
@@ -134,10 +186,13 @@ export interface Methods {
   readonly progress: "x18n/progress";
   readonly fileKeys: "x18n/fileKeys";
   readonly usageReport: "x18n/usageReport";
+  readonly search: "x18n/search";
   readonly decorations: "x18n/decorations";
   readonly setDisplayLocale: "x18n/setDisplayLocale";
   readonly openUi: "x18n/openUi";
   readonly translatePrompt: "x18n/translatePrompt";
+  readonly reviews: "x18n/reviews";
+  readonly explain: "x18n/explain";
   readonly changed: "x18n/changed";
 }
 export declare const methods: Methods;
@@ -149,6 +204,12 @@ export interface Commands {
   readonly extract: "x18n.extract";
   /** `{ uri: <folder> }` -> `{ files: { path, content }[], notes, removable }`; nothing is written. */
   readonly migrateI18nAlly: "x18n.migrateI18nAlly";
+  /** `{ project?, key, locale, review, text?, suggestion? }`: adds a review comment, written to disk at once. */
+  readonly review: "x18n.review";
+  /** `{ project?, id }` */
+  readonly resolveReview: "x18n.resolveReview";
+  /** `{ project?, id }`: sets the suggested value and resolves the suggestion. */
+  readonly applySuggestion: "x18n.applySuggestion";
 }
 export declare const commands: Commands;
 //#endregion
@@ -159,6 +220,8 @@ interface ServerProject {
   readonly root: string;
   readonly project: Project;
   readonly overlay: OverlayHost;
+  /** Absolute path of the config file, when there is one. */
+  readonly configFile?: string | undefined;
 }
 interface ServerOptions {
   /** Loads the projects of a workspace folder. Default: `@x18n/node` with an overlay host. */

package/dist/src.mjs

@@ -1,7 +1,7 @@
 import { relative, resolve, sep } from "node:path";
 import { fileURLToPath, pathToFileURL } from "node:url";
 import { extractItems, findCandidates } from "@x18n/builtins/extractors";
-import { createLineIndex, createOverlayHost, isX18nError, joinKey, renderPrompt, splitKey } from "@x18n/core";
+import { createLineIndex, createOverlayHost, isX18nError, joinKey, renderExplanation, renderPrompt, splitKey, toErrorInfo } from "@x18n/core";
 import { loadWorkspace, migrateI18nAlly } from "@x18n/node";
 import { CodeActionKind, CompletionItemKind, DiagnosticSeverity, DidChangeWatchedFilesNotification, FileChangeType, ResponseError, SymbolKind, TextDocumentSyncKind, TextDocuments } from "vscode-languageserver";
 import { TextDocument } from "vscode-languageserver-textdocument";
@@ -13,10 +13,13 @@ const methods = {
 	progress: "x18n/progress",
 	fileKeys: "x18n/fileKeys",
 	usageReport: "x18n/usageReport",
+	search: "x18n/search",
 	decorations: "x18n/decorations",
 	setDisplayLocale: "x18n/setDisplayLocale",
 	openUi: "x18n/openUi",
 	translatePrompt: "x18n/translatePrompt",
+	reviews: "x18n/reviews",
+	explain: "x18n/explain",
 	changed: "x18n/changed"
 };
 const commands = {
@@ -24,13 +27,22 @@ const commands = {
 	delete: "x18n.delete",
 	renamePrefix: "x18n.renamePrefix",
 	extract: "x18n.extract",
-	migrateI18nAlly: "x18n.migrateI18nAlly"
+	migrateI18nAlly: "x18n.migrateI18nAlly",
+	review: "x18n.review",
+	resolveReview: "x18n.resolveReview",
+	applySuggestion: "x18n.applySuggestion"
 };
 //#endregion
 //#region package.json
-var version = "0.0.14";
+var version = "0.0.15";
 //#endregion
 //#region src/server.ts
+const reviewTypes = [
+	"comment",
+	"approve",
+	"request-change",
+	"suggestion"
+];
 const severities = {
 	error: DiagnosticSeverity.Error,
 	warning: DiagnosticSeverity.Warning,
@@ -69,6 +81,8 @@ var Server = class {
 	options;
 	documents = new TextDocuments(TextDocument);
 	projects = [];
+	/** Workspace folders whose projects could not be loaded. */
+	failures = [];
 	published = /* @__PURE__ */ new Map();
 	timers = /* @__PURE__ */ new Map();
 	settings = {
@@ -145,22 +159,29 @@ var Server = class {
 				overlays.push(overlay);
 				return overlay;
 			};
-			(this.options.loadProjects ? await this.options.loadProjects(folder, wrap) : (await loadWorkspace({
+			(await (this.options.loadProjects ? this.options.loadProjects(folder, wrap) : loadWorkspace({
 				cwd: folder,
 				wrapHost: wrap
-			}).catch((error) => {
-				this.connection.window.showWarningMessage(`x18n: ${error instanceof Error ? error.message : String(error)}`);
-				return { projects: [] };
-			})).projects).forEach((item, i) => {
+			}).then((workspace) => workspace.projects)).catch((error) => {
+				const info = toErrorInfo(error);
+				this.failures.push({
+					folder,
+					error: info
+				});
+				this.connection.window.showWarningMessage(`x18n: ${info.why}`);
+				return [];
+			})).forEach((item, i) => {
 				const overlay = overlays[i];
 				if (overlay && !this.projects.some((p) => p.root === item.root)) this.projects.push({
 					name: item.name,
 					root: item.root,
 					project: item.project,
-					overlay
+					overlay,
+					configFile: item.configFile
 				});
 			});
 		}
+		if (this.projects.every((entry) => entry.project.resources.length === 0)) this.connection.console.info(`No locale files found in the workspace.\n\n${this.explain()}`);
 		for (const entry of this.projects) {
 			entry.project.onChange((change) => {
 				this.connection.sendNotification(methods.changed, {
@@ -416,6 +437,11 @@ var Server = class {
 				const flag = this.settings.showFlags ? project.localeInfo(locale).flag : void 0;
 				lines.push(`| ${flag ?? ""} ${locale} | ${value === void 0 ? "_missing_" : value === "" ? "_empty_" : value.replace(/\|/g, "\\|").replace(/\n/g, " ")} |${changed}`);
 			});
+			const threads = project.reviews({
+				key: target.key,
+				open: true
+			});
+			if (threads.length > 0) lines.push("", `**Reviews** ${threads.map((t) => `${t.locale}: ${t.state.replace("-", " ")}`).join(" · ")}`);
 		}
 		const usages = target.type === "subtree" ? project.usages({ prefix: target.key }) : project.usages({ key: target.key });
 		const args = encodeURIComponent(JSON.stringify([{
@@ -639,6 +665,7 @@ var Server = class {
 		const arg = params.arguments?.[0];
 		if (typeof arg !== "object" || arg === null) return null;
 		const input = arg;
+		if (params.command === commands.review || params.command === commands.resolveReview || params.command === commands.applySuggestion) return this.reviewCommand(params.command, input);
 		if (params.command === commands.extract && typeof input.uri === "string") return this.extractFile(input.uri);
 		if (params.command === commands.migrateI18nAlly && typeof input.uri === "string") return migrateI18nAlly(fileURLToPath(input.uri));
 		const entry = this.projects.find((p) => p.name === input.project) ?? this.projects[0];
@@ -666,6 +693,50 @@ var Server = class {
 		await this.connection.workspace.applyEdit(edit);
 		return edit;
 	}
+	/** Review commands write at once: a comment is not an edit to review in the editor. */
+	async reviewCommand(command, input) {
+		const entry = this.entryByName(input.project);
+		if (!entry) return null;
+		const { project } = entry;
+		const review = reviewTypes.find((type) => type === input.review);
+		let op;
+		if (command === commands.review && typeof input.key === "string" && typeof input.locale === "string" && review) op = {
+			type: "review",
+			key: project.parseKey(input.key),
+			locale: input.locale,
+			review,
+			text: typeof input.text === "string" ? input.text : void 0,
+			suggestion: typeof input.suggestion === "string" ? input.suggestion : void 0,
+			author: await project.reviewAuthor()
+		};
+		else if (typeof input.id === "string") op = command === commands.resolveReview ? {
+			type: "resolve-review",
+			id: input.id
+		} : {
+			type: "apply-suggestion",
+			id: input.id
+		};
+		if (!op) return null;
+		try {
+			return { revision: (await project.apply(this.plan(project, [op]))).revision };
+		} catch (error) {
+			throw isX18nError(error) ? new ResponseError(1, `${error.message}. ${error.fix}`) : error;
+		}
+	}
+	reviews(params) {
+		return { threads: (params.project === void 0 ? this.projects : this.projects.filter((p) => p.name === params.project)).flatMap((entry) => entry.project.reviews({
+			key: params.key === void 0 ? void 0 : entry.project.parseKey(params.key),
+			locale: params.locale,
+			open: params.open
+		}).map((thread) => {
+			const node = entry.project.locations(thread.key).find((n) => n.locale === thread.locale && n.leaf);
+			return {
+				...thread,
+				project: entry.name,
+				location: node && this.entryLocation(entry, node)
+			};
+		})) };
+	}
 	async extractFile(uri) {
 		const found = this.locate(uri);
 		if (!found) return null;
@@ -683,6 +754,15 @@ var Server = class {
 	entryByName(name) {
 		return name === void 0 ? this.projects[0] : this.projects.find((p) => p.name === name);
 	}
+	/** `x18n doctor` for every folder: load errors, then how each project was understood. */
+	explain() {
+		if (this.folders.length === 0) return "No workspace folder is open.";
+		return [...this.failures.map(({ folder, error }) => [
+			`# ${folder}`,
+			`error: ${error.name} ${error.why}`,
+			...error.fix ? [`fix: ${error.fix}`] : []
+		].join("\n")), ...this.projects.map((entry) => renderExplanation(entry.project.explain(), entry.configFile))].join("\n\n");
+	}
 	projectInfos() {
 		return this.projects.map((entry) => ({
 			name: entry.name,
@@ -814,6 +894,24 @@ var Server = class {
 			missing
 		};
 	}
+	/** Matches of every project, best first. */
+	search(params) {
+		return this.projects.flatMap((entry) => entry.project.search(params.query, { exact: params.exact }).map((match) => ({
+			entry,
+			match
+		}))).sort((a, b) => b.match.score - a.match.score).slice(0, 100).map(({ entry, match }) => {
+			const { project } = entry;
+			const node = project.locations(match.key).find((node) => node.locale === match.locale);
+			return {
+				project: entry.name,
+				key: match.key,
+				locale: match.locale,
+				value: match.value,
+				definition: node && this.entryLocation(entry, node),
+				usages: project.usages({ key: match.key }).map((m) => this.location(entry, m.usage.path, m.usage.range))
+			};
+		});
+	}
 	async decorations(params) {
 		await this.ready;
 		const found = this.locate(params.uri);
@@ -885,6 +983,10 @@ function setupServer(connection, options = {}) {
 		await server.ready;
 		return server.usageReport();
 	});
+	connection.onRequest(methods.search, async (params) => {
+		await server.ready;
+		return server.search(params);
+	});
 	connection.onRequest(methods.decorations, (params) => server.decorations(params));
 	connection.onNotification(methods.setDisplayLocale, (params) => {
 		server.settings.displayLocale = params.locale;
@@ -896,6 +998,14 @@ function setupServer(connection, options = {}) {
 		if (!entry) throw new ResponseError(1, `No project "${params?.project ?? ""}" in this server.`);
 		return openUi(entry);
 	});
+	connection.onRequest(methods.reviews, async (params) => {
+		await server.ready;
+		return server.reviews(params ?? {});
+	});
+	connection.onRequest(methods.explain, async () => {
+		await server.ready;
+		return server.explain();
+	});
 	connection.onRequest(methods.translatePrompt, async (params) => {
 		await server.ready;
 		const entry = server.entryByName(params.project);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@x18n/lsp",
   "type": "module",
-  "version": "0.0.14",
+  "version": "0.0.15",
   "description": "x18n language server for any LSP editor",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -29,10 +29,10 @@
     "node": ">=22"
   },
   "dependencies": {
-    "@x18n/builtins": "0.0.14",
-    "@x18n/core": "0.0.14",
-    "@x18n/node": "0.0.14",
-    "@x18n/ui": "0.0.14",
+    "@x18n/builtins": "0.0.15",
+    "@x18n/core": "0.0.15",
+    "@x18n/node": "0.0.15",
+    "@x18n/ui": "0.0.15",
     "devframe": "^1.2.6",
     "vscode-languageserver": "^10.1.2",
     "vscode-languageserver-textdocument": "^1.0.15"