Issue 4878 - Start using ESLint for adblockpluscore

lib/subscriptionClasses.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 142 matching lines @@
 };
 
 /**
  * Cache for known filter subscriptions, maps URL to subscription objects.
  * @type {Object}
  */
 Subscription.knownSubscriptions = Object.create(null);
 
 /**
  * Returns a subscription from its URL, creates a new one if necessary.
- * @param {string} url  URL of the subscription
- * @return {Subscription} subscription or null if the subscription couldn't be
- *                        created

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

Messy indentation here.

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

Done.

+ * @param {string} url
+ *   URL of the subscription
+ * @return {Subscription}
+ *   subscription or null if the subscription couldn't be created
  */
 Subscription.fromURL = function(url)
 {
   if (url in Subscription.knownSubscriptions)
     return Subscription.knownSubscriptions[url];
 
   if (url[0] != "~")
     return new DownloadableSubscription(url, null);
   return new SpecialSubscription(url);
 };
 
 /**
  * Deserializes a subscription
  *
- * @param {Object}  obj map of serialized properties and their values
- * @return {Subscription} subscription or null if the subscription couldn't be
- *                        created

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

Messy indentation here.

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

Done.

+ * @param {Object}  obj
+ *   map of serialized properties and their values
+ * @return {Subscription}
+ *   subscription or null if the subscription couldn't be created
  */
 Subscription.fromObject = function(obj)
 {
   let result;
   if (obj.url[0] != "~")
   {
     // URL is valid - this is a downloadable subscription
     result = new DownloadableSubscription(obj.url, obj.title);
     if ("downloadStatus" in obj)
       result._downloadStatus = obj.downloadStatus;
@@ skipping 69 matching lines @@
         if (!(filter instanceof ActiveFilter) && type == "blacklist")
           return true;
       }
     }
 
     return false;
   },
 
   /**
    * See Subscription.serialize()
-   * @param {string[]} buffer  buffer to push the serialization results into

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

Please don't duplicate this documentation all over the place.

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

OK but now we're getting ESLint errors "Missing JSDoc for parameter 'buffer' 
valid-jsdoc".

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

What if you use @inheritDoc here?

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

Done.

+   * @inheritdoc
    */
   serialize(buffer)
   {
     Subscription.prototype.serialize.call(this, buffer);
     if (this.defaults && this.defaults.length)
     {
-      buffer.push("defaults=" + this.defaults.filter(

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

Please move everything after "defaults=" to the next line an indent, currently
you are matching up the wrong parentheses.

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

Done.

-        type => type in SpecialSubscription.defaultsMap).join(" ")
+      buffer.push("defaults=" +
+        this.defaults.filter(
+          type => type in SpecialSubscription.defaultsMap
+        ).join(" ")
       );
     }
     if (this._lastDownload)
       buffer.push("lastDownload=" + this._lastDownload);
   }
 });
 
 SpecialSubscription.defaultsMap = Object.create(null, desc({
   whitelist: WhitelistFilter,
   blocking: BlockingFilter,
   elemhide: ElemHideBase
 }));
 
 /**
  * Creates a new user-defined filter group.
  * @param {string} [title]  title of the new filter group
  * @return {SpecialSubscription}
  */
 SpecialSubscription.create = function(title)
 {
   let url;
   do
+  {
     url = "~user~" + Math.round(Math.random() * 1000000);
-  while (url in Subscription.knownSubscriptions);

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

Another case where I just don't know how to fix it properly :-(

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

Fixed now since we removed the curl rule.

+  } while (url in Subscription.knownSubscriptions);
   return new SpecialSubscription(url, title);
 };
 
 /**
  * Creates a new user-defined filter group and adds the given filter to it.
  * This group will act as the default group for this filter type.
  * @param {Filter} filter
  * @return {SpecialSubscription}
  */
 SpecialSubscription.createForFilter = function(filter)
@@ skipping 64 matching lines @@
       let oldValue = this._lastDownload;
       this._lastDownload = value;
       FilterNotifier.triggerListeners("subscription.lastDownload",
                                       this, value, oldValue);
     }
     return this._lastDownload;
   },
 
   /**
    * See Subscription.serialize()
-   * @param {string[]} buffer
+   * @inheritdoc
    */
   serialize(buffer)
   {
     Subscription.prototype.serialize.call(this, buffer);
     if (this._homepage)
       buffer.push("homepage=" + this._homepage);
     if (this._lastDownload)
       buffer.push("lastDownload=" + this._lastDownload);
   }
 });
 
 /**
  * Class for filter subscriptions updated externally (by other extension)
  * @param {string} url    see Subscription()
  * @param {string} [title]  see Subscription()
  * @constructor
  * @augments RegularSubscription
  */
 function ExternalSubscription(url, title)
 {
   RegularSubscription.call(this, url, title);
 }
 exports.ExternalSubscription = ExternalSubscription;
 
 ExternalSubscription.prototype = extend(RegularSubscription, {
   /**
    * See Subscription.serialize()
-   * @param {string[]} buffer
+   * @inheritdoc
    */
   serialize(buffer)
   {
     throw new Error(
       "Unexpected call, external subscriptions should not be serialized"
     );
   }
 });
 
 /**
@@ skipping 107 matching lines @@
   requiredVersion: null,
 
   /**
    * Number indicating how often the object was downloaded.
    * @type {number}
    */
   downloadCount: 0,
 
   /**
    * See Subscription.serialize()
-   * @param {string[]} buffer
+   * @inheritdoc
    */
   serialize(buffer)
   {
     RegularSubscription.prototype.serialize.call(this, buffer);
     if (this.downloadStatus)
       buffer.push("downloadStatus=" + this.downloadStatus);
     if (this.lastSuccess)
       buffer.push("lastSuccess=" + this.lastSuccess);
     if (this.lastCheck)
       buffer.push("lastCheck=" + this.lastCheck);
     if (this.expires)
       buffer.push("expires=" + this.expires);
     if (this.softExpiration)
       buffer.push("softExpiration=" + this.softExpiration);
     if (this.errors)
       buffer.push("errors=" + this.errors);
     if (this.version)
       buffer.push("version=" + this.version);
     if (this.requiredVersion)
       buffer.push("requiredVersion=" + this.requiredVersion);
     if (this.downloadCount)
       buffer.push("downloadCount=" + this.downloadCount);
   }
 });