@lingual/i18n-check 0.1.0

package/src/utils/i18NextParser.ts

@@ -0,0 +1,149 @@
+//  Based on https://github.com/i18next/i18next-translation-parser/blob/v1.0.0/src/parse.js
+
+export type MessageFormatElement =
+  | {
+      type: "text";
+      content: string;
+    }
+  | {
+      type: "interpolation";
+      raw: string;
+      prefix: string;
+      suffix: string;
+      content: string;
+      variable: string;
+    }
+  | {
+      type: "interpolation_unescaped";
+      raw: string;
+      prefix: string;
+      suffix: string;
+      content: string;
+      variable: string;
+    }
+  | {
+      type: "nesting";
+      raw: string;
+      prefix: string;
+      suffix: string;
+      content: string;
+      variable: string;
+    }
+  | {
+      type: "plural";
+      raw: string;
+      prefix: string;
+      suffix: string;
+      content: string;
+      variable: string;
+    }
+  | {
+      type: "tag";
+      raw: string;
+      voidElement: boolean;
+    };
+
+const REGEXP = new RegExp(
+  "({{[^}]+}}|\\$t{[^}]+}|\\$t\\([^\\)]+\\)|\\([0-9\\-inf]+\\)|<[^>]+>)",
+  "g"
+);
+
+const DOUBLE_BRACE = "{{";
+const $_T_BRACE = "$t{";
+const $_T_PARENTHESIS = "$t(";
+const OPEN_PARENTHESIS = "(";
+const OPEN_TAG = "<";
+const CLOSE_TAG = "</";
+
+export const parse = (input: string) => {
+  let ast: MessageFormatElement[] = [];
+
+  ast = parseInput([input]);
+
+  return ast;
+};
+
+const parseInput = (input: string[]): MessageFormatElement[] => {
+  if (input.length === 0) {
+    return [];
+  }
+  let ast: MessageFormatElement[] = [];
+  input.forEach((element) => {
+    const elements = element.split(REGEXP).filter((element) => element !== "");
+    const result = elements.reduce((acc, match) => {
+      if (match.indexOf("{{-") === 0) {
+        const content = match.substring(3, match.length - 2);
+        acc.push({
+          type: "interpolation_unescaped",
+          raw: match,
+          prefix: "{{-",
+          suffix: "}}",
+          content,
+          variable: content.trim(),
+        });
+      } else if (match.indexOf(DOUBLE_BRACE) === 0) {
+        const content = match.substring(2, match.length - 2);
+        acc.push({
+          type: "interpolation",
+          raw: match,
+          prefix: "{{",
+          suffix: "}}",
+          content,
+          variable: content.trim(),
+        });
+      } else if (match.indexOf($_T_BRACE) === 0) {
+        const content = match.substring(3, match.length - 1);
+        acc.push({
+          type: "nesting",
+          raw: match,
+          prefix: "$t{",
+          suffix: "}",
+          content,
+          variable: content.trim(),
+        });
+      } else if (match.indexOf($_T_PARENTHESIS) === 0) {
+        const content = match.substring(3, match.length - 1);
+        acc.push({
+          type: "nesting",
+          raw: match,
+          prefix: "$t(",
+          suffix: ")",
+          content,
+          variable: content.trim(),
+        });
+      } else if (
+        match.indexOf(OPEN_PARENTHESIS) === 0 &&
+        /\([0-9\-inf]+\)/.test(match)
+      ) {
+        const content = match.substring(1, match.length - 1);
+        acc.push({
+          type: "plural",
+          raw: match,
+          prefix: "(",
+          suffix: ")",
+          content,
+          variable: content.trim(),
+        });
+      } else if (match.indexOf(CLOSE_TAG) === 0) {
+        acc.push({
+          type: "tag",
+          raw: match,
+          voidElement: match.substring(match.length - 2) === "/>",
+        });
+      } else if (match.indexOf(OPEN_TAG) === 0) {
+        acc.push({
+          type: "tag",
+          raw: match,
+          voidElement: match.substring(match.length - 2) === "/>",
+        });
+      } else {
+        acc.push({ type: "text", content: match });
+      }
+
+      return acc;
+    }, [] as MessageFormatElement[]);
+    ast = ast.concat(result);
+  });
+
+  return ast;
+};

