Issue 4878 - Start using ESLint for adblockpluscore

lib/filterClasses.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 Definition of Filter class and its subclasses.
  */
 
-let {FilterNotifier} = require("filterNotifier");
-let {extend} = require("coreUtils");
-let {filterToRegExp} = require("common");
+const {FilterNotifier} = require("filterNotifier");
+const {extend} = require("coreUtils");
+const {filterToRegExp} = require("common");
 
 /**
  * Abstract base class for filters
  *
- * @param {String} text   string representation of the filter
+ * @param {string} text   string representation of the filter
  * @constructor
  */
 function Filter(text)
 {
   this.text = text;
   this.subscriptions = [];
 }
 exports.Filter = Filter;
 
 Filter.prototype =
 {
   /**
    * String representation of the filter
-   * @type String
+   * @type {string}
    */
   text: null,
 
   /**
    * Filter subscriptions the filter belongs to
-   * @type Subscription[]
+   * @type {Subscription[]}
    */
   subscriptions: null,
 
   /**
    * Filter type as a string, e.g. "blocking".
-   * @type String
+   * @type {string}
    */
   get type()
   {
     throw new Error("Please define filter type in the subclass");
   },
 
   /**
    * Serializes the filter to an array of strings for writing out on the disk.
    * @param {string[]} buffer  buffer to push the serialization results into
    */
-  serialize: function(buffer)
+  serialize(buffer)
   {
     buffer.push("[Filter]");
     buffer.push("text=" + this.text);
   },
 
-  toString: function()
+  toString()
   {
     return this.text;
   }
 };
 
 /**
  * Cache for known filters, maps string representation to filter objects.
- * @type Object
+ * @type {Object}
  */
 Filter.knownFilters = Object.create(null);
 
 /**
  * Regular expression that element hiding filters should match
- * @type RegExp
+ * @type {RegExp}
  */
