Issue 6482 - Use ES6 classes

lib/filterValidation.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present 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 10 matching lines @@
 
 const {Filter, InvalidFilter, ElemHideBase, ElemHideEmulationFilter} =
       require("filterClasses");
 
 /**
  * An error returned by
  * {@link module:filterValidation.parseFilter parseFilter()} or
  * {@link module:filterValidation.parseFilters parseFilters()}
  * indicating that a given filter cannot be parsed,
  * contains an invalid CSS selector or is a filter list header.
- *

[Manish Jethani, 2018/03/15 07:54:11]

See http://usejsdoc.org/howto-es2015-classes.html

We move the constructor-specific documentation to the constructor and get rid of
the @constructor tag.

- * @param {string} type See documentation in the constructor below.
- * @param {Object} [details] Contains the "reason" and / or "selector"
- *                           properties.
- * @constructor
  */
-function FilterParsingError(type, details)
+class FilterParsingError
 {
   /**
-   * Indicates why the filter is rejected. Possible choices:
-   * "invalid-filter", "invalid-css-selector", "unexpected-filter-list-header"
-   *
-   * @type {string}
+   * @param {string} type See documentation in the constructor below.
+   * @param {Object} [details] Contains the "reason" and / or "selector"
+   *                           properties.
    */
-  this.type = type;
+  constructor(type, details)
+  {
+    /**
+     * Indicates why the filter is rejected. Possible choices:
+     * "invalid-filter", "invalid-css-selector", "unexpected-filter-list-header"
+     *
+     * @type {string}
+     */
+    this.type = type;
 
-  if (details)
-  {
-    if ("reason" in details)
-      this.reason = details.reason;
-    if ("selector" in details)
-      this.selector = details.selector;
+    /**
+     * The line number the error occurred on if
+     * {@link module:filterValidation.parseFilters parseFilters()}
+     * were used. Or null if the error was returned by
+     * {@link module:filterValidation.parseFilter parseFilter()}.
+     *
+     * @type {?number}
+     */
+    this.lineno = null;
+
+    if (details)
+    {
+      if ("reason" in details)
+        this.reason = details.reason;
+      if ("selector" in details)
+        this.selector = details.selector;
+    }
   }
-}
-FilterParsingError.prototype = {
-  /**
-   * The line number the error occurred on if
-   * {@link module:filterValidation.parseFilters parseFilters()}
-   * were used. Or null if the error was returned by
-   * {@link module:filterValidation.parseFilter parseFilter()}.
-   *
-   * @type {?number}
-   */
-  lineno: null,

[Manish Jethani, 2018/03/15 07:54:11]

Again, there's no real need for this to live on the prototype, it can just be
assigned in the constructor.

 
   /**
    * Returns a detailed translated error message.
    *
    * @return {string}
    */
   toString()
   {
     let message;
     if (this.reason)
       message = browser.i18n.getMessage(this.reason);
     else
     {
       message = browser.i18n.getMessage(
         this.type.replace(/-/g, "_"),
         "selector" in this ? "'" + this.selector + "'" : null
       );
     }
 
     if (this.lineno)
     {
       message = browser.i18n.getMessage(
         "line", this.lineno.toLocaleString()
       ) + ": " + message;
     }
     return message;
   }
-};
+}
 
 function isValidCSSSelector(selector)
 {
   let style = document.createElement("style");
   document.documentElement.appendChild(style);
   let {sheet} = style;
   document.documentElement.removeChild(style);
 
   try
   {
@@ skipping 80 matching lines @@
 
     if (error)
     {
       error.lineno = i + 1;
       errors.push(error);
     }
   }
 
   return {filters, errors};
 };