package/translations/de-de.json

@@ -0,0 +1,6 @@
+{
+  "test.drive.one": "testing one",
+  "test.drive.two": "testing one",
+  "test.drive.three": "testing one",
+  "test.drive.four": "testing one"
+}

package/translations/en-us.json

@@ -0,0 +1,6 @@
+{
+  "test.drive.one": "testing one",
+  "test.drive.two": "testing one",
+  "test.drive.three": "testing one",
+  "test.drive.four": "testing one"
+}

package/translations/flattenExamples/de-de.json

@@ -0,0 +1,6 @@
+{
+  "test.drive.one": "testing one",
+  "test.drive.two": "testing one",
+  "test.drive.three": "testing one",
+  "test.drive.four": "testing one"
+}

package/translations/flattenExamples/en-us.json

@@ -0,0 +1,18 @@
+{
+  "test": {
+    "drive": {
+      "one": "testing one",
+      "two": "testing two"
+    }
+  },
+  "other": {
+    "nested": {
+      "three": "testing three",
+      "deep": {
+        "more": {
+          "final": "nested translation"
+        }
+      }
+    }
+  }
+}

package/translations/folderExample/de-DE/index.json

@@ -0,0 +1,7 @@
+{
+  "message.simple": "A simple message.",
+  "message.argument": "Hi, {name}! 👋",
+  "message.plural": "{count, plural, one {# item} other {# items}}",
+  "message.select": "Hi {user}, it is {today, date, medium} and tomorrow it is {tomorrow, date, medium}.",
+  "message.number-format": "Formatted number: {num, number, ::K}"
+}

package/translations/folderExample/en-US/index.json

@@ -0,0 +1,8 @@
+{
+  "message.simple": "A simple message.",
+  "message.argument": "Hi, {name}! 👋",
+  "message.plural": "{count, plural, one {# item} other {# items}}",
+  "message.select": "{gender, select, male {Mr} female {Mrs} other {User}}",
+  "message.text-format": "Hi, <b>John</b>!",
+  "message.number-format": "Formatted number: {num, number, ::K}"
+}

package/translations/i18NextMessageExamples/de-de.json

@@ -0,0 +1,73 @@
+{
+  "key": "Some format {{value, formatname}}",
+  "key_with_broken_de": "Some format {{val, formatname}}",
+  "keyWithOptions": "Some format {{value, formatname(option1Name: option1Value; option2Name: option2Value)}}",
+  "keyWithTwoFormatters": "Some format {{value, formatter1, formatter2}}",
+  "intlNumber": "Some {{val, number}}",
+  "intlNumber_broken_de": "Some number",
+  "intlNumberWithOptions": "Some {{val, number(minimumFractionDigits: 2)}}",
+  "intlCurrencyWithOptionsSimplified": "The value is {{val, currency(USD)}}",
+  "intlCurrencyWithOptions": "The value is {{val, currency(currency: USD)}}",
+  "twoIntlCurrencyWithUniqueFormatOptions": "The value is {{localValue, currency}} or {{altValue, currency}}",
+  "intlDateTime": "On the {{val, datetime}}",
+  "intlRelativeTime": "Lorem {{val, relativetime}}",
+  "intlRelativeTimeWithOptions": "Lorem {{val, relativetime(quarter)}}",
+  "intlRelativeTimeWithOptionsExplicit": "Lorem {{val, relativetime(range: quarter; style: narrow;)}}",
+  "intlList": "A list of {{val, list}}",
+  "legacyDateFormat": "The current date is {{date, MM/DD/YYYY}}",
+  "legacyUppercase": "{{text, uppercase}} just uppercased",
+  "key_one": "item",
+  "key_other": "items",
+  "keyWithCount_one": "{{count}} item",
+  "keyWithCount_other": "{{count}} items",
+  "key_zero": "zero",
+  "key_multiple_translations_one": "singular",
+  "key_multiple_translations_two": "two",
+  "key_multiple_translations_few": "few",
+  "key_multiple_translations_many": "many",
+  "key_multiple_translations_other": "other",
+  "key_ordinal_one": "{{count}}st place",
+  "key_ordinal_two": "{{count}}nd place",
+  "key_ordinal_few": "{{count}}rd place",
+  "key_ordinal_other": "{{count}}th place",
+  "key1_one": "{{count}} item",
+  "key1_other": "{{count}} items",
+  "key1_interval": "(1)[one item];(2-7)[a few items];(7-inf)[a lot of items];",
+  "key2_one": "{{count}} item",
+  "key2_other": "{{count}} items",
+  "key2_interval": "(1)[one item];(2-7)[a few items];",
+  "look": {
+    "deep": "value of look deep"
+  },
+  "error": {
+    "unspecific": "Something went wrong.",
+    "404": "The page was not found."
+  },
+  "key_interpolation": "{{what}} is {{how}}",
+  "key_with_data_model": "I am {{author.name}}",
+  "keyEscaped": "no danger {{myVar}}",
+  "keyUnescaped": "dangerous {{- myVar}}",
+  "nesting1": "1 $t(nesting2)",
+  "nesting2": "2 $t(nesting3)",
+  "nesting3": "3",
+  "optionsToNesting": "They have $t(that, {\"count\": {{that}} }) and $t(this, {\"count\": {{this}} })",
+  "this": "{{count}} of this",
+  "this_other": "{{count}} of these",
+  "that": "{{count}} of that",
+  "that_other": "{{count}} of those",
+  "animal": "An animal",
+  "animal_dog": "A dog",
+  "animal_cat": "A cat",
+  "animal_dog_one": "A dog",
+  "animal_cat_one": "A cat",
+  "animal_dog_other": "{{count}} dogs",
+  "animal_cat_other": "{{count}} cats",
+
+  "tree": {
+    "res": "added {{something}}"
+  },
+  "array": ["a", "b", "c"],
+  "arrayJoin": ["line1", "line2", "line3"],
+  "arrayJoinWithInterpolation": ["you", "can", "{{myVar}}"],
+  "arrayOfObjects": [{ "name": "tom" }, { "name": "steve" }]
+}