-Filter.elemhideRegExp = /^([^\/\*\|\@"!]*?)#(\@)?(?:([\w\-]+|\*)((?:\([\w\-]+(?:[$^*]?=[^\(\)"]*)?\))*)|#(.+))$/;
+Filter.elemhideRegExp = /^([^/*|@"!]*?)#(@)?(?:([\w-]+|\*)((?:\([\w-]+(?:[$^*]?=[^()"]*)?\))*)|#(.+))$/;
 /**
  * Regular expression that RegExp filters specified as RegExps should match
- * @type RegExp
+ * @type {RegExp}
  */
-Filter.regexpRegExp = /^(@@)?\/.*\/(?:\$~?[\w\-]+(?:=[^,\s]+)?(?:,~?[\w\-]+(?:=[^,\s]+)?)*)?$/;
+Filter.regexpRegExp = /^(@@)?\/.*\/(?:\$~?[\w-]+(?:=[^,\s]+)?(?:,~?[\w-]+(?:=[^,\s]+)?)*)?$/;
 /**
  * Regular expression that options on a RegExp filter should match
- * @type RegExp
+ * @type {RegExp}
  */
-Filter.optionsRegExp = /\$(~?[\w\-]+(?:=[^,\s]+)?(?:,~?[\w\-]+(?:=[^,\s]+)?)*)$/;
+Filter.optionsRegExp = /\$(~?[\w-]+(?:=[^,\s]+)?(?:,~?[\w-]+(?:=[^,\s]+)?)*)$/;
 
 /**
- * Creates a filter of correct type from its text representation - does the basic parsing and
- * calls the right constructor then.
+ * Creates a filter of correct type from its text representation -
+ * does the basic parsing and calls the right constructor then.

[Wladimir Palant, 2017/03/02 14:06:45]

Nit: "does the" belongs on the previous line.

[kzar, 2017/03/08 12:33:31]

Done.

  *
- * @param {String} text   as in Filter()
+ * @param {string} text   as in Filter()
  * @return {Filter}
  */
 Filter.fromText = function(text)
 {
   if (text in Filter.knownFilters)
     return Filter.knownFilters[text];
 
   let ret;
-  let match = (text.indexOf("#") >= 0 ? Filter.elemhideRegExp.exec(text) : null);
+  let match = (text.includes("#") ? Filter.elemhideRegExp.exec(text) : null);

[Wladimir Palant, 2017/03/02 14:06:47]

Please add integration notes to the issue - this is implemented as of Firefox
40, so we will need to increase minVersion when we update the dependency.

[kzar, 2017/03/08 12:33:36]

Done.

   if (match)
-    ret = ElemHideBase.fromText(text, match[1], !!match[2], match[3], match[4], match[5]);
+  {
+    ret = ElemHideBase.fromText(
+      text, match[1], !!match[2], match[3], match[4], match[5]
+    );
+  }
   else if (text[0] == "!")
     ret = new CommentFilter(text);
   else
     ret = RegExpFilter.fromText(text);
 
   Filter.knownFilters[ret.text] = ret;
   return ret;
 };
 
 /**
  * Deserializes a filter
  *
  * @param {Object}  obj map of serialized properties and their values
  * @return {Filter} filter or null if the filter couldn't be created
  */
 Filter.fromObject = function(obj)
 {
   let ret = Filter.fromText(obj.text);
   if (ret instanceof ActiveFilter)
   {
     if ("disabled" in obj)
       ret._disabled = (obj.disabled == "true");
     if ("hitCount" in obj)
-      ret._hitCount = parseInt(obj.hitCount) || 0;
+      ret._hitCount = parseInt(obj.hitCount, 10) || 0;
     if ("lastHit" in obj)
-      ret._lastHit = parseInt(obj.lastHit) || 0;
+      ret._lastHit = parseInt(obj.lastHit, 10) || 0;
   }
   return ret;
 };
 
 /**
  * Removes unnecessary whitespaces from filter text, will only return null if
  * the input parameter is null.
+ * @param {string} text
+ * @return {string}
  */
-Filter.normalize = function(/**String*/ text) /**String*/
+Filter.normalize = function(text)
 {
   if (!text)
     return text;
 
   // Remove line breaks and such
   text = text.replace(/[^\S ]/g, "");
 
   if (/^\s*!/.test(text))
   {
     // Don't remove spaces inside comments
     return text.trim();
   }
   else if (Filter.elemhideRegExp.test(text))
   {
-    // Special treatment for element hiding filters, right side is allowed to contain spaces
-    let [, domain, separator, selector] = /^(.*?)(#\@?#?)(.*)$/.exec(text);
+    // Special treatment for element hiding filters, right side is
+    // allowed to contain spaces

[Wladimir Palant, 2017/03/02 14:06:45]

Nit: "allowed to" belongs on the previous line.

[kzar, 2017/03/08 12:33:30]

Done.

+    let [, domain, separator, selector] = /^(.*?)(#@?#?)(.*)$/.exec(text);
     return domain.replace(/\s/g, "") + separator + selector.trim();
   }
-  else
-    return text.replace(/\s/g, "");
+  return text.replace(/\s/g, "");
 };
 
 /**
  * @see filterToRegExp
  */
 Filter.toRegExp = filterToRegExp;
 
 /**
  * Class for invalid filters
- * @param {String} text see Filter()
- * @param {String} reason Reason why this filter is invalid
+ * @param {string} text see Filter()
+ * @param {string} reason Reason why this filter is invalid
  * @constructor
  * @augments Filter
  */
 function InvalidFilter(text, reason)
 {
   Filter.call(this, text);
 
   this.reason = reason;
 }
 exports.InvalidFilter = InvalidFilter;
 
 InvalidFilter.prototype = extend(Filter, {
   type: "invalid",
 
   /**
    * Reason why this filter is invalid
-   * @type String
+   * @type {string}
    */
   reason: null,
 
   /**
    * See Filter.serialize()
+   * @param {string[]} buffer  buffer to push the serialization results into

[Wladimir Palant, 2017/03/02 14:06:46]

Do we really want to duplicate this description everywhere? I'd suggest leaving
it out or referring to Filter.serialize(). Same for the other implementations
below.

[kzar, 2017/03/08 12:33:32]

Well I've removed those duplicate descriptions but now we're getting some ESLint
failures "Missing JSDoc for parameter 'buffer'  valid-jsdoc".

    */
-  serialize: function(buffer) {}
+  serialize(buffer) {}
 });
 
 /**
  * Class for comments
- * @param {String} text see Filter()
+ * @param {string} text see Filter()
  * @constructor
  * @augments Filter
  */
 function CommentFilter(text)
 {
   Filter.call(this, text);
 }
 exports.CommentFilter = CommentFilter;
 
 CommentFilter.prototype = extend(Filter, {
   type: "comment",
 
   /**
    * See Filter.serialize()
+   * @param {string[]} buffer  buffer to push the serialization results into
    */
-  serialize: function(buffer) {}
+  serialize(buffer) {}
 });
 
 /**
  * Abstract base class for filters that can get hits
- * @param {String} text see Filter()
- * @param {String} [domains] Domains that the filter is restricted to separated by domainSeparator e.g. "foo.com|bar.com|~baz.com"
+ * @param {string} text see Filter()
+ * @param {string} [domains] Domains that the filter is restricted to
+ *                  separated by domainSeparator e.g. "foo.com|bar.com|~baz.com"

[Wladimir Palant, 2017/03/02 14:06:49]

As before, I'd suggest avoiding the messy indentation here by putting
descriptions on the next line.

[kzar, 2017/03/08 12:33:35]

Done.

  * @constructor
  * @augments Filter
  */
 function ActiveFilter(text, domains)
 {
   Filter.call(this, text);
 
   this.domainSource = domains;
 }
 exports.ActiveFilter = ActiveFilter;
 
 ActiveFilter.prototype = extend(Filter, {
   _disabled: false,
   _hitCount: 0,
   _lastHit: 0,
 
   /**
    * Defines whether the filter is disabled
-   * @type Boolean
+   * @type {boolean}
    */
   get disabled()
   {
     return this._disabled;
   },
   set disabled(value)
   {
     if (value != this._disabled)
     {
       let oldValue = this._disabled;
       this._disabled = value;
       FilterNotifier.triggerListeners("filter.disabled", this, value, oldValue);
     }
     return this._disabled;
   },
 
   /**
    * Number of hits on the filter since the last reset
-   * @type Number
+   * @type {number}
    */
   get hitCount()
   {
     return this._hitCount;
   },
   set hitCount(value)
   {
     if (value != this._hitCount)
     {
       let oldValue = this._hitCount;
       this._hitCount = value;
       FilterNotifier.triggerListeners("filter.hitCount", this, value, oldValue);
     }
     return this._hitCount;
   },
 
   /**
-   * Last time the filter had a hit (in milliseconds since the beginning of the epoch)
-   * @type Number
+   * Last time the filter had a hit (in milliseconds since the
+   * beginning of the epoch)

[Wladimir Palant, 2017/03/02 14:06:48]

Why change the spacing in this description?

[kzar, 2017/03/08 12:33:30]

Done.

+   * @type {number}
    */
   get lastHit()
   {
     return this._lastHit;
   },
   set lastHit(value)
   {
     if (value != this._lastHit)
     {
       let oldValue = this._lastHit;
       this._lastHit = value;
       FilterNotifier.triggerListeners("filter.lastHit", this, value, oldValue);
     }
     return this._lastHit;
   },
 
   /**
    * String that the domains property should be generated from
-   * @type String
+   * @type {string}
    */
   domainSource: null,
 
   /**
-   * Separator character used in domainSource property, must be overridden by subclasses
-   * @type String
+   * Separator character used in domainSource property, must be
+   * overridden by subclasses
+   * @type {string}
    */
   domainSeparator: null,
 
   /**
    * Determines whether the trailing dot in domain names isn't important and
    * should be ignored, must be overridden by subclasses.
-   * @type Boolean
+   * @type {boolean}
    */
   ignoreTrailingDot: true,
 
   /**
    * Determines whether domainSource is already upper-case,
    * can be overridden by subclasses.
-   * @type Boolean
+   * @type {boolean}
    */
   domainSourceIsUpperCase: false,
 
   /**
-   * Map containing domains that this filter should match on/not match on or null if the filter should match on all domains
-   * @type Object
+   * Map containing domains that this filter should match on/not match
+   * on or null if the filter should match on all domains
+   * @type {Object}
    */
   get domains()
   {
     // Despite this property being cached, the getter is called
     // several times on Safari, due to WebKit bug 132872
     let prop = Object.getOwnPropertyDescriptor(this, "domains");
     if (prop)
       return prop.value;
 
     let domains = null;
 
     if (this.domainSource)
     {
       let source = this.domainSource;
-      if (!this.domainSourceIsUpperCase) {
+      if (!this.domainSourceIsUpperCase)
+      {
         // RegExpFilter already have uppercase domains
         source = source.toUpperCase();
       }
       let list = source.split(this.domainSeparator);
       if (list.length == 1 && list[0][0] != "~")
       {
         // Fast track for the common one-domain scenario
         domains = Object.create(null);
         domains[""] = false;
         if (this.ignoreTrailingDot)
@@ skipping 34 matching lines @@
 
       this.domainSource = null;
     }
 
     Object.defineProperty(this, "domains", {value: domains, enumerable: true});
     return this.domains;
   },
 
   /**
    * Array containing public keys of websites that this filter should apply to
-   * @type string[]
+   * @type {string[]}
    */
   sitekeys: null,
 
   /**
    * Checks whether this filter is active on a domain.
-   * @param {String} docDomain domain name of the document that loads the URL
-   * @param {String} [sitekey] public key provided by the document
-   * @return {Boolean} true in case of the filter being active
+   * @param {string} docDomain domain name of the document that loads the URL
+   * @param {string} [sitekey] public key provided by the document
+   * @return {boolean} true in case of the filter being active
    */
-  isActiveOnDomain: function(docDomain, sitekey)
+  isActiveOnDomain(docDomain, sitekey)
   {
-    // Sitekeys are case-sensitive so we shouldn't convert them to upper-case to avoid false
-    // positives here. Instead we need to change the way filter options are parsed.
-    if (this.sitekeys && (!sitekey || this.sitekeys.indexOf(sitekey.toUpperCase()) < 0))
+    // Sitekeys are case-sensitive so we shouldn't convert them to
+    // upper-case to avoid false positives here. Instead we need to
+    // change the way filter options are parsed.
+    if (this.sitekeys &&
+        (!sitekey || this.sitekeys.indexOf(sitekey.toUpperCase()) < 0))
       return false;
 
     // If no domains are set the rule matches everywhere
     if (!this.domains)
       return true;
 
-    // If the document has no host name, match only if the filter isn't restricted to specific domains
+    // If the document has no host name, match only if the filter
+    // isn't restricted to specific domains
     if (!docDomain)
       return this.domains[""];
 
     if (this.ignoreTrailingDot)
       docDomain = docDomain.replace(/\.+$/, "");
     docDomain = docDomain.toUpperCase();
 
     while (true)
     {
       if (docDomain in this.domains)
         return this.domains[docDomain];
 
       let nextDot = docDomain.indexOf(".");
       if (nextDot < 0)
         break;
       docDomain = docDomain.substr(nextDot + 1);
     }
     return this.domains[""];
   },
 
   /**
    * Checks whether this filter is active only on a domain and its subdomains.
+   * @param {string} docDomain
+   * @return {boolean}
    */
-  isActiveOnlyOnDomain: function(/**String*/ docDomain) /**Boolean*/
+  isActiveOnlyOnDomain(docDomain)
   {
     if (!docDomain || !this.domains || this.domains[""])
       return false;
 
     if (this.ignoreTrailingDot)
       docDomain = docDomain.replace(/\.+$/, "");
     docDomain = docDomain.toUpperCase();
 
     for (let domain in this.domains)
-      if (this.domains[domain] && domain != docDomain && (domain.length <= docDomain.length || domain.indexOf("." + docDomain) != domain.length - docDomain.length - 1))
-        return false;
+    {
+      if (this.domains[domain] && domain != docDomain)
+      {
+        if (domain.length <= docDomain.length)
+          return false;
+
+        let pos = domain.indexOf("." + docDomain);
+        if (pos != domain.length - docDomain.length - 1)

[Wladimir Palant, 2017/03/02 14:06:48]

Just change this into:

  if (!domain.endsWith("." + docDomain))

[kzar, 2017/03/08 12:33:29]

Done.

+          return false;
+      }
+    }
 
     return true;
   },
 
   /**
    * Checks whether this filter is generic or specific
+   * @return {boolean}
    */
-  isGeneric: function() /**Boolean*/
+  isGeneric()
   {
     return !(this.sitekeys && this.sitekeys.length) &&
             (!this.domains || this.domains[""]);
   },
 
   /**
    * See Filter.serialize()
+   * @param {string[]} buffer  buffer to push the serialization results into
    */
-  serialize: function(buffer)
+  serialize(buffer)
   {
     if (this._disabled || this._hitCount || this._lastHit)
     {
       Filter.prototype.serialize.call(this, buffer);
       if (this._disabled)
         buffer.push("disabled=true");
       if (this._hitCount)
         buffer.push("hitCount=" + this._hitCount);
       if (this._lastHit)
         buffer.push("lastHit=" + this._lastHit);
     }
   }
 });
 
 /**
  * Abstract base class for RegExp-based filters
- * @param {String} text see Filter()
- * @param {String} regexpSource filter part that the regular expression should be build from
- * @param {Number} [contentType] Content types the filter applies to, combination of values from RegExpFilter.typeMap
- * @param {Boolean} [matchCase] Defines whether the filter should distinguish between lower and upper case letters
- * @param {String} [domains] Domains that the filter is restricted to, e.g. "foo.com|bar.com|~baz.com"
- * @param {Boolean} [thirdParty] Defines whether the filter should apply to third-party or first-party content only
- * @param {String} [sitekeys] Public keys of websites that this filter should apply to
+ * @param {string} text see Filter()
+ * @param {string} regexpSource filter part that the regular expression should
+ *                              be build from
+ * @param {number} [contentType] Content types the filter applies to,
+ *                               combination of values from RegExpFilter.typeMap
+ * @param {boolean} [matchCase] Defines whether the filter should distinguish
+ *                              between lower and upper case letters
+ * @param {string} [domains] Domains that the filter is restricted to,
+ *                           e.g. "foo.com|bar.com|~baz.com"
+ * @param {boolean} [thirdParty] Defines whether the filter should apply to
+ *                               third-party or first-party content only
+ * @param {string} [sitekeys] Public keys of websites that this filter should
+ *                            apply to

[Wladimir Palant, 2017/03/02 14:06:48]

As before, please avoid the messy indentation here.

[kzar, 2017/03/08 12:33:33]

Done.

  * @constructor
  * @augments ActiveFilter
  */
-function RegExpFilter(text, regexpSource, contentType, matchCase, domains, thirdParty, sitekeys)
+function RegExpFilter(text, regexpSource, contentType, matchCase, domains,
+                      thirdParty, sitekeys)
 {
   ActiveFilter.call(this, text, domains, sitekeys);
 
   if (contentType != null)
     this.contentType = contentType;
   if (matchCase)
     this.matchCase = matchCase;
   if (thirdParty != null)
     this.thirdParty = thirdParty;
   if (sitekeys != null)
     this.sitekeySource = sitekeys;
 
-  if (regexpSource.length >= 2 && regexpSource[0] == "/" && regexpSource[regexpSource.length - 1] == "/")
+  if (regexpSource.length >= 2 &&
+      regexpSource[0] == "/" &&
+      regexpSource[regexpSource.length - 1] == "/")
   {
-    // The filter is a regular expression - convert it immediately to catch syntax errors
-    let regexp = new RegExp(regexpSource.substr(1, regexpSource.length - 2), this.matchCase ? "" : "i");
+    // The filter is a regular expression - convert it immediately to
+    // catch syntax errors
+    let regexp = new RegExp(regexpSource.substr(1, regexpSource.length - 2),
+                            this.matchCase ? "" : "i");
     Object.defineProperty(this, "regexp", {value: regexp});
   }
   else
   {
     // No need to convert this filter to regular expression yet, do it on demand
     this.regexpSource = regexpSource;
   }
 }
 exports.RegExpFilter = RegExpFilter;
 
 RegExpFilter.prototype = extend(ActiveFilter, {
   /**
    * @see ActiveFilter.domainSourceIsUpperCase
    */
   domainSourceIsUpperCase: true,
 
   /**
-   * Number of filters contained, will always be 1 (required to optimize Matcher).
-   * @type Integer
+   * Number of filters contained, will always be 1 (required to
+   * optimize Matcher).
+   * @type {number}
    */
   length: 1,
 
   /**
    * @see ActiveFilter.domainSeparator
    */
   domainSeparator: "|",
 
   /**
-   * Expression from which a regular expression should be generated - for delayed creation of the regexp property
-   * @type String
+   * Expression from which a regular expression should be generated -
+   * for delayed creation of the regexp property
+   * @type {string}
    */
   regexpSource: null,
   /**
    * Regular expression to be used when testing against this filter
-   * @type RegExp
+   * @type {RegExp}
    */
   get regexp()
   {
     // Despite this property being cached, the getter is called
     // several times on Safari, due to WebKit bug 132872
     let prop = Object.getOwnPropertyDescriptor(this, "regexp");
     if (prop)
       return prop.value;
 
     let source = Filter.toRegExp(this.regexpSource);
     let regexp = new RegExp(source, this.matchCase ? "" : "i");
     Object.defineProperty(this, "regexp", {value: regexp});
     return regexp;
   },
   /**
-   * Content types the filter applies to, combination of values from RegExpFilter.typeMap
-   * @type Number
+   * Content types the filter applies to, combination of values from
+   * RegExpFilter.typeMap
+   * @type {number}
    */
   contentType: 0x7FFFFFFF,
   /**
-   * Defines whether the filter should distinguish between lower and upper case letters
-   * @type Boolean
+   * Defines whether the filter should distinguish between lower and
+   * upper case letters
+   * @type {boolean}
    */
   matchCase: false,
   /**
-   * Defines whether the filter should apply to third-party or first-party content only. Can be null (apply to all content).
-   * @type Boolean
+   * Defines whether the filter should apply to third-party or
+   * first-party content only. Can be null (apply to all content).
+   * @type {boolean}
    */
   thirdParty: null,
 
   /**
    * String that the sitekey property should be generated from
-   * @type String
+   * @type {string}
    */
   sitekeySource: null,
 
   /**
    * Array containing public keys of websites that this filter should apply to
-   * @type string[]
+   * @type {string[]}
    */
   get sitekeys()
   {
     // Despite this property being cached, the getter is called
     // several times on Safari, due to WebKit bug 132872
     let prop = Object.getOwnPropertyDescriptor(this, "sitekeys");
     if (prop)
       return prop.value;
 
     let sitekeys = null;
 
     if (this.sitekeySource)
     {
       sitekeys = this.sitekeySource.split("|");
       this.sitekeySource = null;
     }
 
-    Object.defineProperty(this, "sitekeys", {value: sitekeys, enumerable: true});
+    Object.defineProperty(
+      this, "sitekeys", {value: sitekeys, enumerable: true}
+    );
     return this.sitekeys;
   },
 
   /**
    * Tests whether the URL matches this filter
-   * @param {String} location URL to be tested
+   * @param {string} location URL to be tested
    * @param {number} typeMask bitmask of content / request types to match
-   * @param {String} docDomain domain name of the document that loads the URL
-   * @param {Boolean} thirdParty should be true if the URL is a third-party request
-   * @param {String} sitekey public key provided by the document
-   * @return {Boolean} true in case of a match
+   * @param {string} docDomain domain name of the document that loads the URL
+   * @param {boolean} thirdParty should be true if the URL is a third-party
+   *                             request
+   * @param {string} sitekey public key provided by the document
+   * @return {boolean} true in case of a match
    */
-  matches: function(location, typeMask, docDomain, thirdParty, sitekey)
+  matches(location, typeMask, docDomain, thirdParty, sitekey)
   {
     if (this.contentType & typeMask &&
         (this.thirdParty == null || this.thirdParty == thirdParty) &&
         this.isActiveOnDomain(docDomain, sitekey) && this.regexp.test(location))
-    {
       return true;

[Wladimir Palant, 2017/03/02 14:06:45]

Since ESLint won't let you keep the braces here, I suggest removing this if
block altogether:

  return this.contentType & typeMask &&
         (this.thirdParty == null || this.thirdParty == thirdParty) &&
         this.isActiveOnDomain(docDomain, sitekey) &&
         this.regexp.test(location);

[kzar, 2017/03/08 12:33:35]

We can keep the braces now.

-    }
-
     return false;
   }
 });
 
 // Required to optimize Matcher, see also RegExpFilter.prototype.length
-Object.defineProperty(RegExpFilter.prototype, "0",
-{
-  get: function() { return this; }
+Object.defineProperty(RegExpFilter.prototype, "0", {
+  get() { return this; }
 });
 
 /**
  * Creates a RegExp filter from its text representation
- * @param {String} text   same as in Filter()
+ * @param {string} text   same as in Filter()
+ * @return {RegExpFilter}

[Wladimir Palant, 2017/03/02 14:06:49]

This should be RegExpFilter|InvalidFilter. Or maybe (if you want to be
consistent with ElemHideBase.fromText() below)
BlockingFilter|WhitelistFilter|InvalidFilter. Or maybe just: @return {Filter}

[kzar, 2017/03/08 12:33:34]

Done.

  */
 RegExpFilter.fromText = function(text)
 {
   let blocking = true;
   let origText = text;
   if (text.indexOf("@@") == 0)
   {
     blocking = false;
     text = text.substr(2);
   }
@@ skipping 22 matching lines @@
       option = option.replace(/-/, "_");
       if (option in RegExpFilter.typeMap)
       {
         if (contentType == null)
           contentType = 0;
         contentType |= RegExpFilter.typeMap[option];
       }
       else if (option[0] == "~" && option.substr(1) in RegExpFilter.typeMap)
       {
         if (contentType == null)
-          contentType = RegExpFilter.prototype.contentType;
+          ({contentType} = RegExpFilter.prototype);
         contentType &= ~RegExpFilter.typeMap[option.substr(1)];
       }
       else if (option == "MATCH_CASE")
         matchCase = true;
       else if (option == "~MATCH_CASE")
         matchCase = false;
       else if (option == "DOMAIN" && typeof value != "undefined")
         domains = value;
       else if (option == "THIRD_PARTY")
         thirdParty = true;
       else if (option == "~THIRD_PARTY")
         thirdParty = false;
       else if (option == "COLLAPSE")
         collapse = true;
       else if (option == "~COLLAPSE")
         collapse = false;
       else if (option == "SITEKEY" && typeof value != "undefined")
         sitekeys = value;
       else
         return new InvalidFilter(origText, "filter_unknown_option");
     }
   }
 
   try
   {
     if (blocking)
-      return new BlockingFilter(origText, text, contentType, matchCase, domains, thirdParty, sitekeys, collapse);
-    else
-      return new WhitelistFilter(origText, text, contentType, matchCase, domains, thirdParty, sitekeys);
+    {
+      return new BlockingFilter(origText, text, contentType, matchCase, domains,
+                                thirdParty, sitekeys, collapse);
+    }
+    return new WhitelistFilter(origText, text, contentType, matchCase, domains,
+                               thirdParty, sitekeys);
   }
   catch (e)
   {
     return new InvalidFilter(origText, "filter_invalid_regexp");
   }
 };
 
 /**
  * Maps type strings like "SCRIPT" or "OBJECT" to bit masks
  */
@@ skipping 25 matching lines @@
 // DOCUMENT, ELEMHIDE, POPUP, GENERICHIDE and GENERICBLOCK options shouldn't
 // be there by default
 RegExpFilter.prototype.contentType &= ~(RegExpFilter.typeMap.DOCUMENT |
                                         RegExpFilter.typeMap.ELEMHIDE |
                                         RegExpFilter.typeMap.POPUP |
                                         RegExpFilter.typeMap.GENERICHIDE |
                                         RegExpFilter.typeMap.GENERICBLOCK);
 
 /**
  * Class for blocking filters
- * @param {String} text see Filter()
- * @param {String} regexpSource see RegExpFilter()
- * @param {Number} contentType see RegExpFilter()
- * @param {Boolean} matchCase see RegExpFilter()
- * @param {String} domains see RegExpFilter()
- * @param {Boolean} thirdParty see RegExpFilter()
- * @param {String} sitekeys see RegExpFilter()
- * @param {Boolean} collapse  defines whether the filter should collapse blocked content, can be null
+ * @param {string} text see Filter()
+ * @param {string} regexpSource see RegExpFilter()
+ * @param {number} contentType see RegExpFilter()
+ * @param {boolean} matchCase see RegExpFilter()
+ * @param {string} domains see RegExpFilter()
+ * @param {boolean} thirdParty see RegExpFilter()
+ * @param {string} sitekeys see RegExpFilter()
+ * @param {boolean} collapse  defines whether the filter should collapse blocked
+ *                            content, can be null

[Wladimir Palant, 2017/03/02 14:06:47]

Messy indentation as before.

[kzar, 2017/03/08 12:33:31]

Done.

  * @constructor
  * @augments RegExpFilter
  */
-function BlockingFilter(text, regexpSource, contentType, matchCase, domains, thirdParty, sitekeys, collapse)
+function BlockingFilter(text, regexpSource, contentType, matchCase, domains,
+                        thirdParty, sitekeys, collapse)
 {
-  RegExpFilter.call(this, text, regexpSource, contentType, matchCase, domains, thirdParty, sitekeys);
+  RegExpFilter.call(this, text, regexpSource, contentType, matchCase, domains,
+                    thirdParty, sitekeys);
 
   this.collapse = collapse;
 }
 exports.BlockingFilter = BlockingFilter;
 
 BlockingFilter.prototype = extend(RegExpFilter, {
   type: "blocking",
 
   /**
-   * Defines whether the filter should collapse blocked content. Can be null (use the global preference).
-   * @type Boolean
+   * Defines whether the filter should collapse blocked content.
+   * Can be null (use the global preference).
+   * @type {boolean}
    */
   collapse: null
 });
 
 /**
  * Class for whitelist filters
- * @param {String} text see Filter()
- * @param {String} regexpSource see RegExpFilter()
- * @param {Number} contentType see RegExpFilter()
- * @param {Boolean} matchCase see RegExpFilter()
- * @param {String} domains see RegExpFilter()
- * @param {Boolean} thirdParty see RegExpFilter()
- * @param {String} sitekeys see RegExpFilter()
+ * @param {string} text see Filter()
+ * @param {string} regexpSource see RegExpFilter()
+ * @param {number} contentType see RegExpFilter()
+ * @param {boolean} matchCase see RegExpFilter()
+ * @param {string} domains see RegExpFilter()
+ * @param {boolean} thirdParty see RegExpFilter()
+ * @param {string} sitekeys see RegExpFilter()
  * @constructor
  * @augments RegExpFilter
  */
-function WhitelistFilter(text, regexpSource, contentType, matchCase, domains, thirdParty, sitekeys)
+function WhitelistFilter(text, regexpSource, contentType, matchCase, domains,
+                         thirdParty, sitekeys)
 {
-  RegExpFilter.call(this, text, regexpSource, contentType, matchCase, domains, thirdParty, sitekeys);
+  RegExpFilter.call(this, text, regexpSource, contentType, matchCase, domains,
+                    thirdParty, sitekeys);
 }
 exports.WhitelistFilter = WhitelistFilter;
 
 WhitelistFilter.prototype = extend(RegExpFilter, {
   type: "whitelist"
 });
 
 /**
  * Base class for element hiding filters
- * @param {String} text see Filter()
- * @param {String} [domains] Host names or domains the filter should be restricted to
- * @param {String} selector   CSS selector for the HTML elements that should be hidden
+ * @param {string} text see Filter()
+ * @param {string} [domains] Host names or domains the filter should be
+ *                           restricted to
+ * @param {string} selector   CSS selector for the HTML elements that should be
+ *                            hidden
  * @constructor
  * @augments ActiveFilter
  */
 function ElemHideBase(text, domains, selector)
 {
   ActiveFilter.call(this, text, domains || null);
 
   if (domains)
-    this.selectorDomain = domains.replace(/,~[^,]+/g, "").replace(/^~[^,]+,?/, "").toLowerCase();
+  {
+    this.selectorDomain = domains.replace(/,~[^,]+/g, "")
+                                 .replace(/^~[^,]+,?/, "").toLowerCase();
+  }
 
   // Braces are being escaped to prevent CSS rule injection.
   this.selector = selector.replace("{", "\\x7B ").replace("}", "\\x7D ");
 }
 exports.ElemHideBase = ElemHideBase;
 
 ElemHideBase.prototype = extend(ActiveFilter, {
   /**
    * @see ActiveFilter.domainSeparator
    */
   domainSeparator: ",",
 
   /**
    * @see ActiveFilter.ignoreTrailingDot
    */
   ignoreTrailingDot: false,
 
   /**
-   * Host name or domain the filter should be restricted to (can be null for no restriction)
-   * @type String
+   * Host name or domain the filter should be restricted to (can be null for
+   * no restriction)
+   * @type {string}
    */
   selectorDomain: null,
   /**
    * CSS selector for the HTML elements that should be hidden
-   * @type String
+   * @type {string}
    */
   selector: null
 });
 
 /**
  * Creates an element hiding filter from a pre-parsed text representation
  *
- * @param {String} text         same as in Filter()
- * @param {String} domain       domain part of the text representation (can be empty)
- * @param {Boolean} isException exception rule indicator
- * @param {String} tagName      tag name part (can be empty)
- * @param {String} attrRules    attribute matching rules (can be empty)
- * @param {String} selector     raw CSS selector (can be empty)
- * @return {ElemHideFilter|ElemHideException|ElemHideEmulationFilter|InvalidFilter}
+ * @param {string} text         same as in Filter()
+ * @param {string} domain       domain part of the text representation
+ *                              (can be empty)
+ * @param {boolean} isException exception rule indicator
+ * @param {string} tagName      tag name part (can be empty)
+ * @param {string} attrRules    attribute matching rules (can be empty)
+ * @param {string} selector     raw CSS selector (can be empty)

[Wladimir Palant, 2017/03/02 14:06:46]

Messy indentation as before.

[kzar, 2017/03/08 12:33:32]

Done.

+ * @return {ElemHideFilter|ElemHideException|
+ *          ElemHideEmulationFilter|InvalidFilter}
  */
-ElemHideBase.fromText = function(text, domain, isException, tagName, attrRules, selector)
+ElemHideBase.fromText = function(text, domain, isException, tagName, attrRules,
+                                 selector)
 {
   if (!selector)
   {
     if (tagName == "*")
       tagName = "";
 
     let id = null;
     let additional = "";
     if (attrRules)
     {
-      attrRules = attrRules.match(/\([\w\-]+(?:[$^*]?=[^\(\)"]*)?\)/g);
+      attrRules = attrRules.match(/\([\w-]+(?:[$^*]?=[^()"]*)?\)/g);
       for (let rule of attrRules)
       {
         rule = rule.substr(1, rule.length - 2);
         let separatorPos = rule.indexOf("=");
         if (separatorPos > 0)
         {
           rule = rule.replace(/=/, '="') + '"';
           additional += "[" + rule + "]";
         }
         else
         {
           if (id)
             return new InvalidFilter(text, "filter_elemhide_duplicate_id");
 
           id = rule;
         }
       }
     }
 
     if (id)
-      selector = tagName + "." + id + additional + "," + tagName + "#" + id + additional;
+      selector = `${tagName}.${id}${additional},${tagName}#${id}${additional}`;
     else if (tagName || additional)
       selector = tagName + additional;
     else
       return new InvalidFilter(text, "filter_elemhide_nocriteria");
   }
 
   // We don't allow ElemHide filters which have any empty domains.
   // Note: The ElemHide.prototype.domainSeparator is duplicated here, if that
   // changes this must be changed too.
   if (domain && /(^|,)~?(,|$)/.test(domain))
@@ skipping 10 matching lines @@
       return new InvalidFilter(text, "filter_elemhideemulation_nodomain");
 
     return new ElemHideEmulationFilter(text, domain, selector);
   }
 
   return new ElemHideFilter(text, domain, selector);
 };
 
 /**
  * Class for element hiding filters
- * @param {String} text see Filter()
- * @param {String} domains  see ElemHideBase()
- * @param {String} selector see ElemHideBase()
+ * @param {string} text see Filter()
+ * @param {string} domains  see ElemHideBase()
+ * @param {string} selector see ElemHideBase()
  * @constructor
  * @augments ElemHideBase
  */
 function ElemHideFilter(text, domains, selector)
 {
   ElemHideBase.call(this, text, domains, selector);
 }
 exports.ElemHideFilter = ElemHideFilter;
 
 ElemHideFilter.prototype = extend(ElemHideBase, {
   type: "elemhide"
 });
 
 /**
  * Class for element hiding exceptions
- * @param {String} text see Filter()
- * @param {String} domains  see ElemHideBase()
- * @param {String} selector see ElemHideBase()
+ * @param {string} text see Filter()
+ * @param {string} domains  see ElemHideBase()
+ * @param {string} selector see ElemHideBase()
  * @constructor
  * @augments ElemHideBase
  */
 function ElemHideException(text, domains, selector)
 {
   ElemHideBase.call(this, text, domains, selector);
 }
 exports.ElemHideException = ElemHideException;
 
 ElemHideException.prototype = extend(ElemHideBase, {
   type: "elemhideexception"
 });
 
 /**
  * Class for element hiding emulation filters
- * @param {String} text           see Filter()
- * @param {String} domains        see ElemHideBase()
- * @param {String} selector       see ElemHideBase()
+ * @param {string} text           see Filter()
+ * @param {string} domains        see ElemHideBase()
+ * @param {string} selector       see ElemHideBase()
  * @constructor
  * @augments ElemHideBase
  */
 function ElemHideEmulationFilter(text, domains, selector)
 {
   ElemHideBase.call(this, text, domains, selector);
 }
 exports.ElemHideEmulationFilter = ElemHideEmulationFilter;
 
 ElemHideEmulationFilter.prototype = extend(ElemHideBase, {
   type: "elemhideemulation"
 });