Use arb-dir (#58)

* Use arb-dir

* Refactor parser and add tests

* Update test

---------

Co-authored-by: Moritz <mosum@google.com>

README.md

@@ -52,8 +52,10 @@ To set a template file, either set the `@@x-template` element in your `arb` file
 ```
 or set a file to be the template in the `l10n.yaml` using:
 ```yaml
-template-arb-file: path/to/template.arb
+arb-dir: path/to
+template-arb-file: template.arb
 ```
+
 You can suppress specific diagnostics warnings by adding into `settings.json`:
 ```json
 "arb-editor.suppressedWarnings": string | string[]

src/extension.ts

@@ -27,9 +27,6 @@ import { CodeActions } from './codeactions';
 import { Decorator } from './decorate';
 import { Diagnostics } from './diagnose';
 import { Literal, MessageList, Parser } from './messageParser';
-import { locateL10nYaml } from './project';
-import YAML = require('yaml');
-import fs = require('fs');
 const snippetsJson = require("../snippets/snippets.json");
 const snippetsInlineJson = require("../snippets/snippets_inline.json");
 
@@ -87,10 +84,14 @@ export async function activate(context: vscode.ExtensionContext) {
 		if (!editor || isNotArbFile(editor.document)) {
 			return;
 		}
-		var l10nYamlPath = locateL10nYaml(editor.document.uri.fsPath);
-		var l10nOptions: L10nYaml | undefined;
-		if (l10nYamlPath) {
-			l10nOptions = parseYaml(l10nYamlPath);
+
+		function parseAndDecorate(): MessageList {
+			return parser.parseAndDecorate({
+				editor: editor!,
+				decorator: decorator,
+				diagnostics: diagnostics,
+				quickfixes: quickfixes,
+			}).messageList;
 		}
 
 		if (executeDelayed && pendingDecorations) {
@@ -103,38 +104,6 @@ export async function activate(context: vscode.ExtensionContext) {
 				commonMessageList = parseAndDecorate();
 			}
 		}
-
-		function parseAndDecorate(): MessageList {
-			let templatePathFromOptions = l10nOptions?.['template-arb-file'];
-			let templateMessageList: MessageList | undefined;
-			let templateErrors: Literal[] | undefined;
-			let [templatePathFromFile, messageList, errors] = parser.parse(editor!.document.getText(), l10nOptions)!;
-			if (templatePathFromOptions || templatePathFromFile) {
-				let templatePath: string;
-				if (templatePathFromFile) {
-					if (path.isAbsolute(templatePathFromFile)) {
-						templatePath = templatePathFromFile;
-					} else {
-						templatePath = path.join(path.dirname(editor?.document.uri.path!), templatePathFromFile);
-					}
-				} else {
-					if (path.isAbsolute(templatePathFromOptions!)) {
-						templatePath = templatePathFromOptions!;
-					} else {
-						templatePath = path.join(path.dirname(l10nYamlPath!), templatePathFromOptions!);
-					}
-				}
-				if (templatePath !== editor!.document.uri.fsPath) {
-					const template = fs.readFileSync(templatePath, "utf8");
-					// TODO(mosuem): Allow chaining of template files.
-					[, templateMessageList, templateErrors] = parser.parse(template, l10nOptions)!;
-				}
-			}
-			decorator.decorate(editor!, messageList);
-			diagnostics.diagnose(editor!, messageList, errors, templateMessageList);
-			quickfixes.update(messageList);
-			return messageList;
-		}
 	}
 }
 
@@ -164,14 +133,6 @@ function getSnippets(snippetsJson: any): vscode.CompletionList {
 // This method is called when your extension is deactivated
 export function deactivate() { }
 
-function parseYaml(uri: string): L10nYaml | undefined {
-	if (!fs.existsSync(uri)) {
-		return;
-	}
-	const yaml = fs.readFileSync(uri, "utf8");
-	return YAML.parse(yaml) as L10nYaml;
-}
-
 export interface L10nYaml {
 	'arb-dir'?: string | undefined;
 	'output-dir'?: string | undefined;

src/messageParser.ts

@@ -10,13 +10,21 @@
 // limitations under the License.
 'use strict';
 
+import * as vscode from 'vscode';
 import { JSONPath, visit } from 'jsonc-parser';
 import XRegExp = require('xregexp');
+import { locateL10nYaml } from './project';
 import { L10nYaml } from './extension';
+import { Diagnostics } from './diagnose';
+import { Decorator } from './decorate';
+import { CodeActions } from './codeactions';
+import path = require('path');
+import YAML = require('yaml');
+import fs = require('fs');
 
 export class Parser {
 
-	parse(document: string, l10nOptions?: L10nYaml): [string|undefined, MessageList, Literal[]] {
+	parse(document: string, l10nOptions?: L10nYaml): [MessageList, Literal[]] {
 		let templatePath: string | undefined;
 		const messages: MessageEntry[] = [];
 		const metadata: MessageEntry[] = [];
@@ -25,7 +33,7 @@ export class Parser {
 		let inTemplateTag = false;
 		let placeholderLevel: number | null = null;
 		let metadataLevel: number | null = null;
-		let metadataKey: Key | null = null;	
+		let metadataKey: Key | null = null;
 		let messageKey: Key | null = null;
 		let definedPlaceholders: PlaceholderMetadata[] = [];
 		let errors: Literal[] = [];
@@ -172,8 +180,84 @@ export class Parser {
 			}
 		}
 
-		return [templatePath, new MessageList(templatePath, indentation ?? 0, indentationCharacter ?? ' ', messages, metadata), errors];
+		return [new MessageList(templatePath, indentation ?? 0, indentationCharacter ?? ' ', messages, metadata), errors];
 	}
+
+
+	private resolveTemplatePath({
+		document,
+		messageList,
+		l10nYamlPath,
+		l10nOptions,
+	}: {
+		document: vscode.TextDocument;
+		messageList: MessageList;
+	} & L10nYamlPathAndOptions): string | undefined {
+		if (messageList.templatePath) {
+			return path.isAbsolute(messageList.templatePath)
+				? messageList.templatePath
+				: path.join(path.dirname(document.uri.fsPath), messageList.templatePath);
+		} else if (l10nOptions !== undefined) {
+			const templateRootFromOptions = l10nOptions?.['arb-dir'] ?? 'lib/l10n';
+			const templatePathFromOptions = l10nOptions?.['template-arb-file'] ?? 'app_en.arb';
+
+			return path.isAbsolute(templatePathFromOptions)
+				? templatePathFromOptions
+				: path.join(path.dirname(l10nYamlPath), templateRootFromOptions, templatePathFromOptions);
+		}
+	}
+
+	parseAndDecorate({
+		editor,
+		decorator,
+		diagnostics,
+		quickfixes,
+	}: ParseAndDecorateOptions): ParseAndDecorateResult {
+		let templateMessageList: MessageList | undefined;
+
+		const l10nYamlPath = locateL10nYaml(editor.document.uri.fsPath);
+		const l10nOptions = l10nYamlPath
+			? parseYaml(l10nYamlPath)
+			: undefined;
+		const [messageList, errors] = this.parse(editor.document.getText(), l10nOptions)!;
+
+		const templatePath = this.resolveTemplatePath({
+			document: editor.document,
+			messageList,
+			l10nYamlPath: l10nYamlPath!,
+			l10nOptions: l10nOptions,
+		});
+
+		if (templatePath && templatePath !== editor.document.uri.fsPath) {
+			const template = fs.readFileSync(templatePath, "utf8");
+			// TODO(mosuem): Allow chaining of template files.
+			[templateMessageList,] = this.parse(template, l10nOptions)!;
+		}
+
+		const decorations = decorator.decorate(editor, messageList);
+		const diags = diagnostics.diagnose(editor, messageList, errors, templateMessageList);
+		quickfixes.update(messageList);
+		return { messageList, decorations, diagnostics: diags };
+	}
+}
+
+type L10nYamlPathAndOptions = {
+	l10nYamlPath: string;
+	l10nOptions: L10nYaml;
+} | {
+	l10nYamlPath: string | undefined;
+	l10nOptions: undefined;
+};
+interface ParseAndDecorateResult {
+	messageList: MessageList;
+	decorations: Map<vscode.TextEditorDecorationType, vscode.Range[]>;
+	diagnostics: vscode.Diagnostic[];
+}
+interface ParseAndDecorateOptions {
+	editor: vscode.TextEditor;
+	decorator: Decorator;
+	diagnostics: Diagnostics;
+	quickfixes: CodeActions;
 }
 
 function matchCurlyBrackets(v: string, l10nOptions?: L10nYaml): XRegExp.MatchRecursiveValueNameMatch[] {
@@ -189,6 +273,14 @@ function matchCurlyBrackets(v: string, l10nOptions?: L10nYaml): XRegExp.MatchRec
 	return values;
 }
 
+function parseYaml(uri: string): L10nYaml | undefined {
+	if (!fs.existsSync(uri)) {
+		return;
+	}
+	const yaml = fs.readFileSync(uri, "utf8");
+	return YAML.parse(yaml) as L10nYaml;
+}
+
 export function getUnescapedRegions(expression: string, l10nOptions?: L10nYaml): [number, number][] {
 	const unEscapedRegions: [number, number][] = [];
 

src/test/l10nYaml/arb-dir/_l10n/app_en.arb

@@ -0,0 +1,5 @@
+{
+    "@@locale": "en",
+    "appName": "Demo app",
+    "dir": "dir"
+}

src/test/l10nYaml/arb-dir/_l10n/testarb_2.annotated

@@ -0,0 +1,4 @@
+{
+    "@@locale": "en"
+}
+ [Warning]:"Missing messages from template: appName, dir"

src/test/l10nYaml/arb-dir/_l10n/testarb_2.arb

@@ -0,0 +1,3 @@
+{
+    "@@locale": "en"
+}

src/test/l10nYaml/arb-dir/l10n.yaml

@@ -0,0 +1,4 @@
+arb-dir: _l10n
+output-class: Words
+output-localization-file: app_localizations.dart
+untranslated-messages-file: lib/_l10n/desiredFileName.txt

src/test/l10nYaml/arb-dir_template-arb-file/_l10n/testarb.arb

@@ -0,0 +1,5 @@
+{
+    "@@locale": "en",
+    "appName": "Demo app",
+    "dirAndTemplate": "dirAndTemplate"
+}

src/test/l10nYaml/arb-dir_template-arb-file/_l10n/testarb_2.annotated

@@ -0,0 +1,4 @@
+{
+    "@@locale": "en"
+}
+ [Warning]:"Missing messages from template: appName, dirAndTemplate"

src/test/l10nYaml/arb-dir_template-arb-file/_l10n/testarb_2.arb

@@ -0,0 +1,3 @@
+{
+    "@@locale": "en"
+}

src/test/l10nYaml/arb-dir_template-arb-file/l10n.yaml

@@ -0,0 +1,5 @@
+arb-dir: _l10n
+template-arb-file: testarb.arb
+output-class: Words
+output-localization-file: app_localizations.dart
+untranslated-messages-file: lib/_l10n/desiredFileName.txt

src/test/l10nYaml/empty/lib/l10n/app_en.arb

@@ -0,0 +1,5 @@
+{
+    "@@locale": "en",
+    "appName": "Demo app",
+    "empty": "empty"
+}

src/test/l10nYaml/empty/lib/l10n/testarb_2.annotated

@@ -0,0 +1,4 @@
+{
+    "@@locale": "en"
+}
+ [Warning]:"Missing messages from template: appName, empty"

src/test/l10nYaml/empty/lib/l10n/testarb_2.arb

@@ -0,0 +1,3 @@
+{
+    "@@locale": "en"
+}

src/test/l10nYaml/template-arb-file/l10n.yaml

@@ -0,0 +1,4 @@
+template-arb-file: testarb.arb
+output-class: Words
+output-localization-file: app_localizations.dart
+untranslated-messages-file: lib/_l10n/desiredFileName.txt

src/test/l10nYaml/template-arb-file/lib/l10n/testarb.arb

@@ -0,0 +1,5 @@
+{
+    "@@locale": "en",
+    "appName": "Demo app",
+    "template": "template"
+}

src/test/l10nYaml/template-arb-file/lib/l10n/testarb_2.annotated

@@ -0,0 +1,4 @@
+{
+    "@@locale": "en"
+}
+ [Warning]:"Missing messages from template: appName, template"

src/test/l10nYaml/template-arb-file/lib/l10n/testarb_2.arb

@@ -0,0 +1,3 @@
+{
+    "@@locale": "en"
+}

src/test/l10nYaml/with_x-template/l10n.yaml

@@ -0,0 +1,5 @@
+arb-dir: lib/_l10n
+template-arb-file: app_ja.arb
+output-class: Words
+output-localization-file: app_localizations.dart
+untranslated-messages-file: lib/_l10n/desiredFileName.txt

src/test/l10nYaml/with_x-template/l10n/testarb.arb

@@ -0,0 +1,5 @@
+{
+    "@@locale": "en",
+    "appName": "Demo app",
+    "withTemplate": "withTemplate"
+}

src/test/l10nYaml/with_x-template/l10n/testarb_2.annotated

@@ -0,0 +1,5 @@
+{
+    "@@locale": "en",
+    "@@x-template": "testarb.arb"
+}
+ [Warning]:"Missing messages from template: appName, withTemplate"

src/test/l10nYaml/with_x-template/l10n/testarb_2.arb

@@ -0,0 +1,4 @@
+{
+    "@@locale": "en",
+    "@@x-template": "testarb.arb"
+}

src/test/pubspec.yaml

@@ -0,0 +1 @@
+name: Dummy