Issue 4871 - Start using ESLint for adblockplusui

ext/common.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2016 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-(function(global)
+"use strict";
+
 {
-  if (!global.ext)
-    global.ext = {};
+  if (typeof ext == "undefined")
+    window.ext = {};
 
   function Page(source)
   {
     this._source = source;
   }
   Page.prototype =
   {
-    sendMessage: function(message)
+    sendMessage(message)
     {
       this._source.postMessage({
         type: "message",
         messageId: -1,
         payload: message
       }, "*");
     }
   };
 
-  global.ext.Page = Page;
+  window.ext.Page = Page;
 
   /* Message passing */
 
-  global.ext.onMessage =
+  window.ext.onMessage =
   {
-    addListener: function(listener)
+    addListener(listener)
     {
       listener._extWrapper = function(event)
       {
         if (event.data.type != "message")
           return;
 
-        var message = event.data.payload;
-        var messageId = event.data.messageId;
-        var sender = {
+        let {messageId} = event.data;
+        let sender = {
           page: new Page(event.source)
         };
-        var callback = function(message)
+        let callback = function(message)
         {
           event.source.postMessage({
             type: "response",
-            messageId: messageId,
+            messageId,
             payload: message
           }, "*");
         };
-        listener(message, sender, callback);
+        listener(event.data.payload, sender, callback);
       };
       window.addEventListener("message", listener._extWrapper, false);
     },
 
-    removeListener: function(listener)
+    removeListener(listener)
     {
       if ("_extWrapper" in listener)
         window.removeEventListener("message", listener._extWrapper, false);
     }
   };
 
   /* I18n */
 
-  var getLocaleCandidates = function(selectedLocale)
+  let getLocaleCandidates = function(selectedLocale)
   {
-    var candidates = [];
-    var defaultLocale = "en-US";
+    let candidates = [];
+    let defaultLocale = "en-US";
 
     // e.g. "ja-jp-mac" -> "ja-JP", note that the part after the second
     // dash is dropped, since we only support language and region
-    var parts = selectedLocale.split("-");
-    var language = parts[0];
-    var region = (parts[1] || "").toUpperCase();
+    let parts = selectedLocale.split("-");
+    let language = parts[0];
+    let region = (parts[1] || "").toUpperCase();
 
     if (region)
       candidates.push(language + "-" + region);
 
     candidates.push(language);
 
     if (candidates.indexOf(defaultLocale) == -1)
       candidates.push(defaultLocale);
 
     return candidates;
   };
 
-  var initCatalog = function(uiLocale)
+  let initCatalog = function(uiLocale)
   {
-    var bidiDir = /^(ar|fa|he|ug|ur)(-|$)/.test(uiLocale) ? "rtl" : "ltr";
-    var catalog = Object.create(null);
+    let bidiDir = /^(ar|fa|he|ug|ur)(-|$)/.test(uiLocale) ? "rtl" : "ltr";
+    let catalog = Object.create(null);
 
     catalog["@@ui_locale"] = [uiLocale.replace(/-/g, "_"), []];
-    catalog["@@bidi_dir" ] = [bidiDir,  []];
+    catalog["@@bidi_dir"] = [bidiDir, []];
 
     return catalog;
   };
 
-  var selectedLocale = window.navigator.language;
-  var match = /[?&]locale=([\w\-]+)/.exec(window.location.search);
+  let selectedLocale = window.navigator.language;
+  let match = /[?&]locale=([\w-]+)/.exec(window.location.search);
   if (match)
     selectedLocale = match[1];
 
-  var locales = getLocaleCandidates(selectedLocale);
-  var catalog = initCatalog(locales[0]);
-  var catalogFile = window.location.pathname.replace(/.*\//, "").replace(/\..*/, "") + ".json";
+  let locales = getLocaleCandidates(selectedLocale);
+  let catalog = initCatalog(locales[0]);
+  let catalogFile = window.location.pathname.replace(/.*\//, "").
+    replace(/\..*/, "") + ".json";
 
-  var replacePlaceholder = function(text, placeholder, content)
+  let replacePlaceholder = function(text, placeholder, content)
   {
     return text.split("$" + placeholder + "$").join(content || "");
   };
 
-  var parseMessage = function(rawMessage)
+  let parseMessage = function(rawMessage)
   {
-    var text = rawMessage.message;
-    var placeholders = [];
+    let text = rawMessage.message;
+    let placeholders = [];
 
-    for (var placeholder in rawMessage.placeholders)
+    for (let placeholder in rawMessage.placeholders)
     {
-      var content = rawMessage.placeholders[placeholder].content;
+      let {content} = rawMessage.placeholders[placeholder];
 
       if (/^\$\d+$/.test(content))
         placeholders[parseInt(content.substr(1), 10) - 1] = placeholder;
       else
         text = replacePlaceholder(text, placeholder, content);
     }
 
     return [text, placeholders];
   };
 
-  var readCatalog = function(locale, catalogFile)
+  let readCatalog = function(locale, file)
   {
-    var xhr = new XMLHttpRequest();
-    xhr.open("GET", "locale/" + locale + "/" + catalogFile, false);
+    let xhr = new XMLHttpRequest();
+    xhr.open("GET", "locale/" + locale + "/" + file, false);
     xhr.overrideMimeType("text/plain");
 
     try
     {
       xhr.send();
     }
     catch (e)
     {
       return;
     }
 
     if (xhr.status != 200 && xhr.status != 0)
       return;
 
-    var rawCatalog = JSON.parse(xhr.responseText);
-    for (var msgId in rawCatalog)
+    let rawCatalog = JSON.parse(xhr.responseText);
+    for (let msgId in rawCatalog)
     {
       if (!(msgId in catalog))
         catalog[msgId] = parseMessage(rawCatalog[msgId]);
     }
   };
 
-  global.ext.i18n = {
-    getMessage: function(msgId, substitutions)
+  window.ext.i18n = {
+    getMessage(msgId, substitutions)
     {
+      /* eslint-disable no-constant-condition */

[Sebastian Noack, 2017/02/21 12:21:20]

As discussed in the changes for adblockpluscore, we should rather remove this
rule.

[kzar, 2017/02/23 11:10:22]

Done.

       while (true)
       {
-        var message = catalog[msgId];
+        let message = catalog[msgId];
         if (message)
         {
-          var text = message[0];
-          var placeholders = message[1];
+          let text = message[0];
+          let placeholders = message[1];
 
           if (!(substitutions instanceof Array))
             substitutions = [substitutions];
 
-          for (var i = 0; i < placeholders.length; i++)
+          for (let i = 0; i < placeholders.length; i++)
             text = replacePlaceholder(text, placeholders[i], substitutions[i]);
 
           return text;
         }
 
         if (locales.length == 0)
           return "";
 
-        var locale = locales.shift();
+        let locale = locales.shift();
         readCatalog(locale, "common.json");
         readCatalog(locale, catalogFile);
       }
+      /* eslint-enable no-constant-condition */
     }
   };
-})(this);
+}