i18next 20.5.0 → 21.0.1

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

package/CHANGELOG.md

@@ -1,3 +1,25 @@
+### 21.0.1
+
+- fix typescript typo for skipOnVariables
+
+### 21.0.0
+
+**This is a major breaking release:**
+
+- introduce new v4 json format (intl plural forms with ordinal support), simplifyPluralSuffix not used anymore
+- `skipOnVariables` by default now is true
+- automatically detect natural language keys (no need to set nsSeparator or keySeparator to false)
+- remove deprecated whitelist features
+- introduce new i18next.resolvedLanguage property
+
+### 20.6.1
+
+- fix deepFind if looking for nesting array item
+
+### 20.6.0
+
+- feature: key prefix option [1644](https://github.com/i18next/i18next/pull/1644)
+
 ### 20.5.0
 
 - introduce missingKeyNoValueFallbackToKey option

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 i18next
+Copyright (c) 2021 i18next
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/cjs/i18next.js

@@ -298,6 +298,19 @@ function escape(data) {
   return data;
 }
 var isIE10 = typeof window !== 'undefined' && window.navigator && window.navigator.userAgent && window.navigator.userAgent.indexOf('MSIE') > -1;
+var chars = [' ', ',', '?', '!', ';'];
+function looksLikeObjectPath(key, nsSeparator, keySeparator) {
+  nsSeparator = nsSeparator || '';
+  keySeparator = keySeparator || '';
+  var possibleChars = chars.filter(function (c) {
+    return nsSeparator.indexOf(c) < 0 || keySeparator.indexOf(c) < 0;
+  });
+  if (possibleChars.length === 0) return true;
+  var r = new RegExp("(".concat(possibleChars.map(function (c) {
+    return c === '?' ? '\\?' : c;
+  }).join('|'), ")"));
+  return !r.test(key);
+}
 
 function deepFind(obj, path) {
   var keySeparator = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : '.';
@@ -307,6 +320,8 @@ function deepFind(obj, path) {
   var current = obj;
 
   for (var i = 0; i < paths.length; ++i) {
+    if (!current) return undefined;
+
     if (typeof current[paths[i]] === 'string' && i + 1 < paths.length) {
       return undefined;
     }
@@ -493,6 +508,15 @@ var ResourceStore = function (_EventEmitter) {
     value: function getDataByLanguage(lng) {
       return this.data[lng];
     }
+  }, {
+    key: "hasLanguageSomeTranslations",
+    value: function hasLanguageSomeTranslations(lng) {
+      var data = this.getDataByLanguage(lng);
+      var n = data && Object.keys(data) || [];
+      return !!n.find(function (v) {
+        return data[v] && Object.keys(data[v]).length > 0;
+      });
+    }
   }, {
     key: "toJSON",
     value: function toJSON() {
@@ -573,8 +597,10 @@ var Translator = function (_EventEmitter) {
       if (nsSeparator === undefined) nsSeparator = ':';
       var keySeparator = options.keySeparator !== undefined ? options.keySeparator : this.options.keySeparator;
       var namespaces = options.ns || this.options.defaultNS;
+      var wouldCheckForNsInKey = nsSeparator && key.indexOf(nsSeparator) > -1;
+      var seemsNaturalLanguage = !looksLikeObjectPath(key, nsSeparator, keySeparator);
 
-      if (nsSeparator && key.indexOf(nsSeparator) > -1) {
+      if (wouldCheckForNsInKey && !seemsNaturalLanguage) {
         var m = key.match(this.interpolator.nestingRegexp);
 
         if (m && m.length > 0) {
@@ -673,7 +699,7 @@ var Translator = function (_EventEmitter) {
         var usedKey = false;
         var needsPluralHandling = options.count !== undefined && typeof options.count !== 'string';
         var hasDefaultValue = Translator.hasDefaultValue(options);
-        var defaultValueSuffix = needsPluralHandling ? this.pluralResolver.getSuffix(lng, options.count) : '';
+        var defaultValueSuffix = needsPluralHandling ? this.pluralResolver.getSuffix(lng, options.count, options) : '';
         var defaultValue = options["defaultValue".concat(defaultValueSuffix)] || options.defaultValue;
 
         if (!this.isValidLookup(res) && hasDefaultValue) {
@@ -845,7 +871,7 @@ var Translator = function (_EventEmitter) {
               _this4.i18nFormat.addLookupKeys(finalKeys, key, code, ns, options);
             } else {
               var pluralSuffix;
-              if (needsPluralHandling) pluralSuffix = _this4.pluralResolver.getSuffix(code, options.count);
+              if (needsPluralHandling) pluralSuffix = _this4.pluralResolver.getSuffix(code, options.count, options);
               if (needsPluralHandling && needsContextHandling) finalKeys.push(finalKey + pluralSuffix);
               if (needsContextHandling) finalKeys.push(finalKey += "".concat(_this4.options.contextSeparator).concat(options.context));
               if (needsPluralHandling) finalKeys.push(finalKey += pluralSuffix);
@@ -909,7 +935,6 @@ var LanguageUtil = function () {
     _classCallCheck__default['default'](this, LanguageUtil);
 
     this.options = options;
-    this.whitelist = this.options.supportedLngs || false;
     this.supportedLngs = this.options.supportedLngs || false;
     this.logger = baseLogger.create('languageUtils');
   }
@@ -959,12 +984,6 @@ var LanguageUtil = function () {
 
       return this.options.cleanCode || this.options.lowerCaseLng ? code.toLowerCase() : code;
     }
-  }, {
-    key: "isWhitelisted",
-    value: function isWhitelisted(code) {
-      this.logger.deprecate('languageUtils.isWhitelisted', 'function "isWhitelisted" will be renamed to "isSupportedCode" in the next major - please make sure to rename it\'s usage asap.');
-      return this.isSupportedCode(code);
-    }
   }, {
     key: "isSupportedCode",
     value: function isSupportedCode(code) {
@@ -1217,6 +1236,15 @@ var _rulesPluralsTypes = {
     return Number(n == 1 ? 0 : n == 2 ? 1 : (n < 0 || n > 10) && n % 10 == 0 ? 2 : 3);
   }
 };
+var deprecatedJsonVersions = ['v1', 'v2', 'v3'];
+var suffixesOrder = {
+  zero: 0,
+  one: 1,
+  two: 2,
+  few: 3,
+  many: 4,
+  other: 5
+};
 
 function createRules() {
   var rules = {};
@@ -1251,19 +1279,38 @@ var PluralResolver = function () {
   }, {
     key: "getRule",
     value: function getRule(code) {
+      var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+
+      if (this.shouldUseIntlApi()) {
+        try {
+          return new Intl.PluralRules(code, {
+            type: options.ordinal ? 'ordinal' : 'cardinal'
+          });
+        } catch (_unused) {
+          return;
+        }
+      }
+
       return this.rules[code] || this.rules[this.languageUtils.getLanguagePartFromCode(code)];
     }
   }, {
     key: "needsPlural",
     value: function needsPlural(code) {
-      var rule = this.getRule(code);
+      var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      var rule = this.getRule(code, options);
+
+      if (this.shouldUseIntlApi()) {
+        return rule && rule.resolvedOptions().pluralCategories.length > 1;
+      }
+
       return rule && rule.numbers.length > 1;
     }
   }, {
     key: "getPluralFormsOfKey",
     value: function getPluralFormsOfKey(code, key) {
-      return this.getSuffixes(code).map(function (suffix) {
-        return key + suffix;
+      var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+      return this.getSuffixes(code, options).map(function (suffix) {
+        return "".concat(key).concat(suffix);
       });
     }
   }, {
@@ -1271,54 +1318,78 @@ var PluralResolver = function () {
     value: function getSuffixes(code) {
       var _this = this;
 
-      var rule = this.getRule(code);
+      var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      var rule = this.getRule(code, options);
 
       if (!rule) {
         return [];
       }
 
+      if (this.shouldUseIntlApi()) {
+        return rule.resolvedOptions().pluralCategories.sort(function (pluralCategory1, pluralCategory2) {
+          return suffixesOrder[pluralCategory1] - suffixesOrder[pluralCategory2];
+        }).map(function (pluralCategory) {
+          return "".concat(_this.options.prepend).concat(pluralCategory);
+        });
+      }
+
       return rule.numbers.map(function (number) {
-        return _this.getSuffix(code, number);
+        return _this.getSuffix(code, number, options);
       });
     }
   }, {
     key: "getSuffix",
     value: function getSuffix(code, count) {
-      var _this2 = this;
-
-      var rule = this.getRule(code);
+      var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+      var rule = this.getRule(code, options);
 
       if (rule) {
-        var idx = rule.noAbs ? rule.plurals(count) : rule.plurals(Math.abs(count));
-        var suffix = rule.numbers[idx];
-
-        if (this.options.simplifyPluralSuffix && rule.numbers.length === 2 && rule.numbers[0] === 1) {
-          if (suffix === 2) {
-            suffix = 'plural';
-          } else if (suffix === 1) {
-            suffix = '';
-          }
+        if (this.shouldUseIntlApi()) {
+          return "".concat(this.options.prepend).concat(rule.select(count));
         }
 
-        var returnSuffix = function returnSuffix() {
-          return _this2.options.prepend && suffix.toString() ? _this2.options.prepend + suffix.toString() : suffix.toString();
-        };
+        return this.getSuffixRetroCompatible(rule, count);
+      }
 
-        if (this.options.compatibilityJSON === 'v1') {
-          if (suffix === 1) return '';
-          if (typeof suffix === 'number') return "_plural_".concat(suffix.toString());
-          return returnSuffix();
-        } else if (this.options.compatibilityJSON === 'v2') {
-          return returnSuffix();
-        } else if (this.options.simplifyPluralSuffix && rule.numbers.length === 2 && rule.numbers[0] === 1) {
-          return returnSuffix();
+      this.logger.warn("no plural rule found for: ".concat(code));
+      return '';
+    }
+  }, {
+    key: "getSuffixRetroCompatible",
+    value: function getSuffixRetroCompatible(rule, count) {
+      var _this2 = this;
+
+      var idx = rule.noAbs ? rule.plurals(count) : rule.plurals(Math.abs(count));
+      var suffix = rule.numbers[idx];
+
+      if (this.options.simplifyPluralSuffix && rule.numbers.length === 2 && rule.numbers[0] === 1) {
+        if (suffix === 2) {
+          suffix = 'plural';
+        } else if (suffix === 1) {
+          suffix = '';
         }
+      }
 
-        return this.options.prepend && idx.toString() ? this.options.prepend + idx.toString() : idx.toString();
+      var returnSuffix = function returnSuffix() {
+        return _this2.options.prepend && suffix.toString() ? _this2.options.prepend + suffix.toString() : suffix.toString();
+      };
+
+      if (this.options.compatibilityJSON === 'v1') {
+        if (suffix === 1) return '';
+        if (typeof suffix === 'number') return "_plural_".concat(suffix.toString());
+        return returnSuffix();
+      } else if (this.options.compatibilityJSON === 'v2') {
+        return returnSuffix();
+      } else if (this.options.simplifyPluralSuffix && rule.numbers.length === 2 && rule.numbers[0] === 1) {
+        return returnSuffix();
       }
 
-      this.logger.warn("no plural rule found for: ".concat(code));
-      return '';
+      return this.options.prepend && idx.toString() ? this.options.prepend + idx.toString() : idx.toString();
+    }
+  }, {
+    key: "shouldUseIntlApi",
+    value: function shouldUseIntlApi() {
+      return !deprecatedJsonVersions.includes(this.options.compatibilityJSON);
     }
   }]);
 
@@ -1777,8 +1848,6 @@ function get() {
     defaultNS: ['translation'],
     fallbackLng: ['dev'],
     fallbackNS: false,
-    whitelist: false,
-    nonExplicitWhitelist: false,
     supportedLngs: false,
     nonExplicitSupportedLngs: false,
     load: 'all',
@@ -1833,7 +1902,7 @@ function get() {
       nestingSuffix: ')',
       nestingOptionsSeparator: ',',
       maxReplaces: 1000,
-      skipOnVariables: false
+      skipOnVariables: true
     }
   };
 }
@@ -1842,18 +1911,6 @@ function transformOptions(options) {
   if (typeof options.fallbackLng === 'string') options.fallbackLng = [options.fallbackLng];
   if (typeof options.fallbackNS === 'string') options.fallbackNS = [options.fallbackNS];
 
-  if (options.whitelist) {
-    if (options.whitelist && options.whitelist.indexOf('cimode') < 0) {
-      options.whitelist = options.whitelist.concat(['cimode']);
-    }
-
-    options.supportedLngs = options.whitelist;
-  }
-
-  if (options.nonExplicitWhitelist) {
-    options.nonExplicitSupportedLngs = options.nonExplicitWhitelist;
-  }
-
   if (options.supportedLngs && options.supportedLngs.indexOf('cimode') < 0) {
     options.supportedLngs = options.supportedLngs.concat(['cimode']);
   }
@@ -1915,12 +1972,12 @@ var I18n = function (_EventEmitter) {
         options = {};
       }
 
-      if (options.whitelist && !options.supportedLngs) {
-        this.logger.deprecate('whitelist', 'option "whitelist" will be renamed to "supportedLngs" in the next major - please make sure to rename this option asap.');
-      }
-
-      if (options.nonExplicitWhitelist && !options.nonExplicitSupportedLngs) {
-        this.logger.deprecate('whitelist', 'options "nonExplicitWhitelist" will be renamed to "nonExplicitSupportedLngs" in the next major - please make sure to rename this option asap.');
+      if (!options.defaultNS && options.ns) {
+        if (typeof options.ns === 'string') {
+          options.defaultNS = options.ns;
+        } else {
+          options.defaultNS = options.ns[0];
+        }
       }
 
       this.options = _objectSpread__default['default']({}, get(), this.options, transformOptions(options));
@@ -2139,10 +2196,26 @@ var I18n = function (_EventEmitter) {
       var deferred = defer();
       this.emit('languageChanging', lng);
 
+      var setLngProps = function setLngProps(l) {
+        _this4.language = l;
+        _this4.languages = _this4.services.languageUtils.toResolveHierarchy(l);
+        _this4.resolvedLanguage = undefined;
+        if (['cimode', 'dev'].indexOf(l) > -1) return;
+
+        for (var li = 0; li < _this4.languages.length; li++) {
+          var lngInLngs = _this4.languages[li];
+          if (['cimode', 'dev'].indexOf(lngInLngs) > -1) continue;
+
+          if (_this4.store.hasLanguageSomeTranslations(lngInLngs)) {
+            _this4.resolvedLanguage = lngInLngs;
+            break;
+          }
+        }
+      };
+
       var done = function done(err, l) {
         if (l) {
-          _this4.language = l;
-          _this4.languages = _this4.services.languageUtils.toResolveHierarchy(l);
+          setLngProps(l);
 
           _this4.translator.changeLanguage(l);
 
@@ -2169,8 +2242,7 @@ var I18n = function (_EventEmitter) {
 
         if (l) {
           if (!_this4.language) {
-            _this4.language = l;
-            _this4.languages = _this4.services.languageUtils.toResolveHierarchy(l);
+            setLngProps(l);
           }
 
           if (!_this4.translator.language) _this4.translator.changeLanguage(l);
@@ -2194,7 +2266,7 @@ var I18n = function (_EventEmitter) {
     }
   }, {
     key: "getFixedT",
-    value: function getFixedT(lng, ns) {
+    value: function getFixedT(lng, ns, keyPrefix) {
       var _this5 = this;
 
       var fixedT = function fixedT(key, opts) {
@@ -2213,7 +2285,9 @@ var I18n = function (_EventEmitter) {
         options.lng = options.lng || fixedT.lng;
         options.lngs = options.lngs || fixedT.lngs;
         options.ns = options.ns || fixedT.ns;
-        return _this5.t(key, options);
+        var keySeparator = _this5.options.keySeparator || '.';
+        var resultKey = keyPrefix ? "".concat(keyPrefix).concat(keySeparator).concat(key) : key;
+        return _this5.t(resultKey, options);
       };
 
       if (typeof lng === 'string') {
@@ -2223,6 +2297,7 @@ var I18n = function (_EventEmitter) {
       }
 
       fixedT.ns = ns;
+      fixedT.keyPrefix = keyPrefix;
       return fixedT;
     }
   }, {
@@ -2261,7 +2336,7 @@ var I18n = function (_EventEmitter) {
         return false;
       }
 
-      var lng = this.languages[0];
+      var lng = this.resolvedLanguage || this.languages[0];
       var fallbackLng = this.options ? this.options.fallbackLng : false;
       var lastLng = this.languages[this.languages.length - 1];
       if (lng.toLowerCase() === 'cimode') return true;
@@ -2329,7 +2404,7 @@ var I18n = function (_EventEmitter) {
   }, {
     key: "dir",
     value: function dir(lng) {
-      if (!lng) lng = this.languages && this.languages.length > 0 ? this.languages[0] : this.language;
+      if (!lng) lng = this.resolvedLanguage || (this.languages && this.languages.length > 0 ? this.languages[0] : this.language);
       if (!lng) return 'rtl';
       var rtlLngs = ['ar', 'shu', 'sqr', 'ssh', 'xaa', 'yhd', 'yud', 'aao', 'abh', 'abv', 'acm', 'acq', 'acw', 'acx', 'acy', 'adf', 'ads', 'aeb', 'aec', 'afb', 'ajp', 'apc', 'apd', 'arb', 'arq', 'ars', 'ary', 'arz', 'auz', 'avl', 'ayh', 'ayl', 'ayn', 'ayp', 'bbz', 'pga', 'he', 'iw', 'ps', 'pbt', 'pbu', 'pst', 'prp', 'prd', 'ug', 'ur', 'ydd', 'yds', 'yih', 'ji', 'yi', 'hbo', 'men', 'xmn', 'fa', 'jpr', 'peo', 'pes', 'prs', 'dv', 'sam'];
       return rtlLngs.indexOf(this.services.languageUtils.getLanguagePartFromCode(lng)) >= 0 ? 'rtl' : 'ltr';
@@ -2384,7 +2459,8 @@ var I18n = function (_EventEmitter) {
         options: this.options,
         store: this.store,
         language: this.language,
-        languages: this.languages
+        languages: this.languages,
+        resolvedLanguage: this.resolvedLanguage
       };
     }
   }]);