i18n-lens-language-server 0.8.0 → 0.8.2

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 yizixu
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 yizixu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -7,12 +7,14 @@ Zed extension plus Language Server for Vue, TypeScript, TSX, JavaScript and JSX.
 - Inline translation display via LSP inlay hints
 - 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 keys missing from every locale file as errors and keys missing from some locales as warnings
+- Diagnostics: report missing keys, missing locale entries, and mismatched interpolation params
 - 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
 
 ## 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.
+
 When inlay hints are enabled in Zed, code like this:
 
 ```ts
@@ -39,10 +41,12 @@ To open a specific language file, use Go to Definition (Ctrl/Cmd+click or F12) o
 
 Diagnostics refresh automatically when loaded locale files or locale directories change, so editing translation files should update warnings/errors without restarting the extension.
 
-Diagnostics distinguish between two missing-key cases:
+Diagnostics distinguish between these cases:
 
 - If a key is missing from every loaded locale, it is reported as an error.
 - 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.
 
 For example, if `order.pay_now` exists in `zh-CN` but is missing from `en-US`, the warning message is:
 
@@ -180,8 +184,6 @@ On this Windows setup, if `cargo` is not visible inside Git Bash / WSL, use:
 4. Open a Vue/TS/JS project with locale JSON files.
 5. Test hover, completion, diagnostics, definition, and inlay hints.
 
-If inline translations do not appear, check whether inlay hints are enabled in Zed settings.
-
 ### Iterating on the language server
 
 The published npm version can lag behind your working tree. To test local `server/*.js` changes without publishing, pack the current tree and install it into the Zed work directory, then restart the server:
@@ -194,26 +196,4 @@ It runs `npm pack`, installs the tarball into `%LOCALAPPDATA%\Zed\extensions\wor
 
 > To exercise the real install path instead, delete `%LOCALAPPDATA%\Zed\extensions\work\i18n-lens\node_modules` and restart the server — Zed will reinstall the published npm package.
 
-## Releasing
-
-The version is single-sourced across `Cargo.toml`, `extension.toml`, and
-`package.json` (they must all match — the release workflow enforces this). To
-cut a release:
-
-1. Bump `version` in `Cargo.toml`, `extension.toml`, and `package.json`.
-2. Tag and push:
-
-   ```bash
-   git tag v<version>   # e.g. v0.7.0
-   git push origin v<version>
-   ```
-
-   The `.github/workflows/release.yml` workflow then verifies the versions
-   match, runs the tests, and publishes the language server to npm as
-   `i18n-lens-language-server`. This requires an `NPM_TOKEN` repository secret
-   with publish rights.
 
-   To publish manually instead: `npm publish --access public`.
-3. Submit/update the extension in `zed-industries/extensions` (bump the
-   `version` in its `extensions.toml` to match) so Zed picks up the new
-   extension version, which installs the new npm package.

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "i18n-lens-language-server",
-  "version": "0.8.0",
+  "version": "0.8.2",
   "type": "module",
   "description": "Language server for configurable i18n inlay hints, hover, completion, diagnostics, and definition in Vue/TS/TSX/JS.",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/yizixu/zed-i18n-lens.git"
+    "url": "git+https://github.com/yizixu/zed-i18n-lens.git"
   },
   "main": "server/index.js",
   "bin": {
-    "i18n-lens-language-server": "./server/index.js"
+    "i18n-lens-language-server": "server/index.js"
   },
   "files": [
     "server/*.js"

package/server/core.js

@@ -122,11 +122,9 @@ function makeRange(text, start, end) {
 
 export function extractI18nKeys(text) {
   const found = [];
+  collectFunctionCallKeys(text, found);
+  collectFormatMessageKeys(text, found);
   const patterns = [
-    // t/$t/tc/$tc/i18n.t/i18n.tc(...) — function calls, incl. Vue I18n plural tc
-    /(?:\x24tc?|\btc?|\bi18n\.tc?)\(\s*(['"])([A-Za-z0-9_.:-]+)\1/g,
-    // react-intl: formatMessage({ id: "key" }) (id may not be the first prop)
-    /\bformatMessage\s*\(\s*\{[^}]*?\bid\s*:\s*(['"])([A-Za-z0-9_.:-]+)\1/g,
     // <i18n-t keypath="key"> (Vue I18n) and <Trans i18nKey="key"> (react-i18next)
     /\b(?:keypath|i18nKey)\s*=\s*(['"])([A-Za-z0-9_.:-]+)\1/g,
     /\bv-t\s*=\s*"'([A-Za-z0-9_.:-]+)'"/g,
@@ -146,6 +144,102 @@ export function extractI18nKeys(text) {
   return found;
 }
 
+function collectFunctionCallKeys(text, found) {
+  // t/$t/tc/$tc/i18n.t/i18n.tc(...) — function calls, incl. Vue I18n plural tc
+  const re = /(?:\x24tc?|\btc?|\bi18n\.tc?)\s*\(/g;
+  let match;
+  while ((match = re.exec(text))) {
+    const parenOffset = re.lastIndex - 1;
+    const callText = readParens(text, parenOffset);
+    if (!callText) continue;
+    const keyMatch = callText.match(/^\(\s*(['"])([A-Za-z0-9_.:-]+)\1/);
+    if (!keyMatch) continue;
+    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)) });
+  }
+}
+
+function collectFormatMessageKeys(text, found) {
+  const re = /\bformatMessage\s*\(/g;
+  let match;
+  while ((match = re.exec(text))) {
+    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 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)) });
+  }
+}
+
+// Read a balanced (...) starting at `start`.
+function readParens(text, start) {
+  if (text[start] !== '(') return undefined;
+  let depth = 0;
+  let quote = '';
+  let escaped = false;
+  for (let i = start; 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--;
+      if (depth === 0) return text.slice(start, i + 1);
+    }
+  }
+  return undefined;
+}
+
+function splitArgs(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(text.slice(start, i).trim()); start = i + 1; }
+  }
+  const last = text.slice(start).trim();
+  if (last) args.push(last);
+  return args;
+}
+
+function collectParamNames(args) {
+  const params = new Set();
+  for (const arg of args) {
+    const trimmed = arg.trim();
+    if (!trimmed.startsWith('{')) continue;
+    const body = trimmed.slice(1, trimmed.lastIndexOf('}'));
+    for (const part of splitArgs(body)) {
+      const m = part.trim().match(/^(?:['"]([^'"]+)['"]|([A-Za-z_$][\w$]*))\s*(?::|$)/);
+      const name = m && (m[1] || m[2]);
+      if (name && !part.trim().startsWith('...')) params.add(name);
+    }
+  }
+  return [...params].sort();
+}
+
 export function keyAtPosition(text, position) {
   const offset = positionToOffset(text, position);
   return extractI18nKeys(text).find((item) => item.startOffset <= offset && offset <= item.endOffset);
@@ -221,16 +315,16 @@ export function getDiagnostics(text, locales) {
   const localeEntries = Object.entries(locales);
   if (localeEntries.length === 0) return [];
 
-  return extractI18nKeys(text)
-    .map((item) => {
-      const missingLocales = localeEntries
-        .filter(([, locale]) => !Object.prototype.hasOwnProperty.call(locale.flat, item.key))
-        .map(([name]) => name)
-        .sort();
+  return extractI18nKeys(text).flatMap((item) => {
+    const missingLocales = localeEntries
+      .filter(([, locale]) => !Object.prototype.hasOwnProperty.call(locale.flat, item.key))
+      .map(([name]) => name)
+      .sort();
 
-      if (missingLocales.length === 0) return undefined;
+    const diagnostics = [];
+    if (missingLocales.length > 0) {
       const missingInAllLocales = missingLocales.length === localeEntries.length;
-      return {
+      diagnostics.push({
         severity: missingInAllLocales ? 1 : 2,
         range: item.range,
         message: missingInAllLocales
@@ -238,9 +332,64 @@ export function getDiagnostics(text, locales) {
           : 'Missing i18n key "' + item.key + '" in locales: ' + missingLocales.join(', '),
         source: 'i18n-lens',
         data: { key: item.key, missingLocales, missingInAllLocales },
-      };
-    })
-    .filter(Boolean);
+      });
+    }
+    if (missingLocales.length !== localeEntries.length) diagnostics.push(...getParamDiagnostics(item, localeEntries));
+    return diagnostics;
+  });
+}
+
+function getParamDiagnostics(item, localeEntries) {
+  if (!Array.isArray(item.providedParams)) return [];
+  const required = collectRequiredParams(item.key, localeEntries);
+  const provided = new Set(item.providedParams);
+  const missing = required.filter((n) => !provided.has(n));
+  const unused = item.providedParams.filter((n) => !required.includes(n));
+  const diagnostics = [];
+  if (missing.length > 0)
+    diagnostics.push({ severity: 2, range: item.range, message: 'Missing i18n params for "' + item.key + '": ' + missing.join(', '), source: 'i18n-lens', data: { key: item.key, missingParams: missing } });
+  if (unused.length > 0)
+    diagnostics.push({ severity: 2, range: item.range, message: 'Unused i18n params for "' + item.key + '": ' + unused.join(', '), source: 'i18n-lens', data: { key: item.key, unusedParams: unused } });
+  return diagnostics;
+}
+
+function collectRequiredParams(key, localeEntries) {
+  const params = new Set();
+  for (const [, locale] of localeEntries) {
+    const value = locale.flat[key];
+    if (value === undefined) continue;
+    for (const name of extractPlaceholders(value)) params.add(name);
+  }
+  return [...params].sort();
+}
+
+export function extractPlaceholders(value) {
+  const params = new Set();
+  // ICU-style: {name, plural, ...} — extract top-level name, skip nested content
+  let text = String(value);
+  let cursor = 0;
+  while (cursor < text.length) {
+    const open = text.indexOf('{', cursor);
+    if (open === -1) break;
+    const head = text.slice(open).match(/^\{\s*([A-Za-z_$][\w$]*)\s*,/);
+    if (head) {
+      params.add(head[1]);
+      let depth = 0, i = open;
+      while (i < text.length) {
+        if (text[i] === '{') depth++;
+        else if (text[i] === '}') { depth--; if (depth === 0) break; }
+        i++;
+      }
+      text = text.slice(0, open) + ' '.repeat(i - open + 1) + text.slice(i + 1);
+      cursor = open;
+      continue;
+    }
+    cursor = open + 1;
+  }
+  const re = /\{\s*([A-Za-z_$][\w$]*)\s*\}/g;
+  let m;
+  while ((m = re.exec(text))) params.add(m[1]);
+  return [...params].sort();
 }
 
 export function resolvePreferredLocale(locales, defaultLocale) {