Issue 4864 - Start using ESLint for adblockpluschrome

options.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/>.
  */
 
+/* global $, i18n, i18n_timeDateStrings */
+
 "use strict";
 
 /**
  * Creates a wrapping function used to conveniently send a type of message.
  *
  * @param {Object} baseMessage The part of the message that's always sent
- * @param {..string} paramKeys Any message keys that have dynamic values. The
- *                             returned function will take the corresponding
- *                             values as arguments.
- * @return The generated messaging function, optionally taking any values as
- *         specified by the paramKeys and finally an optional callback.
- *         (Although the value arguments are optional their index must be
- *          maintained. E.g. if you omit the first value you must omit the
- *          second too.)
+ * @param {...string} paramKeys Any message keys that have dynamic values. The
+ *                              returned function will take the corresponding
+ *                              values as arguments.
+ * @return {function} The generated messaging function, optionally
+ *                    taking any values as specified by the paramKeys
+ *                    and finally an optional callback.  (Although the
+ *                    value arguments are optional their index must be
+ *                    maintained. E.g. if you omit the first value you
+ *                    must omit the second too.)
  */
-function wrapper(baseMessage /* , [paramKeys] */)
+function wrapper(baseMessage, ...paramKeys)

[Sebastian Noack, 2017/02/09 01:04:51]

How about calling the rest arguments just "args" as you did elsewhere?

[kzar, 2017/02/20 10:27:33]

