i18n-lens-language-server 0.8.2 → 0.9.0

package/README.md

@@ -8,9 +8,35 @@ Zed extension plus Language Server for Vue, TypeScript, TSX, JavaScript and JSX.
 - Detect `$t`/`t`/`tc`/`$tc`/`i18n.t` calls, `v-t="'key'"`, `v-t="{ path: 'key' }"`, `<i18n-t keypath="key">` (Vue I18n), `<Trans i18nKey="key">` (react-i18next), and `formatMessage({ id: "key" })` (react-intl)
 - Hover: show all locale values for a key
 - Diagnostics: report missing keys, missing locale entries, and mismatched interpolation params
+- Quick fixes: add missing interpolation params to supported i18n calls
 - Completion: suggest existing i18n keys with default locale text
 - Definition: jump from a source key to its locale definition; when several locales define the key, pick which language file to open
 
+## Installation
+
+Install **I18n Lens** from Zed's extension catalog. The extension downloads its companion language server package, [`i18n-lens-language-server`](https://www.npmjs.com/package/i18n-lens-language-server), into Zed's extension work directory at runtime.
+
+After installation, open a Vue, TypeScript, TSX, JavaScript, or JSX file in a project that contains locale files. If your locale files are not in one of the default directories, configure `localeDirs` as shown below.
+
+## Quick start
+
+For most projects, add this to your project `.zed/settings.json` or user-level Zed settings:
+
+```json
+{
+  "lsp": {
+    "i18n-lens": {
+      "settings": {
+        "defaultLocale": "en-US",
+        "localeDirs": ["src/locales", "src/i18n"]
+      }
+    }
+  }
+}
+```
+
+If you prefer a project-owned config file that can be committed with the repository, create `.zed/i18nlensrc.json` instead. When both are present, `.zed/i18nlensrc.json` takes precedence over Zed settings.
+
 ## Inline translations
 
 > **Important:** Inline translations are rendered through Zed's LSP inlay hints. In Zed settings, make sure **Inlay Hints** are enabled and **Inlay Hints: Show Other Hints** is turned on. If **Show Other Hints** is disabled, hover/completion/diagnostics can still work, but inline translation text will not be displayed.
