Merge pull request Spittal#146 from JamesBoon/feat/brackets-and-parentheses-matching

Match parentheses and brackets

Author: Spittal

src/create-report/vue-files.ts

@@ -46,9 +46,10 @@ function* getMatches (file: SimpleFile, regExp: RegExp, captureGroup = 1): Itera
 /**
  * Extracts translation keys from methods such as `$t` and `$tc`.
  *
- * - **regexp pattern**: (?:[$ .]tc?)\(
+ * - **regexp pattern**: (?:[$\s.:"'`+\(\[\{]t[cm]?)\(
  *
- *   **description**: Matches the sequence t( or tc(, optionally with either “$”, “.” or “ ” in front of it.
+ *   **description**: Matches the sequence t(, tc( or tm(, optionally with either “$”, SPACE, “.”, “:”, “"”, “'”,
+ *   “`”, "+", "(", "[" or "{" in front of it.
  *
  * - **regexp pattern**: (["'`])
  *
@@ -67,7 +68,7 @@ function* getMatches (file: SimpleFile, regExp: RegExp, captureGroup = 1): Itera
  * @returns a list of translation keys found in `file`.
  */
  function extractMethodMatches (file: SimpleFile): I18NItemWithBounding[] {
-  const methodRegExp = /(?:[$ ."'`]t[cm]?)\(\s*?(["'`])((?:[^\\]|\\.)*?)\1/g;
+  const methodRegExp = /(?:[$\s.:"'`+\(\[\{]t[cm]?)\(\s*?(["'`])((?:[^\\]|\\.)*?)\1/g;
   return [ ...getMatches(file, methodRegExp, 2) ];
 }
 

tests/fixtures/expected-values.ts

@@ -118,12 +118,54 @@ export const expectedFromParsedVueFiles = [
     file: './tests/fixtures/vue-files/edge-cases.js',
     line: 5
   },
+  {
+    path: 'parentheses',
+    previousCharacter: "'",
+    nextCharacter: "'",
+    file: './tests/fixtures/vue-files/edge-cases.js',
+    line: 7
+  },
+  {
+    path: 'square brackets',
+    previousCharacter: "'",
+    nextCharacter: "'",
+    file: './tests/fixtures/vue-files/edge-cases.js',
+    line: 8
+  },
+  {
+    path: 'curly brackets',
+    previousCharacter: "'",
+    nextCharacter: "'",
+    file: './tests/fixtures/vue-files/edge-cases.js',
+    line: 9
+  },
+  {
+    path: 'colon',
+    previousCharacter: "'",
+    nextCharacter: "'",
+    file: './tests/fixtures/vue-files/edge-cases.js',
+    line: 10
+  },
+  {
+    path: 'concatenation',
+    previousCharacter: "'",
+    nextCharacter: "'",
+    file: './tests/fixtures/vue-files/edge-cases.js',
+    line: 12
+  },
+  {
+    path: 'leading tab',
+    previousCharacter: "'",
+    nextCharacter: "'",
+    file: './tests/fixtures/vue-files/edge-cases.js',
+    line: 13
+  },
   {
     path: '${dynamicKey}',
     previousCharacter: '`',
     nextCharacter: '`',
     file: './tests/fixtures/vue-files/edge-cases.js',
-    line: 8
+    line: 16
   },
   {
     path: 'header.title',
@@ -325,6 +367,42 @@ export const expectedI18NReport = {
       line: 5,
       language: 'de_DE'
     },
+    {
+      path: 'parentheses',
+      file: './tests/fixtures/vue-files/edge-cases.js',
+      line: 7,
+      language: 'de_DE'
+    },
+    {
+      path: 'square brackets',
+      file: './tests/fixtures/vue-files/edge-cases.js',
+      line: 8,
+      language: 'de_DE'
+    },
+    {
+      path: 'curly brackets',
+      file: './tests/fixtures/vue-files/edge-cases.js',
+      line: 9,
+      language: 'de_DE'
+    },
+    {
+      path: 'colon',
+      file: './tests/fixtures/vue-files/edge-cases.js',
+      line: 10,
+      language: 'de_DE'
+    },
+    {
+      path: 'concatenation',
+      file: './tests/fixtures/vue-files/edge-cases.js',
+      line: 12,
+      language: 'de_DE'
+    },
+    {
+      path: 'leading tab',
+      file: './tests/fixtures/vue-files/edge-cases.js',
+      line: 13,
+      language: 'de_DE'
+    },
     {
       path: 'header.paragraphs.p_1',
       file: './tests/fixtures/vue-files/js-component.js',
@@ -361,6 +439,42 @@ export const expectedI18NReport = {
       line: 5,
       language: 'en_EN'
     },
+    {
+      path: 'parentheses',
+      file: './tests/fixtures/vue-files/edge-cases.js',
+      line: 7,
+      language: 'en_EN'
+    },
+    {
+      path: 'square brackets',
+      file: './tests/fixtures/vue-files/edge-cases.js',
+      line: 8,
+      language: 'en_EN'
+    },
+    {
+      path: 'curly brackets',
+      file: './tests/fixtures/vue-files/edge-cases.js',
+      line: 9,
+      language: 'en_EN'
+    },
+    {
+      path: 'colon',
+      file: './tests/fixtures/vue-files/edge-cases.js',
+      line: 10,
+      language: 'en_EN'
+    },
+    {
+      path: 'concatenation',
+      file: './tests/fixtures/vue-files/edge-cases.js',
+      line: 12,
+      language: 'en_EN'
+    },
+    {
+      path: 'leading tab',
+      file: './tests/fixtures/vue-files/edge-cases.js',
+      line: 13,
+      language: 'en_EN'
+    },
     {
       path: 'header.paragraphs.p_1',
       file: './tests/fixtures/vue-files/js-component.js',
@@ -398,7 +512,7 @@ export const expectedI18NReport = {
     {
       path: '${dynamicKey}',
       file: './tests/fixtures/vue-files/edge-cases.js',
-      line: 8
+      line: 16
     }
   ]
 }

tests/fixtures/vue-files/edge-cases.js

@@ -4,10 +4,22 @@ $t("single \" quote");
 $t(`back \` tick`);
 $t('Early ' string termination');
 
+someFn(t('parentheses'));
+const arr = [t('square brackets')];
+const obj1 = {t('curly brackets')};
+const obj2 = {v:t('colon')};
+
+'start'+t('concatenation')+'end'
+	t('leading tab') // make sure autoformat does not remove the leading tab!
+
 // Should be suspected dynamic
 <p>{{ t(`${dynamicKey}`) }}</p>
 
 // Should not match
 gt("FALSE POSITIVE 1");
 ;t("FALSE POSITIVE 2");
+-t("FALSE POSITIVE 3");
+_t("FALSE POSITIVE 4");
+w0t("FALSE POSITIVE 5");
+ಠ_ಠt("FALSE POSITIVE 6");
 t(dynamicKey)

tests/unit/create-report/language-files.spec.ts

@@ -29,7 +29,7 @@ describe('file: create-report/language-files', () => {
       writeFileSyncSpy.mockImplementation(() => jest.fn());
       const dotStrSpy = jest.spyOn(dot, 'str');
       writeMissingToLanguageFiles(readLanguageFiles(languageFiles), expectedI18NReport.missingKeys);
-      expect(dotStrSpy).toHaveBeenCalledTimes(18);
+      expect(dotStrSpy).toHaveBeenCalledTimes(36);
       expect(writeFileSyncSpy).toHaveBeenCalledTimes(3);
       expect(writeFileSyncSpy.mock.calls[0][1]).toContain('missing');
     });