@salesforce/vscode-i18n 65.17.3 → 66.0.0

package/README.md

@@ -104,6 +104,24 @@ service.messageBundleManager.registerMessageBundle(instanceName, {
 });
 ```
 
+### i18n Hover (TypeScript Language Service Plugin)
+
+The package includes a TypeScript plugin that shows message text when you hover over `nls.localize('key')` or `coerceMessageKey('key')` in your editor.
+
+**Setup:**
+
+1. Add the plugin to your `tsconfig.json`:
+   ```json
+   {
+     "compilerOptions": {
+       "plugins": [{ "name": "@salesforce/vscode-i18n/tsPlugin" }]
+     }
+   }
+   ```
+2. In VS Code, use the workspace TypeScript version: run "TypeScript: Select TypeScript Version" and choose "Use Workspace Version". (Plugins only load with the workspace TS version.)
+
+Your messages must follow the standard format: `export const messages = { ... }` in a `messages/i18n.ts` file within the package.
+
 ### Constants
 
 - `DEFAULT_LOCALE`: The default locale ('en')

package/out/src/hover/messageCache.d.ts

@@ -0,0 +1,19 @@
+export type MessageEntry = {
+    text: string;
+    namePos: number;
+    nameEnd: number;
+};
+type MessagesMap = Record<string, MessageEntry>;
+type TsLike = {
+    createSourceFile: (path: string, content: string, target: number, setParentNodes: boolean) => {
+        statements: Iterable<unknown>;
+    };
+    SyntaxKind: Record<string, number>;
+};
+export type MessagesResult = {
+    i18nPath: string;
+    entries: MessagesMap;
+};
+export declare const getMessagesForFile: (ts: TsLike, sourceFilePath: string) => MessagesResult | undefined;
+export {};
+//# sourceMappingURL=messageCache.d.ts.map

package/out/src/hover/messageCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messageCache.d.ts","sourceRoot":"","sources":["../../../src/hover/messageCache.ts"],"names":[],"mappings":"AAUA,MAAM,MAAM,YAAY,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAC9E,KAAK,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;AAEhD,KAAK,MAAM,GAAG;IACZ,gBAAgB,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,OAAO,KAAK;QAAE,UAAU,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;KAAE,CAAC;IAChI,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACpC,CAAC;AAuFF,MAAM,MAAM,cAAc,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,WAAW,CAAA;CAAE,CAAC;AAOxE,eAAO,MAAM,kBAAkB,GAC7B,IAAI,MAAM,EACV,gBAAgB,MAAM,KACrB,cAAc,GAAG,SAmBnB,CAAC"}

package/out/src/hover/messageCache.js

@@ -0,0 +1,110 @@
+"use strict";
+/*
+ * Copyright (c) 2025, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMessagesForFile = void 0;
+const fs = require("node:fs");
+const path = require("node:path");
+const findPackageRoot = (filePath) => {
+    let dir = path.dirname(filePath);
+    const root = path.parse(filePath).root;
+    while (dir !== root) {
+        if (fs.existsSync(path.join(dir, 'package.json'))) {
+            return dir;
+        }
+        dir = path.dirname(dir);
+    }
+    return undefined;
+};
+const findI18nPath = (packageRoot) => {
+    const candidates = [
+        path.join(packageRoot, 'src', 'messages', 'i18n.ts'),
+        path.join(packageRoot, 'messages', 'i18n.ts')
+    ];
+    const found = candidates.find(p => fs.existsSync(p));
+    if (found)
+        return found;
+    const srcDir = path.join(packageRoot, 'src');
+    if (!fs.existsSync(srcDir))
+        return undefined;
+    const match = fs.readdirSync(srcDir, { withFileTypes: true, recursive: true })
+        .find(e => e.name === 'i18n.ts' && !e.isDirectory() && path.basename(e.parentPath) === 'messages');
+    return match ? path.join(match.parentPath, match.name) : undefined;
+};
+const extractMessagesFromObjectLiteral = (ts, node) => {
+    const entries = [];
+    for (const prop of node.properties ?? []) {
+        const name = prop.name;
+        if (!name || typeof name.text !== 'string' || !name.text)
+            continue;
+        const key = name.text;
+        const sk = ts.SyntaxKind;
+        // name.pos includes leading trivia; compute actual start from end
+        const isQuoted = name.kind === sk.StringLiteral || name.kind === sk.NoSubstitutionTemplateLiteral;
+        const nameStart = (name.end ?? 0) - key.length - (isQuoted ? 1 : 0);
+        const init = prop.initializer;
+        if (!init)
+            continue;
+        const text = init.kind === sk.StringLiteral || init.kind === sk.NoSubstitutionTemplateLiteral
+            ? init.text
+            : init.kind === sk.TemplateExpression
+                ? (init.head
+                    .text +
+                    init.templateSpans
+                        .map(s => s.literal.text)
+                        .join(''))
+                : undefined;
+        if (text !== undefined) {
+            entries.push([key, { text, namePos: nameStart, nameEnd: name.end ?? 0 }]);
+        }
+    }
+    return Object.fromEntries(entries);
+};
+const extractMessagesFromSource = (ts, sourceFile) => {
+    const sk = ts.SyntaxKind;
+    for (const stmt of sourceFile.statements) {
+        const s = stmt;
+        if (s.kind !== sk.VariableStatement)
+            continue;
+        const hasExport = (s.modifiers ?? []).some((m) => m && typeof m === 'object' && m.kind === sk.ExportKeyword);
+        if (!hasExport)
+            continue;
+        for (const decl of s.declarationList?.declarations ?? []) {
+            const d = decl;
+            if (d.name?.text !== 'messages' || !d.initializer)
+                continue;
+            const init = d.initializer;
+            const obj = init.kind === sk.AsExpression ? init.expression : init;
+            if (obj.kind === sk.ObjectLiteralExpression) {
+                return extractMessagesFromObjectLiteral(ts, obj);
+            }
+        }
+    }
+    return {};
+};
+const cache = new Map();
+const getMessagesForFile = (ts, sourceFilePath) => {
+    const packageRoot = findPackageRoot(sourceFilePath);
+    if (!packageRoot)
+        return undefined;
+    const i18nPath = findI18nPath(packageRoot);
+    if (!i18nPath)
+        return undefined;
+    const stat = fs.statSync(i18nPath);
+    const cached = cache.get(i18nPath);
+    if (cached && cached.mtimeMs === stat.mtimeMs)
+        return cached.result;
+    const content = fs.readFileSync(i18nPath, 'utf8');
+    const sourceFile = ts.createSourceFile(i18nPath, content, 99, // ScriptTarget.Latest
+    true);
+    const entries = extractMessagesFromSource(ts, sourceFile);
+    const result = { i18nPath, entries };
+    cache.set(i18nPath, { result, mtimeMs: stat.mtimeMs });
+    return result;
+};
+exports.getMessagesForFile = getMessagesForFile;
+//# sourceMappingURL=messageCache.js.map

package/out/src/hover/tsPlugin.d.ts

@@ -0,0 +1,8 @@
+import type ts from 'typescript/lib/tsserverlibrary';
+declare function init(modules: {
+    typescript: typeof import('typescript/lib/tsserverlibrary');
+}): {
+    create: (info: ts.server.PluginCreateInfo) => ts.LanguageService;
+};
+export = init;
+//# sourceMappingURL=tsPlugin.d.ts.map

package/out/src/hover/tsPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tsPlugin.d.ts","sourceRoot":"","sources":["../../../src/hover/tsPlugin.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,MAAM,gCAAgC,CAAC;AAGrD,iBAAS,IAAI,CAAC,OAAO,EAAE;IAAE,UAAU,EAAE,cAAc,gCAAgC,CAAC,CAAA;CAAE;mBAkD9D,EAAE,CAAC,MAAM,CAAC,gBAAgB;EAqEjD;AAED,SAAS,IAAI,CAAC"}

package/out/src/hover/tsPlugin.js

@@ -0,0 +1,114 @@
+"use strict";
+/*
+ * Copyright (c) 2025, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+const messageCache_1 = require("./messageCache");
+function init(modules) {
+    const ts = modules.typescript;
+    const isNlsLocalizeCall = (node) => {
+        if (node.kind !== ts.SyntaxKind.CallExpression)
+            return false;
+        const call = node;
+        if (call.expression.kind !== ts.SyntaxKind.PropertyAccessExpression)
+            return false;
+        const prop = call.expression;
+        return (prop.expression.kind === ts.SyntaxKind.Identifier &&
+            prop.expression.text === 'nls' &&
+            prop.name.text === 'localize');
+    };
+    const isCoerceMessageKeyCall = (node) => node.kind === ts.SyntaxKind.CallExpression &&
+        node.expression.kind === ts.SyntaxKind.Identifier &&
+        node.expression.text === 'coerceMessageKey';
+    const getKeyAtPosition = (sourceFile, position) => {
+        let sf = sourceFile;
+        let node = ts.getTokenAtPosition?.(sf, position);
+        if (!node)
+            return undefined;
+        if (!node.parent && sourceFile.text) {
+            sf = ts.createSourceFile(sourceFile.fileName, sourceFile.text, sourceFile.languageVersion ?? 99, true);
+            node = ts.getTokenAtPosition?.(sf, position);
+            if (!node)
+                return undefined;
+        }
+        const str = node.kind === ts.SyntaxKind.StringLiteral || node.kind === ts.SyntaxKind.NoSubstitutionTemplateLiteral
+            ? node.text
+            : undefined;
+        if (str === undefined)
+            return undefined;
+        const parent = node.parent;
+        if (!parent)
+            return undefined;
+        const isTarget = (isNlsLocalizeCall(parent) || isCoerceMessageKeyCall(parent)) &&
+            parent.arguments[0] === node;
+        return isTarget ? str : undefined;
+    };
+    function create(info) {
+        const proxy = Object.create(null);
+        for (const k of Object.keys(info.languageService)) {
+            const x = info.languageService[k];
+            proxy[k] = (...args) => x.apply(info.languageService, args);
+        }
+        const tsLike = {
+            createSourceFile: (p, c, t, s) => ts.createSourceFile(p, c, t, s),
+            SyntaxKind: ts.SyntaxKind
+        };
+        const resolveKey = (fileName, position) => {
+            const program = info.languageService.getProgram();
+            const sourceFile = program?.getSourceFile(fileName);
+            if (!program || !sourceFile)
+                return undefined;
+            const key = getKeyAtPosition(sourceFile, position);
+            if (!key)
+                return undefined;
+            const result = (0, messageCache_1.getMessagesForFile)(tsLike, fileName);
+            if (!result || !(key in result.entries))
+                return undefined;
+            return { key, sourceFile, result };
+        };
+        proxy.getQuickInfoAtPosition = (fileName, position) => {
+            const prior = info.languageService.getQuickInfoAtPosition(fileName, position);
+            const resolved = resolveKey(fileName, position);
+            if (!resolved)
+                return prior;
+            const { key, sourceFile, result } = resolved;
+            return {
+                kind: ts.ScriptElementKind.string,
+                kindModifiers: '',
+                textSpan: prior?.textSpan ?? {
+                    start: sourceFile.getPositionOfLineAndCharacter?.(sourceFile.getLineAndCharacterOfPosition(position).line, sourceFile.getLineAndCharacterOfPosition(position).character) ?? position,
+                    length: key.length + 2
+                },
+                displayParts: [{ kind: 'text', text: `(i18n) ${key}` }],
+                documentation: [{ kind: 'text', text: result.entries[key].text }]
+            };
+        };
+        proxy.getDefinitionAndBoundSpan = (fileName, position) => {
+            const prior = info.languageService.getDefinitionAndBoundSpan(fileName, position);
+            const resolved = resolveKey(fileName, position);
+            if (!resolved)
+                return prior;
+            const { key, result } = resolved;
+            const entry = result.entries[key];
+            const definition = {
+                fileName: result.i18nPath,
+                textSpan: { start: entry.namePos, length: entry.nameEnd - entry.namePos },
+                kind: ts.ScriptElementKind.string,
+                name: key,
+                containerKind: ts.ScriptElementKind.variableElement,
+                containerName: 'messages'
+            };
+            const priorDefs = prior?.definitions ?? [];
+            return {
+                definitions: [definition, ...priorDefs],
+                textSpan: prior?.textSpan ?? { start: position, length: key.length + 2 }
+            };
+        };
+        return proxy;
+    }
+    return { create };
+}
+module.exports = init;
+//# sourceMappingURL=tsPlugin.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/vscode-i18n",
-  "version": "65.17.3",
+  "version": "66.0.0",
   "description": "Internationalization (i18n) library for Salesforce VS Code extensions",
   "author": "Salesforce",
   "license": "BSD-3-Clause",
@@ -14,7 +14,12 @@
   "homepage": "https://github.com/forcedotcom/salesforcedx-vscode/tree/develop/packages/salesforcedx-vscode-i18n",
   "main": "out/src/index.js",
   "types": "out/src/index.d.ts",
+  "exports": {
+    ".": "./out/src/index.js",
+    "./tsPlugin": "./out/src/hover/tsPlugin.js"
+  },
   "files": [
+    "tsPlugin.js",
     "out/**/*.js",
     "out/**/*.d.ts",
     "out/**/*.d.ts.map"

package/tsPlugin.js

@@ -0,0 +1,4 @@
+// Node10-compatible proxy for tsserver plugin resolution.
+// tsserver's tryResolveJSModuleWorker hardcodes Node10 resolution,
+// which ignores package.json "exports" maps.
+module.exports = require('./out/src/hover/tsPlugin');