Issue 4878 - Start using ESLint for adblockpluscore

lib/elemHide.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/>.
  */
 
 "use strict";
 
 /**
  * @fileOverview Element hiding implementation.
  */
 
-let {Utils} = require("utils");
-let {ElemHideException} = require("filterClasses");
-let {FilterNotifier} = require("filterNotifier");
+const {ElemHideException} = require("filterClasses");
+const {FilterNotifier} = require("filterNotifier");
 
 /**
  * Lookup table, filters by their associated key
  * @type {Object}
  */
 let filterByKey = [];
 
 /**
  * Lookup table, keys of the filters by filter text
  * @type {Object}
@@ skipping 182 matching lines @@
       this._removeFilterKey(key, filter);
     }
 
     FilterNotifier.emit("elemhideupdate");
   },
 
   /**
    * Checks whether an exception rule is registered for a filter on a particular
    * domain.
    * @param {Filter} filter
-   * @param {String} docDomain
+   * @param {string} docDomain
    * @return {ElemHideException}
    */
   getException(filter, docDomain)
   {
     if (!(filter.selector in exceptions))
       return null;
 
     let list = exceptions[filter.selector];
     for (let i = list.length - 1; i >= 0; i--)
     {
       if (list[i].isActiveOnDomain(docDomain))
         return list[i];
     }
 
     return null;
   },
 
   /**
    * Retrieves an element hiding filter by the corresponding protocol key
-   * @param {Number} key
+   * @param {number} key
    * @return {Filter}
    */
   getFilterByKey(key)
   {
     return (key in filterByKey ? filterByKey[key] : null);
   },
 
   /**
    * Returns a list of all selectors as a nested map. On first level, the keys
    * are all values of `ElemHideBase.selectorDomain` (domains on which these
    * selectors should apply, ignoring exceptions). The values are maps again,
    * with the keys being selectors and values the corresponding filter keys.
    * @returns {Map.<String,Map<String,String>>}
    */
   getSelectors()
   {
     let domains = new Map();
     for (let key in filterByKey)
     {
       let filter = filterByKey[key];
-      let {selector} = filter;

[Sebastian Noack, 2017/02/20 13:14:51]

Perhaps just inline filter.selector, in the two occurrences below. This
temporary variable seems kinda unnecessary.

[kzar, 2017/02/21 06:13:58]

Seems like kind of an unrelated change, would rather leave it.

[Sebastian Noack, 2017/02/21 09:19:30]

Well, it's not unrelated, because in order to make ESLint happy we either have
to use destructing or inline the property lookup. I think the latter is
preferable, here.

[Sebastian Noack, 2017/02/21 09:20:13]

s/it's not related/it's related/

[kzar, 2017/02/21 10:37:00]

Done.

-      if (!selector)
+      if (!filter.selector)
         continue;
 
       let domain = filter.selectorDomain || "";
 
       if (!domains.has(domain))
         domains.set(domain, new Map());
-      domains.get(domain).set(selector, key);
+      domains.get(domain).set(filter.selector, key);
     }
 
     return domains;
   },
 
   /**
    * Returns a list of selectors that apply on each website unconditionally.
-   * @returns {String[]}
+   * @returns {string[]}
    */
   getUnconditionalSelectors()
   {
     if (!unconditionalSelectors)
       unconditionalSelectors = Object.keys(filterKeyBySelector);
     return unconditionalSelectors.slice();
   },
 
   /**
    * Returns a list of filter keys for selectors which apply to all websites
    * without exception.
-   * @returns {Number[]}
+   * @returns {number[]}
    */
   getUnconditionalFilterKeys()
   {
     if (!unconditionalFilterKeys)
     {
       let selectors = this.getUnconditionalSelectors();
       unconditionalFilterKeys = [];
       for (let selector of selectors)
         unconditionalFilterKeys.push(filterKeyBySelector[selector]);
     }
@@ skipping 16 matching lines @@
   /**
    * Constant used by getSelectorsForDomain to return only selectors for filters
    * which specifically match the given host name.
    */
   SPECIFIC_ONLY: 2,
 
   /**
    * Determines from the current filter list which selectors should be applied
    * on a particular host name. Optionally returns the corresponding filter
    * keys.
-   * @param {String} domain
-   * @param {Number} [criteria]
+   * @param {string} domain
+   * @param {number} [criteria]
    *   One of the following: ElemHide.ALL_MATCHING, ElemHide.NO_UNCONDITIONAL or
    *                         ElemHide.SPECIFIC_ONLY.
-   * @param {Boolean} [provideFilterKeys]
+   * @param {boolean} [provideFilterKeys]
    *   If true, the function will return a list of corresponding filter keys in
    *   addition to selectors.
    * @returns {string[]|Array.<string[]>}
    *   List of selectors or an array with two elements (list of selectors and
    *   list of corresponding keys) if provideFilterKeys is true.
    */
   getSelectorsForDomain(domain, criteria, provideFilterKeys)
   {
     let filterKeys = [];
     let selectors = [];
 
     if (typeof criteria == "undefined")
       criteria = ElemHide.ALL_MATCHING;
     if (criteria < ElemHide.NO_UNCONDITIONAL)
     {
       selectors = this.getUnconditionalSelectors();
       if (provideFilterKeys)
         filterKeys = this.getUnconditionalFilterKeys();
     }
 
     let specificOnly = (criteria >= ElemHide.SPECIFIC_ONLY);
     let seenFilters = Object.create(null);
     let currentDomain = domain ? domain.toUpperCase() : "";
-    /* eslint-disable no-constant-condition */

[Sebastian Noack, 2017/02/20 13:14:51]

Ugh. Can we please change esling-config-eyeo, configuring no-constant, setting
the checkLoops option to false. There are certainly legit use cases for
while(true) loops.

[kzar, 2017/02/21 06:13:58]

Done. https://codereview.adblockplus.org/29376668/

     while (true)
     {
       if (specificOnly && currentDomain == "")
         break;
 
       let filters = filtersByDomain[currentDomain];
       if (filters)
       {
         for (let filterKey in filters)
         {
@@ skipping 10 matching lines @@
           }
         }
       }
 
       if (currentDomain == "")
         break;
 
       let nextDot = currentDomain.indexOf(".");
       currentDomain = nextDot == -1 ? "" : currentDomain.substr(nextDot + 1);
     }
-    /* eslint-enable no-constant-condition */
 
     if (provideFilterKeys)
       return [selectors, filterKeys];
     return selectors;
   }
 };