@@ -27,7 +53,7 @@ will show the default locale translation inline after the key string, for exampl
 t("order.pay_now")  立即支付
 ```
 
-The inline hint uses `defaultLocale` from `.zed/i18nlensrc.json`, falling back to `zh-CN`. Missing keys are not shown inline because diagnostics already report them.
+The inline hint uses `defaultLocale` from your Zed settings or `.zed/i18nlensrc.json`, falling back to `zh-CN`. Missing keys are not shown inline because diagnostics already report them.
 
 Long translations are truncated inline to keep the editor readable. Hover still shows the full locale table.
 
@@ -47,6 +73,7 @@ Diagnostics distinguish between these cases:
 - If a key exists in at least one locale but is missing from other locales, it is reported as a warning listing the missing locale names.
 - If a translation contains named placeholders such as `{count}` but the source call does not pass them, it reports missing params.
 - If the source call passes params that no loaded translation uses, it reports unused params.
+- Quick fixes can add missing params to supported i18n calls.
 
 For example, if `order.pay_now` exists in `zh-CN` but is missing from `en-US`, the warning message is:
 
@@ -56,25 +83,57 @@ Missing i18n key "order.pay_now" in locales: en-US
 
 ## Project configuration
 
-You can add `.zed/i18nlensrc.json` under your project root to override the defaults:
+I18n Lens supports two configuration sources:
+
+1. Zed settings, under `lsp.i18n-lens.settings`.
+2. A project file, `.zed/i18nlensrc.json`.
+
+The project file is merged on top of Zed settings, so repository-specific configuration can override personal or team-wide editor settings.
+
+### Configure from Zed settings
+
+Use this when you want configuration to live in Zed's normal settings system:
 
 ```json
 {
-  "defaultLocale": "zh-CN",
-  "localeDirs": ["src/locales", "src/i18n", "locales", "i18n"],
+  "lsp": {
+    "i18n-lens": {
+      "settings": {
+        "defaultLocale": "en-US",
+        "localeDirs": ["src/locales", "src/i18n"],
+        "inlayHints": {
+          "enabled": true,
+          "maxLength": 32
+        }
+      }
+    }
+  }
+}
+```
+
+Zed settings can be user-level or project-level. For project-level Zed settings, put the snippet in `.zed/settings.json`.
+
+### Configure from `.zed/i18nlensrc.json`
+
+Use this when the i18n layout should be part of the repository and shared by everyone who opens it:
+
+```json
+{
+  "defaultLocale": "en-US",
+  "localeDirs": ["src/locales", "src/i18n"],
   "inlayHints": {
     "enabled": true,
-    "maxLength": 24
+    "maxLength": 32
   },
   "packages": [
     {
       "root": "apps/web",
-      "defaultLocale": "zh-CN",
+      "defaultLocale": "en-US",
       "localeDirs": ["src/locales"]
     },
     {
       "root": "packages/admin",
-      "defaultLocale": "en-US",
+      "defaultLocale": "ja-JP",
       "localeDirs": ["src/i18n"]
     }
   ]
@@ -92,31 +151,31 @@ Supported options:
 | Option | Type | Default | Description |
 |---|---|---|---|
 | `defaultLocale` | string | `zh-CN` | Locale used for completion details and inline translation hints. Supports exact names such as `en-US`, case-insensitive matching, `_`/`-` normalization, and language aliases such as `en` matching `en-US`. |
-| `localeDirs` | string[] | `src/locales`, `src/i18n`, `locales`, `i18n` | Workspace-relative directories to scan for locale files. |
-| `inlayHints.enabled` | boolean | `true` | Enables or disables inline translation hints from this language server. |
-| `inlayHints.maxLength` | number | `24` | Maximum inline hint label length before truncation. |
+| `localeDirs` | string[] | `src/locales`, `src/i18n`, `locales`, `i18n` | Workspace-relative directories to scan for locale files. In package configs, paths are relative to that package root. |
+| `inlayHints.enabled` | boolean | `true` | Enables or disables inline translation hints from this language server. Hover, completion, definition, diagnostics, and quick fixes can still work when inline hints are disabled. |
+| `inlayHints.maxLength` | number | `24` | Maximum inline hint label length before truncation. Hover still shows the full text. |
 | `packages` | array | `[]` | Optional monorepo package contexts. Each item needs a workspace-relative `root` and can override `defaultLocale`, `localeDirs`, and `inlayHints`. The language server picks the longest package root matching the currently edited file. |
 
-Invalid or missing config values fall back to defaults. If `.zed/i18nlensrc.json` contains invalid JSON, the language server logs a warning and continues with default config.
+Invalid or missing config values fall back to defaults. If `.zed/i18nlensrc.json` contains invalid JSON, the language server logs a warning and continues with the Zed settings or default config.
 
-Configuration changes are watched automatically. After saving `.zed/i18nlensrc.json`, the language server reloads config, rebuilds the locale cache, refreshes diagnostics, and asks the editor to refresh inlay hints. You should not need to rebuild or reload the Zed extension just to apply config changes.
+Configuration changes are watched automatically. After saving `.zed/i18nlensrc.json`, the language server reloads config, rebuilds the locale cache, refreshes diagnostics, and asks the editor to refresh inlay hints. Changes made through Zed settings are also handled through the language server configuration update path.
 
 ## Locale discovery
 
-In a single-project workspace, `localeDirs` are resolved relative to the workspace root. The language server currently reads JSON files from:
+In a single-project workspace, `localeDirs` are resolved relative to the workspace root. By default, the language server reads JSON files from these directories if they exist:
 
 - `src/locales/*.json`
 - `src/i18n/*.json`
 - `locales/*.json`
 - `i18n/*.json`
 
-Locale name comes from filename, for example `zh-CN.json` or `en-US.json`.
+Locale names come from filenames, for example `en-US.json`, `ja-JP.json`, or `zh-CN.json`. If your files are under a nested directory such as `src/i18n/locales/en-US.json`, set `localeDirs` to `["src/i18n/locales"]`.
 
 It also supports locale directories such as:
 
 ```text
-src/locales/zh-CN/common.json
 src/locales/en-US/common.json
+src/locales/ja-JP/common.json
 ```
 
 A file named `common.json` contributes keys with the `common.` prefix. A file named `index.json` contributes keys without an `index.` prefix.
@@ -127,7 +186,7 @@ For pnpm/turborepo and other monorepos, put `.zed/i18nlensrc.json` under the wor
 
 ```json
 {
-  "defaultLocale": "zh-CN",
+  "defaultLocale": "en-US",
   "packages": [
     {
       "root": "apps/web",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "i18n-lens-language-server",
-  "version": "0.8.2",
+  "version": "0.9.0",
   "type": "module",
   "description": "Language server for configurable i18n inlay hints, hover, completion, diagnostics, and definition in Vue/TS/TSX/JS.",
   "license": "MIT",

package/server/core.js

@@ -22,6 +22,18 @@ export function normalizeI18nLensConfig(raw = {}) {
   return { ...base, packages };
 }
 
+export function mergeI18nLensConfig(base = {}, override = {}) {
+  return {
+    ...base,
+    ...override,
+    inlayHints: {
+      ...((base && typeof base.inlayHints === 'object') ? base.inlayHints : {}),
+      ...((override && typeof override.inlayHints === 'object') ? override.inlayHints : {}),
+    },
+    packages: Array.isArray(override?.packages) ? override.packages : base?.packages,
+  };
+}
+
 function normalizeProjectConfig(raw = {}, defaults = DEFAULT_CONFIG) {
   const defaultLocale = typeof raw.defaultLocale === 'string' && raw.defaultLocale.trim()
     ? raw.defaultLocale.trim()
@@ -157,8 +169,9 @@ function collectFunctionCallKeys(text, found) {
     const key = keyMatch[2];
     const start = parenOffset + keyMatch[0].indexOf(key);
     const end = start + key.length;
-    const args = splitArgs(callText.slice(1, -1));
-    found.push({ key, range: makeRange(text, start, end), startOffset: start, endOffset: end, providedParams: collectParamNames(args.slice(1)) });
+    const args = splitArgsWithOffsets(callText.slice(1, -1));
+    const paramsEdit = getParamsEdit(args.slice(1), parenOffset + 1, parenOffset + callText.length - 1);
+    found.push({ key, range: makeRange(text, start, end), startOffset: start, endOffset: end, providedParams: collectParamNames(args.slice(1)), paramsEdit });
   }
 }
 
@@ -169,14 +182,15 @@ function collectFormatMessageKeys(text, found) {
     const parenOffset = re.lastIndex - 1;
     const callText = readParens(text, parenOffset);
     if (!callText) continue;
-    const args = splitArgs(callText.slice(1, -1));
-    const idArg = args[0] || '';
+    const args = splitArgsWithOffsets(callText.slice(1, -1));
+    const idArg = args[0]?.text || '';
     const keyMatch = idArg.match(/\bid\s*:\s*(['"])([A-Za-z0-9_.:-]+)\1/);
     if (!keyMatch) continue;
     const key = keyMatch[2];
     const start = parenOffset + 1 + idArg.indexOf(key);
     const end = start + key.length;
-    found.push({ key, range: makeRange(text, start, end), startOffset: start, endOffset: end, providedParams: collectParamNames(args.slice(1)) });
+    const paramsEdit = getParamsEdit(args.slice(1), parenOffset + 1, parenOffset + callText.length - 1);
+    found.push({ key, range: makeRange(text, start, end), startOffset: start, endOffset: end, providedParams: collectParamNames(args.slice(1)), paramsEdit });
   }
 }
 
@@ -225,10 +239,49 @@ function splitArgs(text) {
   return args;
 }
 
+function splitArgsWithOffsets(text) {
+  const args = [];
+  let start = 0, depth = 0, quote = '', escaped = false;
+  for (let i = 0; i < text.length; i++) {
+    const ch = text[i];
+    if (quote) {
+      if (escaped) escaped = false;
+      else if (ch === '\\') escaped = true;
+      else if (ch === quote) quote = '';
+      continue;
+    }
+    if (ch === '"' || ch === "'" || ch === '`') { quote = ch; continue; }
+    if (ch === '{' || ch === '[' || ch === '(') depth++;
+    else if (ch === '}' || ch === ']' || ch === ')') depth--;
+    else if (ch === ',' && depth === 0) { args.push(trimArg(text, start, i)); start = i + 1; }
+  }
+  const last = trimArg(text, start, text.length);
+  if (last.text) args.push(last);
+  return args;
+}
+
+function trimArg(text, start, end) {
+  while (start < end && /\s/.test(text[start])) start++;
+  while (end > start && /\s/.test(text[end - 1])) end--;
+  return { text: text.slice(start, end), start, end };
+}
+
+function getParamsEdit(args, argsStartOffset, closingParenOffset) {
+  const objectArg = args.find((arg) => arg.text.startsWith('{') && arg.text.lastIndexOf('}') > 0);
+  if (objectArg) {
+    const closeBrace = objectArg.text.lastIndexOf('}');
+    let insertAt = closeBrace;
+    while (insertAt > 1 && /\s/.test(objectArg.text[insertAt - 1])) insertAt--;
+    const body = objectArg.text.slice(1, insertAt);
+    return { insertOffset: argsStartOffset + objectArg.start + insertAt, prefix: body.trim() ? ', ' : ' ' };
+  }
+  return { insertOffset: closingParenOffset, prefix: ', { ', suffix: ' }' };
+}
+
 function collectParamNames(args) {
   const params = new Set();
   for (const arg of args) {
-    const trimmed = arg.trim();
+    const trimmed = (typeof arg === 'string' ? arg : arg.text).trim();
     if (!trimmed.startsWith('{')) continue;
     const body = trimmed.slice(1, trimmed.lastIndexOf('}'));
     for (const part of splitArgs(body)) {
@@ -363,6 +416,29 @@ function collectRequiredParams(key, localeEntries) {
   return [...params].sort();
 }
 
+export function getParamCodeActions(text, diagnostics = []) {
+  const items = extractI18nKeys(text);
+  return diagnostics.flatMap((diagnostic) => {
+    const missingParams = diagnostic.data?.missingParams;
+    if (!Array.isArray(missingParams) || missingParams.length === 0) return [];
+    const item = items.find((candidate) => candidate.key === diagnostic.data?.key && sameRange(candidate.range, diagnostic.range));
+    if (!item?.paramsEdit) return [];
+    const newText = item.paramsEdit.prefix + missingParams.join(', ') + (item.paramsEdit.suffix || '');
+    return [{
+      title: 'Add missing i18n params: ' + missingParams.join(', '),
+      diagnostic,
+      edit: { range: makeRange(text, item.paramsEdit.insertOffset, item.paramsEdit.insertOffset), newText },
+    }];
+  });
+}
+
+function sameRange(a, b) {
+  return a?.start?.line === b?.start?.line
+    && a?.start?.character === b?.start?.character
+    && a?.end?.line === b?.end?.line
+    && a?.end?.character === b?.end?.character;
+}
+
 export function extractPlaceholders(value) {
   const params = new Set();
   // ICU-style: {name, plural, ...} — extract top-level name, skip nested content

package/server/index.js

@@ -2,12 +2,13 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { pathToFileURL, fileURLToPath } from 'node:url';
-import { createConnection, TextDocuments, ProposedFeatures, TextDocumentSyncKind, MarkupKind } from 'vscode-languageserver/node.js';
+import { createConnection, TextDocuments, ProposedFeatures, TextDocumentSyncKind, MarkupKind, CodeActionKind } from 'vscode-languageserver/node.js';
 import { TextDocument } from 'vscode-languageserver-textdocument';
 import {
   flattenLocale,
   buildHoverMarkdown,
   getDiagnostics,
+  getParamCodeActions,
   getCompletions,
   getCompletionPrefix,
   keyAtPosition,
@@ -15,6 +16,7 @@ import {
   collectLocaleKeyTargets,
   getInlayHints,
   normalizeI18nLensConfig,
+  mergeI18nLensConfig,
   resolveConfigPath,
   CONFIG_RELATIVE_PATH,
   didWatchedFileChange,
@@ -25,6 +27,7 @@ import {
 const connection = createConnection(ProposedFeatures.all);
 const documents = new TextDocuments(TextDocument);
 let workspaceRoot = process.cwd();
+let zedSettingsConfig = {};
 let config = normalizeI18nLensConfig();
 let watchedConfigPath;
 const watchedLocalePaths = new Set();
@@ -37,9 +40,10 @@ const reloadDebounceMs = 100;
 
 connection.onInitialize((params) => {
   workspaceRoot = params.workspaceFolders?.[0]?.uri ? fileURLToPath(params.workspaceFolders[0].uri) : (params.rootUri ? fileURLToPath(params.rootUri) : process.cwd());
+  zedSettingsConfig = normalizeIncomingSettings(params.initializationOptions);
   loadConfig();
   watchConfigFile();
-  return { capabilities: { textDocumentSync: TextDocumentSyncKind.Incremental, hoverProvider: true, completionProvider: { triggerCharacters: ['.', '"', "'"] }, definitionProvider: true, inlayHintProvider: true } };
+  return { capabilities: { textDocumentSync: TextDocumentSyncKind.Incremental, hoverProvider: true, completionProvider: { triggerCharacters: ['.', '"', "'"] }, definitionProvider: true, inlayHintProvider: true, codeActionProvider: true } };
 });
 
 connection.onInitialized(() => {
@@ -58,6 +62,11 @@ documents.onDidOpen((event) => {
 documents.onDidChangeContent((event) => validate(event.document));
 documents.onDidSave(() => scheduleProjectReload());
 
+connection.onDidChangeConfiguration((params) => {
+  zedSettingsConfig = normalizeIncomingSettings(params.settings);
+  scheduleProjectReload();
+});
+
 connection.onHover((params) => {
   const doc = documents.get(params.textDocument.uri);
   if (!doc) return null;
@@ -103,6 +112,18 @@ connection.onDefinition((params) => {
   return locations.length ? locations : null;
 });
 
+connection.onCodeAction((params) => {
+  const doc = documents.get(params.textDocument.uri);
+  if (!doc) return [];
+  return getParamCodeActions(doc.getText(), params.context.diagnostics)
+    .map((action) => ({
+      title: action.title,
+      kind: CodeActionKind.QuickFix,
+      diagnostics: [action.diagnostic],
+      edit: { changes: { [params.textDocument.uri]: [action.edit] } },
+    }));
+});
+
 function getProjectContext(uri) {
   loadConfigIfChanged();
   const filePath = uri ? fileURLToPath(uri) : workspaceRoot;
@@ -178,19 +199,26 @@ function loadConfigIfChanged() {
 
 function loadConfig() {
   const configPath = resolveConfigPath(workspaceRoot);
+  const settingsConfig = zedSettingsConfig;
   configMtimeMs = fs.existsSync(configPath) ? fs.statSync(configPath).mtimeMs : 0;
   if (!configMtimeMs) {
-    config = normalizeI18nLensConfig();
+    config = normalizeI18nLensConfig(settingsConfig);
     return;
   }
   try {
-    config = normalizeI18nLensConfig(JSON.parse(fs.readFileSync(configPath, 'utf8')));
+    const fileConfig = JSON.parse(fs.readFileSync(configPath, 'utf8'));
+    config = normalizeI18nLensConfig(mergeI18nLensConfig(settingsConfig, fileConfig));
   } catch (error) {
     connection.console.warn('Failed to load ' + CONFIG_RELATIVE_PATH + ': ' + error.message);
-    config = normalizeI18nLensConfig();
+    config = normalizeI18nLensConfig(settingsConfig);
   }
 }
 
+function normalizeIncomingSettings(value) {
+  if (!value || typeof value !== 'object') return {};
+  return value['i18n-lens'] && typeof value['i18n-lens'] === 'object' ? value['i18n-lens'] : value;
+}
+
 function validate(document) {
   if (!isSourceFile(document.uri)) return;
   const context = getProjectContext(document.uri);