Fix behavior of use-escaping

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to the "arbeditor" extension will be documented in this file
 
 Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
+## [Unreleased]
+
+- Fix behavior of `use-escaping` [#72](https://github.com/google/arb-editor/issues/72).
+
 ## [0.2.0] 
 
 - Fix [#62](https://github.com/google/arb-editor/issues/62).

README.md

@@ -41,9 +41,9 @@ An extension to help you in editing .arb files, used for localization of applica
 
 ### Customize
 
-Escaping quotes can be turned off by including a `l10n.yaml` file with the line:
+Escaping quotes can be turned on by including a `l10n.yaml` file with the line:
 ```yaml
-use-escaping: false
+use-escaping: true
 ```
 
 To set a template file, either set the `@@x-template` element in your `arb` file

src/extension.ts

@@ -150,6 +150,6 @@ export interface L10nYaml {
 	'required-resource-attributes'?: boolean | undefined;
 	'nullable-getter'?: boolean | undefined;
 	'format'?: boolean | undefined;
-	'use-escaping'?: string | undefined;
+	'use-escaping'?: boolean | undefined;
 	'suppress-warnings'?: boolean | undefined;
 }

src/messageParser.ts

@@ -261,7 +261,10 @@ interface ParseAndDecorateOptions {
 }
 
 function matchCurlyBrackets(v: string, l10nOptions?: L10nYaml): XRegExp.MatchRecursiveValueNameMatch[] {
-	const unescaped = getUnescapedRegions(v, l10nOptions);
+	const unescaped = l10nOptions?.['use-escaping'] ?? false
+		? getUnescapedRegions(v) :
+		[[0, v.length]];
+
 	var values: XRegExp.MatchRecursiveValueNameMatch[] = [];
 	for (var region of unescaped) {
 		const newLocal = XRegExp.matchRecursive(v.substring(region[0], region[1]), '\\{', '\\}', 'g', {
@@ -281,13 +284,9 @@ function parseYaml(uri: string): L10nYaml | undefined {
 	return YAML.parse(yaml) as L10nYaml;
 }
 
-export function getUnescapedRegions(expression: string, l10nOptions?: L10nYaml): [number, number][] {
+export function getUnescapedRegions(expression: string): [number, number][] {
 	const unEscapedRegions: [number, number][] = [];
 
-	if (!(l10nOptions?.['use-escaping'] ?? true)) {
-		return [[0, expression.length]];
-	}
-
 	var unEscapedRegionEdge: number | null;
 	unEscapedRegionEdge = 0;
 	for (let index = 0; index < expression.length; index++) {

src/test/l10nYaml/use-escaping-false/_l10n/testarb.annotated

@@ -0,0 +1,9 @@
+{
+    "@@locale": "en",
+    "property01": "Test",
+    "property02": "Te'st",
+    "property03": "'{Te'st",
+                   ^^^^^^^[Error]:"Error: Unbalanced left delimiter found in string at position 1"
+    "property04": "'{Te'st'"
+                   ^^^^^^^^[Error]:"Error: Unbalanced left delimiter found in string at position 1"
+}

src/test/l10nYaml/use-escaping-false/_l10n/testarb.arb

@@ -0,0 +1,7 @@
+{
+    "@@locale": "en",
+    "property01": "Test",
+    "property02": "Te'st",
+    "property03": "'{Te'st",
+    "property04": "'{Te'st'"
+}

src/test/l10nYaml/use-escaping-false/l10n.yaml

@@ -0,0 +1,3 @@
+arb-dir: _l10n
+template-arb-file: testarb.arb
+use-escaping: false

src/test/l10nYaml/use-escaping-true/_l10n/testarb.annotated

@@ -0,0 +1,9 @@
+{
+    "@@locale": "en",
+    "property01": "Test",
+    "property02": "Te'st",
+                   ^^^^^[Error]:"Error: Unbalanced escape quotes. To escape a single quote ', prefix it with another single quote."
+    "property03": "'{Te'st",
+    "property04": "'{Te'st'"
+                   ^^^^^^^^[Error]:"Error: Unbalanced escape quotes. To escape a single quote ', prefix it with another single quote."
+}

src/test/l10nYaml/use-escaping-true/_l10n/testarb.arb

@@ -0,0 +1,7 @@
+{
+    "@@locale": "en",
+    "property01": "Test",
+    "property02": "Te'st",
+    "property03": "'{Te'st",
+    "property04": "'{Te'st'"
+}

src/test/l10nYaml/use-escaping-true/l10n.yaml

@@ -0,0 +1,3 @@
+arb-dir: _l10n
+template-arb-file: testarb.arb
+use-escaping: true

src/test/l10nYaml/use-escaping-undefined/_l10n/testarb.annotated

@@ -0,0 +1,9 @@
+{
+    "@@locale": "en",
+    "property01": "Test",
+    "property02": "Te'st",
+    "property03": "'{Te'st",
+                   ^^^^^^^[Error]:"Error: Unbalanced left delimiter found in string at position 1"
+    "property04": "'{Te'st'"
+                   ^^^^^^^^[Error]:"Error: Unbalanced left delimiter found in string at position 1"
+}

src/test/l10nYaml/use-escaping-undefined/_l10n/testarb.arb

@@ -0,0 +1,7 @@
+{
+    "@@locale": "en",
+    "property01": "Test",
+    "property02": "Te'st",
+    "property03": "'{Te'st",
+    "property04": "'{Te'st'"
+}

src/test/l10nYaml/use-escaping-undefined/l10n.yaml

@@ -0,0 +1,2 @@
+arb-dir: _l10n
+template-arb-file: testarb.arb

src/test/suite/extension.test.ts

@@ -159,7 +159,6 @@ suite('Extension Test Suite', async () => {
 	});
 
 	suite('Template Path', async () => {
-		/* eslint-disable @typescript-eslint/naming-convention */
 		test("Resolve template path from @@x-template with L10nYaml", async () => {
 			const testDir = 'l10nYaml/with_x-template/l10n';
 			await updateConfiguration(null);
@@ -194,7 +193,29 @@ suite('Extension Test Suite', async () => {
 			const contentWithAnnotations = await buildContentWithAnnotations(`${testDir}/testarb_2.arb`);
 			await compareGolden(contentWithAnnotations, `${testDir}/testarb_2.annotated`);
 		});
-		/* eslint-enable */
+	});
+
+	suite('use-escaping', async () => {
+		test("Decorate golden file when use-escaping=true.", async () => {
+			const testDir = 'l10nYaml/use-escaping-true/_l10n';
+			await updateConfiguration([DiagnosticCode.missingMetadataForKey]);
+			const contentWithAnnotations = await buildContentWithAnnotations(`${testDir}/testarb.arb`);
+			await compareGolden(contentWithAnnotations, `${testDir}/testarb.annotated`);
+		});
+
+		test("Decorate golden file when use-escaping=false.", async () => {
+			const testDir = 'l10nYaml/use-escaping-false/_l10n';
+			await updateConfiguration([DiagnosticCode.missingMetadataForKey]);
+			const contentWithAnnotations = await buildContentWithAnnotations(`${testDir}/testarb.arb`);
+			await compareGolden(contentWithAnnotations, `${testDir}/testarb.annotated`);
+		});
+
+		test("Decorate golden file when use-escaping=undefined.", async () => {
+			const testDir = 'l10nYaml/use-escaping-undefined/_l10n';
+			await updateConfiguration([DiagnosticCode.missingMetadataForKey]);
+			const contentWithAnnotations = await buildContentWithAnnotations(`${testDir}/testarb.arb`);
+			await compareGolden(contentWithAnnotations, `${testDir}/testarb.annotated`);
+		});
 	});
 });
 

src/test/testarb.annotated

@@ -18,9 +18,9 @@
         }
     },
     "escaped": "Your pa'{'ssword",
-     ^^^^^^^[Information]:"The message with key "escaped" does not have metadata defined."
+                ^^^^^^^^^^^^^^^^[Error]:"Error: Unbalanced left delimiter found in string at position 8"
     "unescaped": "Your pa'ssword",
-                  ^^^^^^^^^^^^^^[Error]:"Error: Unbalanced escape quotes. To escape a single quote ', prefix it with another single quote."
+     ^^^^^^^^^[Information]:"The message with key "unescaped" does not have metadata defined."
     "singlequote": "Your pa''ssword",
      ^^^^^^^^^^^[Information]:"The message with key "singlequote" does not have metadata defined."
     "pageHomeInboxCount": "{count, plural, zero{I have {vehicle;;Type, select, sedn{Sedan} cabrolet{Solid roof cabriolet} tuck{16 wheel truck} other{Other}} no new messages} one{You have 1 new {counts} message} other{You have {count} new messages}}",

src/test/testarb_2.annotated

@@ -12,7 +12,7 @@
     "pageHomeTitle": "Welcome {firstName}",
                                ^^^^^^^^^[decoration]placeholder
     "escaped": "Your pa'{'ssword"
-     ^^^^^^^[Information]:"The message with key "escaped" does not have metadata defined."
+                ^^^^^^^^^^^^^^^^[Error]:"Error: Unbalanced left delimiter found in string at position 8"
 }
 
-[Warning]:"Missing messages from template: singlequote, pageHomeInboxCount, commonVehicleType, pageHomeBalance"
+[Warning]:"Missing messages from template: unescaped, singlequote, pageHomeInboxCount, commonVehicleType, pageHomeBalance"

src/test/testarb_3.annotated

@@ -9,9 +9,9 @@
     "pageHomeTitle": "Welcome {firstName}",
                                ^^^^^^^^^[decoration]placeholder
     "escaped": "Your pa'{'ssword",
-     ^^^^^^^[Information]:"The message with key "escaped" does not have metadata defined."
+                ^^^^^^^^^^^^^^^^[Error]:"Error: Unbalanced left delimiter found in string at position 8"
     "unescaped": "Your pa'ssword",
-                  ^^^^^^^^^^^^^^[Error]:"Error: Unbalanced escape quotes. To escape a single quote ', prefix it with another single quote."
+     ^^^^^^^^^[Information]:"The message with key "unescaped" does not have metadata defined."
     "singlequote": "Your pa''ssword",
      ^^^^^^^^^^^[Information]:"The message with key "singlequote" does not have metadata defined."
     "pageHomeInboxCount": "{count, plural, zero{I have {vehicle;;Type, select, sedn{Sedan} cabrolet{Solid roof cabriolet} tuck{16 wheel truck} other{Other}} no new messages} one{You have 1 new {counts} message} other{You have {count} new messages}}",