Issue 4878 - Start using ESLint for adblockpluscore

lib/matcher.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 Matcher class implementing matching addresses against
  *               a list of filters.
  */
 
-const {Filter, RegExpFilter, WhitelistFilter} = require("filterClasses");
+const {Filter, WhitelistFilter} = require("filterClasses");
 
 /**
  * Blacklist/whitelist filter matching
  * @constructor
  */
 function Matcher()
 {
   this.clear();
 }
 exports.Matcher = Matcher;
@@ skipping 64 matching lines @@
           this.filterByKeyword[keyword] = list[0];
       }
     }
 
     delete this.keywordByFilter[filter.text];
   },
 
   /**
    * Chooses a keyword to be associated with the filter
    * @param {Filter} filter
-   * @return {string} keyword

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

"might be an empty string" is actually important here. I'd suggest:

  keyword or an empty string if no keyword could be found

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

Done.

+   * @return {string} keyword or an empty string if no keyword could be found
    */
   findKeyword(filter)
   {
     let result = "";
     let {text} = filter;
     if (Filter.regexpRegExp.test(text))
       return result;
 
     // Remove options
     let match = Filter.optionsRegExp.exec(text);
@@ skipping 52 matching lines @@
 
   /**
    * Checks whether the entries for a particular keyword match a URL
    * @param {string} keyword
    * @param {string} location
    * @param {number} typeMask
    * @param {string} docDomain
    * @param {boolean} thirdParty
    * @param {string} sitekey
    * @param {boolean} specificOnly
-   * @return {Filter|null}

[Wladimir Palant, 2017/03/02 14:07:00]

This is properly expressed as {?Filter}.

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

Done.

+   * @return {?Filter}
    */
   _checkEntryMatch(keyword, location, typeMask, docDomain, thirdParty, sitekey,
                    specificOnly)
   {
     let list = this.filterByKeyword[keyword];
     for (let i = 0; i < list.length; i++)
     {
       let filter = list[i];
 
       if (specificOnly && filter.isGeneric() &&
           !(filter instanceof WhitelistFilter))
         continue;
 
       if (filter.matches(location, typeMask, docDomain, thirdParty, sitekey))
         return filter;
     }
     return null;
   },
 
   /**
    * Tests whether the URL matches any of the known filters
-   * @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
-   * @param {boolean} specificOnly should be true if generic matches should be
-   *                               ignored
-   * @return {RegExpFilter|null} matching filter or null

[Wladimir Palant, 2017/03/02 14:07:00]

This is properly expressed as {?RegExpFilter}.

Also, messy indentation here.

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

Done.

+   * @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
+   * @param {boolean} specificOnly
+   *   should be true if generic matches should be ignored
+   * @return {?RegExpFilter}
+   *   matching filter or null
    */
   matchesAny(location, typeMask, docDomain, thirdParty, sitekey, specificOnly)
   {
     let candidates = location.toLowerCase().match(/[a-z0-9%]{3,}/g);
     if (candidates === null)
       candidates = [];
     candidates.push("");
     for (let i = 0, l = candidates.length; i < l; i++)
     {
       let substr = candidates[i];
       if (substr in this.filterByKeyword)
       {
         let result = this._checkEntryMatch(substr, location, typeMask,
                                            docDomain, thirdParty, sitekey,
                                            specificOnly);
         if (result)
           return result;
       }
     }
 
     return null;
   }
 };
 
 /**
  * Combines a matcher for blocking and exception rules, automatically sorts
  * rules into two Matcher instances.
  * @constructor
+ * @augments Matcher
  */
 function CombinedMatcher()
 {
   this.blacklist = new Matcher();
   this.whitelist = new Matcher();
   this.resultCache = Object.create(null);
 }
 exports.CombinedMatcher = CombinedMatcher;
 
 /**
@@ skipping 123 matching lines @@
     );
     if (matcher.hasFilter(filter))
       return !matcher.getKeywordForFilter(filter);
     return !matcher.findKeyword(filter);
   },
 
   /**
    * Optimized filter matching testing both whitelist and blacklist matchers
    * simultaneously. For parameters see Matcher.matchesAny().
    * @see Matcher#matchesAny
-   * @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
-   * @param {boolean} specificOnly should be true if generic matches should be
-   *                               ignored
-   * @return {RegExpFilter|null} matching filter or null

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

Please don't duplicate the entire documentation here.

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

OK but now we're getting ESLint failures:

  386:3  error  Missing JSDoc @returns for function         valid-jsdoc
  386:3  error  Missing JSDoc for parameter 'typeMask'      valid-jsdoc
  386:3  error  Missing JSDoc for parameter 'docDomain'     valid-jsdoc
  386:3  error  Missing JSDoc for parameter 'thirdParty'    valid-jsdoc
  386:3  error  Missing JSDoc for parameter 'sitekey'       valid-jsdoc
  386:3  error  Missing JSDoc for parameter 'specificOnly'  valid-jsdoc
  386:3  error  Missing JSDoc for parameter 'location'      valid-jsdoc

[Wladimir Palant, 2017/03/09 14:37:11]

What if we use @augments Matcher on CombinedMatcher? Or does ESlint expect
@inheritDoc?

[kzar, 2017/03/10 06:56:12]

Aha, that worked. Done.

+   * @inheritdoc
    */
   matchesAnyInternal(location, typeMask, docDomain, thirdParty, sitekey,
                      specificOnly)
   {
     let candidates = location.toLowerCase().match(/[a-z0-9%]{3,}/g);
     if (candidates === null)
       candidates = [];
     candidates.push("");
 
     let blacklistHit = null;
@@ skipping 14 matching lines @@
           substr, location, typeMask, docDomain, thirdParty, sitekey,
           specificOnly
         );
       }
     }
     return blacklistHit;
   },
 
   /**
    * @see Matcher#matchesAny
-   * @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
-   * @param {boolean} specificOnly should be true if generic matches should be
-   *                               ignored
-   * @return {RegExpFilter} matching filter or null

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

Please don't duplicate the entire documentation here.

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

Same as above, we're getting `valid-jsdoc` failures here too now.

+   * @inheritdoc
    */
   matchesAny(location, typeMask, docDomain, thirdParty, sitekey, specificOnly)
   {
     let key = location + " " + typeMask + " " + docDomain + " " + thirdParty +
       " " + sitekey + " " + specificOnly;
     if (key in this.resultCache)
       return this.resultCache[key];
 
     let result = this.matchesAnyInternal(location, typeMask, docDomain,
                                          thirdParty, sitekey, specificOnly);
 
     if (this.cacheEntries >= CombinedMatcher.maxCacheEntries)
     {
       this.resultCache = Object.create(null);
       this.cacheEntries = 0;
     }
 
     this.resultCache[key] = result;
     this.cacheEntries++;
 
     return result;
   }
 };
 
 /**
  * Shared CombinedMatcher instance that should usually be used.
  * @type {CombinedMatcher}
  */
-let defaultMatcher = exports.defaultMatcher = new CombinedMatcher();
+exports.defaultMatcher = new CombinedMatcher();