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
@@ skipping 82 matching lines @@
  * @type {RegExp}
  */
 Filter.regexpRegExp = /^(@@)?\/.*\/(?:\$~?[\w-]+(?:=[^,\s]+)?(?:,~?[\w-]+(?:=[^,\s]+)?)*)?$/;
 /**
  * Regular expression that options on a RegExp filter should match
  * @type {RegExp}
  */
 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.

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

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

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

Done.

+ * Creates a filter of correct type from its text representation - does the
+ * basic parsing and calls the right constructor then.
  *
  * @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.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]
     );
   }
   else if (text[0] == "!")
     ret = new CommentFilter(text);
   else
     ret = RegExpFilter.fromText(text);
@@ skipping 37 matching lines @@
   // 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

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

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

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

Done.

+    // Special treatment for element hiding filters, right side is allowed to
+    // contain spaces
     let [, domain, separator, selector] = /^(.*?)(#@?#?)(.*)$/.exec(text);
     return domain.replace(/\s/g, "") + separator + selector.trim();
   }
   return text.replace(/\s/g, "");
 };
 
 /**
  * @see filterToRegExp
  */
 Filter.toRegExp = filterToRegExp;
@@ skipping 17 matching lines @@
   type: "invalid",
 
   /**
    * Reason why this filter is invalid
    * @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".

+   * @inheritdoc
    */
   serialize(buffer) {}
 });
 
 /**
  * Class for comments
  * @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
+   * @inheritdoc
    */
   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"

[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.

+ * @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"
  * @constructor
  * @augments Filter
  */
 function ActiveFilter(text, domains)
 {
   Filter.call(this, text);
 
   this.domainSource = domains;
 }
 exports.ActiveFilter = ActiveFilter;
@@ skipping 35 matching lines @@
     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)

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

Why change the spacing in this description?

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

Done.

+   * Last time the filter had a hit (in milliseconds since the beginning of the
+   * epoch)
    * @type {number}
    */
   get lastHit()
   {
     return this._lastHit;
   },
   set lastHit(value)
   {
     if (value != this._lastHit)
     {
@@ skipping 115 matching lines @@
    * @param {string} [sitekey] public key provided by the document
    * @return {boolean} true in case of the filter being active
    */
   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))
+    {
       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 (!docDomain)
       return this.domains[""];
 
@@ skipping 28 matching lines @@
       docDomain = docDomain.replace(/\.+$/, "");
     docDomain = docDomain.toUpperCase();
 
     for (let domain in this.domains)
     {
       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.

+        if (!domain.endsWith("." + docDomain))
           return false;
       }
     }
 
     return true;
   },
 
   /**
    * Checks whether this filter is generic or specific
    * @return {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
+   * @inheritdoc
    */
   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

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

As before, please avoid the messy indentation here.

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

Done.

+ * @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
  * @constructor
  * @augments ActiveFilter
  */
 function RegExpFilter(text, regexpSource, contentType, matchCase, domains,
                       thirdParty, sitekeys)
 {
   ActiveFilter.call(this, text, domains, sitekeys);
 
   if (contentType != null)
     this.contentType = contentType;
@@ skipping 122 matching lines @@
    * @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(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() { return this; }
 });
 
 /**
  * Creates a RegExp filter from its text representation
  * @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.

+ * @return {Filter}
  */
 RegExpFilter.fromText = function(text)
 {
   let blocking = true;
   let origText = text;
   if (text.indexOf("@@") == 0)
   {
     blocking = false;
     text = text.substr(2);
   }
@@ skipping 107 matching lines @@
 
 /**
  * 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

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

Messy indentation as before.

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

Done.

+ * @param {boolean} collapse
+ *   defines whether the filter should collapse blocked content, can be null
  * @constructor
  * @augments RegExpFilter
  */
 function BlockingFilter(text, regexpSource, contentType, matchCase, domains,
                         thirdParty, sitekeys, collapse)
 {
   RegExpFilter.call(this, text, regexpSource, contentType, matchCase, domains,
                     thirdParty, sitekeys);
 
   this.collapse = collapse;
@@ skipping 81 matching lines @@
    * CSS selector for the HTML elements that should be hidden
    * @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 {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)
 {
   if (!selector)
   {
     if (tagName == "*")
       tagName = "";
@@ skipping 98 matching lines @@
  */
 function ElemHideEmulationFilter(text, domains, selector)
 {
   ElemHideBase.call(this, text, domains, selector);
 }
 exports.ElemHideEmulationFilter = ElemHideEmulationFilter;
 
 ElemHideEmulationFilter.prototype = extend(ElemHideBase, {
   type: "elemhideemulation"
 });