Add definition support for nls strings in package.json

Fixes #297496

extensions/extension-editing/src/extensionEditingBrowserMain.ts

@@ -5,11 +5,14 @@
 
 import * as vscode from 'vscode';
 import { PackageDocument } from './packageDocumentHelper';
+import { PackageDocumentL10nSupport } from './packageDocumentL10nSupport';
 
 export function activate(context: vscode.ExtensionContext) {
 	//package.json suggestions
 	context.subscriptions.push(registerPackageDocumentCompletions());
 
+	//package.json go to definition for NLS strings
+	context.subscriptions.push(new PackageDocumentL10nSupport());
 }
 
 function registerPackageDocumentCompletions(): vscode.Disposable {
@@ -18,5 +21,4 @@ function registerPackageDocumentCompletions(): vscode.Disposable {
 			return new PackageDocument(document).provideCompletionItems(position, token);
 		}
 	});
-
 }

extensions/extension-editing/src/extensionEditingMain.ts

@@ -5,6 +5,7 @@
 
 import * as vscode from 'vscode';
 import { PackageDocument } from './packageDocumentHelper';
+import { PackageDocumentL10nSupport } from './packageDocumentL10nSupport';
 import { ExtensionLinter } from './extensionLinter';
 
 export function activate(context: vscode.ExtensionContext) {
@@ -15,6 +16,9 @@ export function activate(context: vscode.ExtensionContext) {
 	//package.json code actions for lint warnings
 	context.subscriptions.push(registerCodeActionsProvider());
 
+	// package.json l10n support
+	context.subscriptions.push(new PackageDocumentL10nSupport());
+
 	context.subscriptions.push(new ExtensionLinter());
 }
 

extensions/extension-editing/src/packageDocumentL10nSupport.ts

@@ -0,0 +1,77 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as vscode from 'vscode';
+import { getLocation, getNodeValue, parseTree, findNodeAtLocation } from 'jsonc-parser';
+
+
+export class PackageDocumentL10nSupport implements vscode.DefinitionProvider, vscode.Disposable {
+
+	private readonly _registration: vscode.Disposable;
+
+	constructor() {
+		this._registration = vscode.languages.registerDefinitionProvider(
+			{ language: 'json', pattern: '**/package.json' },
+			this,
+		);
+	}
+
+	dispose(): void {
+		this._registration.dispose();
+	}
+
+	public async provideDefinition(document: vscode.TextDocument, position: vscode.Position, _token: vscode.CancellationToken): Promise<vscode.DefinitionLink[] | undefined> {
+		const nlsRef = this.getNlsReferenceAtPosition(document, position);
+		if (!nlsRef) {
+			return undefined;
+		}
+
+		const nlsUri = vscode.Uri.joinPath(document.uri, '..', 'package.nls.json');
+
+		try {
+			const nlsDoc = await vscode.workspace.openTextDocument(nlsUri);
+			const nlsTree = parseTree(nlsDoc.getText());
+			if (!nlsTree) {
+				return undefined;
+			}
+
+			const node = findNodeAtLocation(nlsTree, [nlsRef.key]);
+			if (!node) {
+				return undefined;
+			}
+
+			const targetStart = nlsDoc.positionAt(node.offset);
+			const targetEnd = nlsDoc.positionAt(node.offset + node.length);
+			return [{
+				originSelectionRange: nlsRef.range,
+				targetUri: nlsUri,
+				targetRange: new vscode.Range(targetStart, targetEnd),
+			}];
+		} catch {
+			return undefined;
+		}
+	}
+
+	private getNlsReferenceAtPosition(document: vscode.TextDocument, position: vscode.Position): { key: string; range: vscode.Range } | undefined {
+		const location = getLocation(document.getText(), document.offsetAt(position));
+		if (!location.previousNode || location.previousNode.type !== 'string') {
+			return undefined;
+		}
+
+		const value = getNodeValue(location.previousNode);
+		if (typeof value !== 'string') {
+			return undefined;
+		}
+
+		const match = value.match(/^%(.+)%$/);
+		if (!match) {
+			return undefined;
+		}
+
+		const nodeStart = document.positionAt(location.previousNode.offset);
+		const nodeEnd = document.positionAt(location.previousNode.offset + location.previousNode.length);
+		return { key: match[1], range: new vscode.Range(nodeStart, nodeEnd) };
+	}
+}