package/translations/i18NextMessageExamples/en-us.json

@@ -0,0 +1,90 @@
+{
+  "basic": "basic",
+  "key": "Some format {{value, formatname}}",
+  "key_with_broken_de": "Some format {{value, formatname}}",
+  "keyWithOptions": "Some format {{value, formatname(option1Name: option1Value; option2Name: option2Value)}}",
+  "keyWithTwoFormatters": "Some format {{value, formatter1, formatter2}}",
+  "intlNumber": "Some {{val, number}}",
+  "intlNumber_broken_de": "Some {{val, number}}",
+  "intlNumberWithOptions": "Some {{val, number(minimumFractionDigits: 2)}}",
+  "intlCurrencyWithOptionsSimplified": "The value is {{val, currency(USD)}}",
+  "intlCurrencyWithOptions": "The value is {{val, currency(currency: USD)}}",
+  "twoIntlCurrencyWithUniqueFormatOptions": "The value is {{localValue, currency}} or {{altValue, currency}}",
+  "intlDateTime": "On the {{val, datetime}}",
+  "intlRelativeTime": "Lorem {{val, relativetime}}",
+  "intlRelativeTimeWithOptions": "Lorem {{val, relativetime(quarter)}}",
+  "intlRelativeTimeWithOptionsExplicit": "Lorem {{val, relativetime(range: quarter; style: narrow;)}}",
+  "intlList": "A list of {{val, list}}",
+  "legacyDateFormat": "The current date is {{date, MM/DD/YYYY}}",
+  "legacyUppercase": "{{text, uppercase}} just uppercased",
+  "key_one": "item",
+  "key_other": "items",
+  "keyWithCount_one": "{{count}} item",
+  "keyWithCount_other": "{{count}} items",
+  "key_zero": "zero",
+  "key_multiple_translations_one": "singular",
+  "key_multiple_translations_two": "two",
+  "key_multiple_translations_few": "few",
+  "key_multiple_translations_many": "many",
+  "key_multiple_translations_other": "other",
+  "key_ordinal_one": "{{count}}st place",
+  "key_ordinal_two": "{{count}}nd place",
+  "key_ordinal_few": "{{count}}rd place",
+  "key_ordinal_other": "{{count}}th place",
+  "key1_one": "{{count}} item",
+  "key1_other": "{{count}} items",
+  "key1_interval": "(1)[one item];(2-7)[a few items];(7-inf)[a lot of items];",
+  "key2_one": "{{count}} item",
+  "key2_other": "{{count}} items",
+  "key2_interval": "(1)[one item];(2-7)[a few items];",
+  "look": {
+    "deep": "value of look deep"
+  },
+  "error": {
+    "unspecific": "Something went wrong.",
+    "404": "The page was not found."
+  },
+  "key_interpolation": "{{what}} is {{how}}",
+  "key_with_data_model": "I am {{author.name}}",
+  "keyEscaped": "no danger {{myVar}}",
+  "keyUnescaped": "dangerous {{- myVar}}",
+  "nesting1": "1 $t(nesting2)",
+  "nesting2": "2 $t(nesting3)",
+  "nesting3": "3",
+  "optionsToNesting": "They have $t(that, {\"count\": {{that}} }) and $t(this, {\"count\": {{this}} })",
+  "this": "{{count}} of this",
+  "this_other": "{{count}} of these",
+  "that": "{{count}} of that",
+  "that_other": "{{count}} of those",
+  "animal": "An animal",
+  "animal_dog": "A dog",
+  "animal_cat": "A cat",
+  "animal_dog_one": "A dog",
+  "animal_cat_one": "A cat",
+  "animal_dog_other": "{{count}} dogs",
+  "animal_cat_other": "{{count}} cats",
+  "tree": {
+    "res": "added {{something}}"
+  },
+  "array": ["a", "b", "c"],
+  "arrayJoin": ["line1", "line2", "line3"],
+  "arrayJoinWithInterpolation": ["you", "can", "{{myVar}}"],
+  "arrayOfObjects": [{ "name": "tom" }, { "name": "steve" }],
+  "title": "Welcome to react using react-i18next",
+  "description.part1": "To get started, edit <1>src/App.js</1> and save to reload.",
+  "description.part2": "Switch language between english and german using buttons above.",
+  "icu": "{numPersons, plural, =0 {no persons} =1 {one person} other {# persons}}",
+  "icu_and_trans": "We invited <0>{numPersons, plural, =0 {no persons} =1 {one person} other {# persons}}</0>.",
+  "Welcome, {name}!": "Welcome, {name}!",
+  "Welcome, <0>{name}</0>!": "Welcome, <0>{name}</0>!",
+  "Trainers: {trainersCount, number}": "Trainers: {trainersCount, number}",
+  "Trainers: <0>{trainersCount, number}</0>!": "Trainers: <0>{trainersCount, number}</0>!",
+  "Caught on {catchDate, date, full}": "Caught on {catchDate, date, full}",
+  "Caught on <0>{catchDate, date, full}</0>!": "Caught on <0>{catchDate, date, full}</0>!",
+  "{gender, select,  male {He avoids bugs.} female {She avoids bugs.} other {They avoid bugs.}}": "{gender, select,  male {He avoids bugs.} female {She avoids bugs.} other {They avoid bugs.}}",
+  "{gender, select,  male {<0>He</0> avoids bugs.} female {<1>She</1> avoids bugs.} other {<2>They</2> avoid bugs.}}": "{gender, select,  male {<0>He</0> avoids bugs.} female {<1>She</1> avoids bugs.} other {<2>They</2> avoid bugs.}}",
+  "{itemsCount1, plural,  =0 {There is no item.} one {There is # item.} other {There are # items.}}": "{itemsCount1, plural,  =0 {There is no item.} one {There is # item.} other {There are # items.}}",
+  "{itemsCount2, plural,  =0 {There is no item.} one {There is # item.} other {There are # items.}}": "{itemsCount2, plural,  =0 {There is no item.} one {There is # item.} other {There are # items.}}",
+  "{itemsCount3, plural,  =0 {There is no item.} one {There is # item.} other {There are # items.}}": "{itemsCount3, plural,  =0 {There is no item.} one {There is # item.} other {There are # items.}}",
+  "testKey": "{itemsCount3, plural,  =0 { There is <0>no</0> item. } one { There is <1>#</1> item. } other { There are <2>#</2> items. }}"
+}