bugfixes

Author: Kamil Tunkiewicz

README.md

@@ -1,6 +1,6 @@
 # Webpack Extract Translation Keys Plugin (Regex version)
 
-> This plugin was inspired by [webpack-extract-translation-keys](https://github.com/grassator/webpack-extract-translation-keys). It works in a completely different way, but it shares the concept and some of the source code, so I leave the original copyright info in files.  
+> This plugin is based on [webpack-extract-translation-keys](https://github.com/grassator/webpack-extract-translation-keys). It works in a completely different way, but it shares the concept and some of the source code, so I leave the original copyright info in files.  
   
 Webpack provides an official plugin for managing translation using [i18n-webpack-plugin](https://github.com/webpack/i18n-webpack-plugin), but in only allows for build-time translations by replacing strings in the source code.
 
@@ -121,14 +121,19 @@ Default value: `/gettext\(\s*(?:"([^"\\]*(?:\\.[^"\\]*)*)(")|'([^'\\]*(?:\\.[^'\
 
 This should be a regular expression object or simply a string. Plugin will internally enforce "g" and "m" flags on the provided regexp.
 
-The expression must have at least one outputting group block. By default the first group block one is considered to be the translation key.
+The expression must have at least one outputting group block.
+
+By default the first and third group block one is considered to be the translation key. That's because of the default `functionPattern` that matches two versions of `gettext` - with `"` and `'` quotes used.
+
 You can change this to be any block by modifying the `groupIndex` option.
 
 #### - `groupIndex`
 
-Default value: 1
+Default value: [1, 3]
 
-Specifies which group block from `functionPattern` contains the translation key. 
+Specifies which group block from `functionPattern` contains the translation key. This can be integer or array of integers.
+ 
+If multiple indexes are provided - the first group which returns a value will be used. At least one group must return value unless plugin will throw an error.  
 
 #### - `moduleFilter`
 
@@ -247,10 +252,12 @@ Enables mangling of translation keys. When enabled the `functionReplace` option
 
 #### - `functionReplace`
 
-Default value: `gettext($2$1$2`
+Default value: `gettext($2$4$1$3$2$4`
 
 This option specifies the replacement for the `functionPattern` when mangling translation keys. It is required if you use mangling.
 
+Please note that if some group returns `undefined` it is changed to empty string, so you can easily use output from multiple groups even if they don't match anything in the string.  
+
 You can also use this option to change the function name if you like to.
 
 #### - `done`

index.js

@@ -26,16 +26,20 @@ var fs = require('fs');
  */
 function ExtractTranslationRegexPlugin(options) {
     options = options || {};
-    if (options.functionPattern && !options.functionReplace) {
-        throw new Error("ExtractTranslationRegexPlugin: If you provide functionPattern, you must provide functionReplace");
-    }
     this.functionPattern = options.functionPattern || /gettext\(\s*(?:"([^"\\]*(?:\\.[^"\\]*)*)(")|'([^'\\]*(?:\\.[^'\\]*)*)('))/gm;
-    this.functionReplace = options.functionReplace || 'gettext($2$1$2';
-    this.groupIndex = 1;
+    this.functionReplace = options.functionReplace || 'gettext($2$4$1$3$2$4';
+    this.groupIndex = options.groupIndex || [ 1, 3 ];
     this.done = options.done || function () {};
     this.output = typeof options.output === 'string' ? options.output : false;
     this.mangle = options.mangle || false;
     this.moduleFilter = options.moduleFilter || [ /((?:[^!?\s]+?)(?:\.js|\.jsx|\.ts))$/, /^((?!node_modules).)*$/ ]
+
+    if (options.functionPattern && !options.functionReplace) {
+        throw new Error("ExtractTranslationRegexPlugin: If you provide functionPattern, you must provide functionReplace");
+    }
+    if (typeof this.groupIndex !== 'object') {
+        this.groupIndex = [ this.groupIndex ];
+    }
 }
 
 ExtractTranslationRegexPlugin.prototype.apply = function(compiler) {
@@ -59,15 +63,16 @@ ExtractTranslationRegexPlugin.prototype.apply = function(compiler) {
                         // iterating keys found in module
                         var match;
                         while ((match = regex.exec(source)) !== null) {
-                            if (!match[this.groupIndex]) {
+                            var keyIndex = getKeyIndexFromMatch(match, this.groupIndex);
+                            if (keyIndex === -1) {
                                 compilation.errors.push(
                                     new Error("ExtractTranslationRegexPlugin: The provided `functionPattern` regular expression do not contain capture block. Please check your webpack.config.js file.")
                                 );
                                 return false;
                             }
 
                             var original = match[0];
-                            var value = match[this.groupIndex];
+                            var value = match[keyIndex];
                             var key = value;
 
                             // saving translation key per module
@@ -83,14 +88,25 @@ ExtractTranslationRegexPlugin.prototype.apply = function(compiler) {
                             if (this.mangle) {
                                 // build the replacement with new (mangled) key
                                 var replacement = this.functionReplace;
-                                var tmpMatch = match;
-                                tmpMatch[this.groupIndex] = key;
+                                var tmpMatch = match.slice(0);
                                 for (var i = 1; i < tmpMatch.length; i++) {
-                                    replacement = replacement.replace(new RegExp('\$' + i, 'g'), tmpMatch[i])
+                                    if (typeof tmpMatch[i] == 'undefined') {
+                                        tmpMatch[i] = '';
+                                    } else {
+                                        // if the match is translation key
+                                        if (this.groupIndex.indexOf(i) !== -1) {
+                                            if (i == keyIndex) {
+                                                tmpMatch[i] = key;
+                                            } else {
+                                                tmpMatch[i] = '';
+                                            }
+                                        }
+                                    }
+                                    replacement = replacement.replace(new RegExp('\\$' + i, 'g'), tmpMatch[i])
                                 }
                                 source = source.replace(
                                     new RegExp(sanitizeForRegexp(original), 'gm'),
-                                    this.functionReplace
+                                    replacement
                                 );
                             }
                         }
@@ -200,4 +216,20 @@ var flipObject = function (obj) {
     return newObj;
 };
 
+/**
+ * Gets translation key from match according to `groupIndex` data
+ * @param {Array} match
+ * @param {Array} groupIndex
+ * @returns {int}
+ */
+var getKeyIndexFromMatch = function(match, groupIndex) {
+    for (var i in groupIndex) {
+        var index = groupIndex[i];
+        if (match[index]) {
+            return index;
+        }
+    }
+    return -1;
+};
+
 module.exports = ExtractTranslationRegexPlugin;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "webpack-extract-translation-keys-regex-plugin",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Webpack plugin to extract list of used translation keys from included modules, using regular expressions.",
   "main": "index.js",
   "files": [