Since paramKeys is a more useful name. (I used `args` elsewhere when I couldn't
think of a better name, but I wasn't too happy about doing so.)

The function that wrapper returns accepts parameters based upon the names given
by paramKeys. The paramKeys and passed in paramValues are then combined into the
message Object which is sent. I think renaming paramKeys to args would make that
less clear.

 {
-  let paramKeys = [];
-  for (let i = 1; i < arguments.length; i++)
-    paramKeys.push(arguments[i]);
-
-  return function(/* [paramValues], callback */)
+  return function(...paramValues /* , callback */)
   {
     let message = Object.create(null);
     for (let key in baseMessage)
+    {
       if (baseMessage.hasOwnProperty(key))
         message[key] = baseMessage[key];
+    }
 
-    let paramValues = [];
     let callback;
 
-    if (arguments.length > 0)
+    if (paramValues.length > 0)
     {
-      let lastArg = arguments[arguments.length - 1];
+      let lastArg = paramValues[paramValues.length - 1];
       if (typeof lastArg == "function")
         callback = lastArg;
 
-      for (let i = 0; i < arguments.length - (callback ? 1 : 0); i++)
-        message[paramKeys[i]] = arguments[i];
+      for (let i = 0; i < paramValues.length - (callback ? 1 : 0); i++)
+        message[paramKeys[i]] = paramValues[i];
     }
 
     ext.backgroundPage.sendMessage(message, callback);
   };
 }
 
 const getDocLink = wrapper({type: "app.get", what: "doclink"}, "link");
 const getInfo = wrapper({type: "app.get"}, "what");
 const getPref = wrapper({type: "prefs.get"}, "key");
 const togglePref = wrapper({type: "prefs.toggle"}, "key");
 const getSubscriptions = wrapper({type: "subscriptions.get"},
                                  "downloadable", "special");
 const removeSubscription = wrapper({type: "subscriptions.remove"}, "url");
 const addSubscription = wrapper({type: "subscriptions.add"},
                                 "url", "title", "homepage");
 const toggleSubscription = wrapper({type: "subscriptions.toggle"},
                                    "url", "keepInstalled");
 const updateSubscription = wrapper({type: "subscriptions.update"}, "url");
 const importRawFilters = wrapper({type: "filters.importRaw"},
                                  "text", "removeExisting");
 const addFilter = wrapper({type: "filters.add"}, "text");
 const getFilters = wrapper({type: "filters.get"}, "subscriptionUrl");
 const removeFilter = wrapper({type: "filters.remove"}, "text");
 
-const whitelistedDomainRegexp = /^@@\|\|([^\/:]+)\^\$document$/;
+const whitelistedDomainRegexp = /^@@\|\|([^/:]+)\^\$document$/;
+const statusMessages = new Map([
+   ["synchronize_invalid_url",
+    "filters_subscription_lastDownload_invalidURL"],
+   ["synchronize_connection_error",
+    "filters_subscription_lastDownload_connectionError"],
+   ["synchronize_invalid_data",
+    "filters_subscription_lastDownload_invalidData"],
+   ["synchronize_checksum_mismatch",
+    "filters_subscription_lastDownload_checksumMismatch"]
+]);
+
 let delayedSubscriptionSelection = null;
-
 let acceptableAdsUrl;
 
 // Loads options from localStorage and sets UI elements accordingly
 function loadOptions()
 {
   // Set page title to i18n version of "Adblock Plus Options"
   document.title = i18n.getMessage("options");
 
   // Set links
   getPref("subscriptions_exceptionsurl", url =>
@@ skipping 46 matching lines @@
   // Popuplate option checkboxes
   initCheckbox("shouldShowBlockElementMenu");
   initCheckbox("show_devtools_panel");
   initCheckbox("shouldShowNotifications", "notifications_ignoredcategories");
 
   getInfo("features", features =>
   {
     if (!features.devToolsPanel)
       document.getElementById("showDevtoolsPanelContainer").hidden = true;
   });
-  getPref("notifications_showui", notifications_showui =>
+  getPref("notifications_showui", showNotificationsUI =>
   {
-    if (!notifications_showui)
+    if (!showNotificationsUI)
       document.getElementById("shouldShowNotificationsContainer").hidden = true;
   });
 
   // Register listeners in the background message responder
   ext.backgroundPage.sendMessage({
     type: "app.listen",
     filter: ["addSubscription", "focusSection"]
   });
-  ext.backgroundPage.sendMessage(
-  {
+  ext.backgroundPage.sendMessage({
     type: "filters.listen",
     filter: ["added", "loaded", "removed"]
   });
-  ext.backgroundPage.sendMessage(
-  {
+  ext.backgroundPage.sendMessage({
     type: "prefs.listen",
     filter: ["notifications_ignoredcategories", "notifications_showui",
              "show_devtools_panel", "shouldShowBlockElementMenu"]
   });
-  ext.backgroundPage.sendMessage(
-  {
+  ext.backgroundPage.sendMessage({
     type: "subscriptions.listen",
     filter: ["added", "disabled", "homepage", "lastDownload", "removed",
              "title", "downloadStatus", "downloading"]
   });
 
   // Load recommended subscriptions
   loadRecommendations();
 
   // Show user's filters
   reloadFilters();
@@ skipping 122 matching lines @@
 
       let option = new Option();
       let label = i18n.getMessage("filters_addSubscriptionOther_label");
       option.text = label + "\u2026";
       option._data = null;
       list.appendChild(option);
 
       list.selectedIndex = selectedIndex;
 
       if (delayedSubscriptionSelection)
-        startSubscriptionSelection.apply(null, delayedSubscriptionSelection);
+        startSubscriptionSelection(...delayedSubscriptionSelection);
     });
 }
 
 function startSubscriptionSelection(title, url)
 {
   let list = document.getElementById("subscriptionSelector");
   if (list.length == 0)
   {
     delayedSubscriptionSelection = [title, url];
     return;
@@ skipping 11 matching lines @@
   }
   updateSubscriptionSelection();
   document.getElementById("addSubscriptionContainer").scrollIntoView(true);
 }
 
 function updateSubscriptionSelection()
 {
   let list = document.getElementById("subscriptionSelector");
   let data = list.options[list.selectedIndex]._data;
   if (data)
+  {
     $("#customSubscriptionContainer").hide();
+  }
   else
   {
     $("#customSubscriptionContainer").show();
     $("#customSubscriptionTitle").focus();
   }
 }
 
 function addSubscriptionClicked()
 {
   let list = document.getElementById("subscriptionSelector");
   let data = list.options[list.selectedIndex]._data;
   if (data)
+  {
     addSubscription(data.url, data.title, data.homepage);
+  }
   else
   {
-    let url = document.getElementById("customSubscriptionLocation").value.trim();
+    let url = document.getElementById("customSubscriptionLocation")
+      .value.trim();
     if (!/^https?:/i.test(url))
     {
       alert(i18n.getMessage("global_subscription_invalid_location"));
       $("#customSubscriptionLocation").focus();
       return;
     }
 
     let title = document.getElementById("customSubscriptionTitle").value.trim();
     if (!title)
       title = url;
 
     addSubscription(url, title, null);
   }
 
   $("#addSubscriptionContainer").hide();
   $("#customSubscriptionContainer").hide();
   $("#addSubscriptionButton").show();
 }
 
 function toggleAcceptableAds()
 {
   toggleSubscription(acceptableAdsUrl, true);
 }
 
 function findSubscriptionElement(subscription)
 {
   for (let child of document.getElementById("filterLists").childNodes)
+  {
     if (child._subscription.url == subscription.url)
       return child;
+  }
   return null;
 }
 
 function updateSubscriptionInfo(element, subscription)
 {
   if (subscription)
     element._subscription = subscription;
   else
     subscription = element._subscription;
 
   let title = element.getElementsByClassName("subscriptionTitle")[0];
   title.textContent = subscription.title;
   title.setAttribute("title", subscription.url);
   if (subscription.homepage)
     title.href = subscription.homepage;
   else
     title.href = subscription.url;
 
   let enabled = element.getElementsByClassName("subscriptionEnabled")[0];
   enabled.checked = !subscription.disabled;
 
   let lastUpdate = element.getElementsByClassName("subscriptionUpdate")[0];
   lastUpdate.classList.remove("error");
 
-  let downloadStatus = subscription.downloadStatus;
+  let {downloadStatus} = subscription;
   if (subscription.isDownloading)
   {
-    lastUpdate.textContent = i18n.getMessage("filters_subscription_lastDownload_inProgress");
+    lastUpdate.textContent = i18n.getMessage(
+      "filters_subscription_lastDownload_inProgress"
+    );
   }
   else if (downloadStatus && downloadStatus != "synchronize_ok")
   {
-     let map =
-     {
-       "synchronize_invalid_url": "filters_subscription_lastDownload_invalidURL",
-       "synchronize_connection_error": "filters_subscription_lastDownload_connectionError",
-       "synchronize_invalid_data": "filters_subscription_lastDownload_invalidData",
-       "synchronize_checksum_mismatch": "filters_subscription_lastDownload_checksumMismatch"
-     };
-     if (downloadStatus in map)
-       lastUpdate.textContent = i18n.getMessage(map[downloadStatus]);
-     else
-       lastUpdate.textContent = downloadStatus;
-     lastUpdate.classList.add("error");
+    if (statusMessages.has(downloadStatus))
+    {
+      lastUpdate.textContent = i18n.getMessage(
+        statusMessages.get(downloadStatus)
+      );
+    }
+    else
+    {
+      lastUpdate.textContent = downloadStatus;
+    }
+    lastUpdate.classList.add("error");
   }
   else if (subscription.lastDownload > 0)
   {
     let timeDate = i18n_timeDateStrings(subscription.lastDownload * 1000);
     let messageID = (timeDate[1] ? "last_updated_at" : "last_updated_at_today");
     lastUpdate.textContent = i18n.getMessage(messageID, timeDate);
   }
 }
 
 function onSubscriptionMessage(action, subscription)
@@ skipping 26 matching lines @@
         element.parentNode.removeChild(element);
       break;
   }
 }
 
 function onPrefMessage(key, value)
 {
   switch (key)
   {
     case "notifications_showui":
-      document.getElementById("shouldShowNotificationsContainer").hidden = !value;
+      document.getElementById(
+        "shouldShowNotificationsContainer"
+      ).hidden = !value;
       return;
     case "notifications_ignoredcategories":
       key = "shouldShowNotifications";
       value = value.indexOf("*") == -1;
       break;
   }
   let checkbox = document.getElementById(key);
   if (checkbox)
     checkbox.checked = value;
 }
@@ skipping 36 matching lines @@
   let list = document.getElementById(boxId);
   let selector = "option[value=" + CSS.escape(text) + "]";
   for (let option of list.querySelectorAll(selector))
     list.removeChild(option);
 }
 
 function addWhitelistDomain(event)
 {
   event.preventDefault();
 
-  let domain = document.getElementById("newWhitelistDomain").value.replace(/\s/g, "");
+  let domain = document.getElementById(
+    "newWhitelistDomain"
+  ).value.replace(/\s/g, "");
   document.getElementById("newWhitelistDomain").value = "";
   if (!domain)
     return;
 
   let filterText = "@@||" + domain + "^$document";
   addFilter(filterText);
 }
 
 // Adds filter text that user typed to the selection box
 function addTypedFilter(event)
 {
   event.preventDefault();
 
   let element = document.getElementById("newFilter");
   addFilter(element.value, errors =>
   {
     if (errors.length > 0)
       alert(errors.join("\n"));
     else
       element.value = "";
   });
 }
 
 // Removes currently selected whitelisted domains
 function removeSelectedExcludedDomain(event)
 {
   event.preventDefault();
   let remove = [];
   for (let option of document.getElementById("excludedDomainsBox").options)
+  {
     if (option.selected)
       remove.push(option.value);
+  }
   if (!remove.length)
     return;
 
   for (let domain of remove)
     removeFilter("@@||" + domain + "^$document");
 }
 
 // Removes all currently selected filters
 function removeSelectedFilters(event)
 {
   event.preventDefault();
-  for (let option of document.querySelectorAll("#userFiltersBox > option:checked"))
+  let options = document.querySelectorAll("#userFiltersBox > option:checked");
+  for (let option of options)
     removeFilter(option.value);
 }
 
 // Shows raw filters box and fills it with the current user filters
 function toggleFiltersInRawFormat(event)
 {
   event.preventDefault();
 
   let rawFilters = document.getElementById("rawFilters");
   let filters = [];
@@ skipping 34 matching lines @@
 }
 
 // Adds a subscription entry to the UI.
 function addSubscriptionEntry(subscription)
 {
   let template = document.getElementById("subscriptionTemplate");
   let element = template.cloneNode(true);
   element.removeAttribute("id");
   element._subscription = subscription;
 
-  let removeButton = element.getElementsByClassName("subscriptionRemoveButton")[0];
+  let removeButton = element.getElementsByClassName(
+    "subscriptionRemoveButton"
+  )[0];
   removeButton.setAttribute("title", removeButton.textContent);
   removeButton.textContent = "\xD7";
   removeButton.addEventListener("click", () =>
   {
     if (!confirm(i18n.getMessage("global_remove_subscription_warning")))
       return;
 
     removeSubscription(subscription.url);
   }, false);
 
   getPref("additional_subscriptions", additionalSubscriptions =>
   {
     if (additionalSubscriptions.indexOf(subscription.url) != -1)
       removeButton.style.visibility = "hidden";
   });
 
   let enabled = element.getElementsByClassName("subscriptionEnabled")[0];
   enabled.addEventListener("click", () =>
   {
     subscription.disabled = !subscription.disabled;
     toggleSubscription(subscription.url, true);
   }, false);
 
   updateSubscriptionInfo(element);
 
   document.getElementById("filterLists").appendChild(element);
 }
 
-function setLinks(id)
+function setLinks(id, ...args)
 {
   let element = document.getElementById(id);
   if (!element)
     return;
 
   let links = element.getElementsByTagName("a");
   for (let i = 0; i < links.length; i++)
   {
-    if (typeof arguments[i + 1] == "string")
+    if (typeof args[i] == "string")
     {
-      links[i].href = arguments[i + 1];
+      links[i].href = args[i];
       links[i].setAttribute("target", "_blank");
     }
-    else if (typeof arguments[i + 1] == "function")
+    else if (typeof args[i] == "function")
     {
       links[i].href = "javascript:void(0);";
-      links[i].addEventListener("click", arguments[i + 1], false);
+      links[i].addEventListener("click", args[i], false);
     }
   }
 }
 
 ext.onMessage.addListener(message =>
 {
   switch (message.type)
   {
     case "app.respond":
       switch (message.action)
@@ skipping 26 matching lines @@
       onFilterMessage(message.action, message.args[0]);
       break;
     case "prefs.respond":
       onPrefMessage(message.action, message.args[0]);
       break;
     case "subscriptions.respond":
       onSubscriptionMessage(message.action, message.args[0]);
       break;
   }
 });