eslint 6.5.1 → 6.6.0

package/lib/rules/generator-star-spacing.js

@@ -78,9 +78,8 @@ module.exports = {
 
         /**
          * Returns resolved option definitions based on an option and defaults
-         *
-         * @param {any} option - The option object or string value
-         * @param {Object} defaults - The defaults to use if options are not present
+         * @param {any} option The option object or string value
+         * @param {Object} defaults The defaults to use if options are not present
          * @returns {Object} the resolved object definition
          */
         function optionToDefinition(option, defaults) {
@@ -107,8 +106,7 @@ module.exports = {
 
         /**
          * Checks if the given token is a star token or not.
-         *
-         * @param {Token} token - The token to check.
+         * @param {Token} token The token to check.
          * @returns {boolean} `true` if the token is a star token.
          */
         function isStarToken(token) {
@@ -117,8 +115,7 @@ module.exports = {
 
         /**
          * Gets the generator star token of the given function node.
-         *
-         * @param {ASTNode} node - The function node to get.
+         * @param {ASTNode} node The function node to get.
          * @returns {Token} Found star token.
          */
         function getStarToken(node) {
@@ -139,7 +136,6 @@ module.exports = {
 
         /**
          * Checks the spacing between two tokens before or after the star token.
-         *
          * @param {string} kind Either "named", "anonymous", or "method"
          * @param {string} side Either "before" or "after".
          * @param {Token} leftToken `function` keyword token if side is "before", or
@@ -173,7 +169,6 @@ module.exports = {
 
         /**
          * Enforces the spacing around the star if node is a generator function.
-         *
          * @param {ASTNode} node A function expression or declaration node.
          * @returns {void}
          */

package/lib/rules/getter-return.js

@@ -18,8 +18,7 @@ const TARGET_NODE_TYPE = /^(?:Arrow)?FunctionExpression$/u;
 
 /**
  * Checks a given code path segment is reachable.
- *
- * @param {CodePathSegment} segment - A segment to check.
+ * @param {CodePathSegment} segment A segment to check.
  * @returns {boolean} `true` if the segment is reachable.
  */
 function isReachable(segment) {
@@ -30,8 +29,7 @@ function isReachable(segment) {
  * Gets a readable location.
  *
  * - FunctionExpression -> the function name or `function` keyword.
- *
- * @param {ASTNode} node - A function node to get.
+ * @param {ASTNode} node A function node to get.
  * @returns {ASTNode|Token} The node or the token of a location.
  */
 function getId(node) {
@@ -92,8 +90,7 @@ module.exports = {
          *
          * If the last code path segment is reachable, there are paths which are not
          * returned or thrown.
-         *
-         * @param {ASTNode} node - A node to check.
+         * @param {ASTNode} node A node to check.
          * @returns {void}
          */
         function checkLastSegment(node) {
@@ -113,7 +110,7 @@ module.exports = {
 
         /**
          * Checks whether a node means a getter function.
-         * @param {ASTNode} node - a node to check.
+         * @param {ASTNode} node a node to check.
          * @returns {boolean} if node means a getter, return true; else return false.
          */
         function isGetter(node) {

package/lib/rules/indent.js

@@ -187,6 +187,7 @@ class BinarySearchTree {
  */
 class TokenInfo {
 
+    // eslint-disable-next-line jsdoc/require-description
     /**
      * @param {SourceCode} sourceCode A SourceCode object
      */
@@ -236,6 +237,7 @@ class TokenInfo {
  */
 class OffsetStorage {
 
+    // eslint-disable-next-line jsdoc/require-description
     /**
      * @param {TokenInfo} tokenInfo a TokenInfo instance
      * @param {number} indentSize The desired size of each indentation level
@@ -329,7 +331,6 @@ class OffsetStorage {
      * Instead, the correct way would be to offset `baz` by 1 level from `bar`, offset `bar` by 1 level from the `)`, and
      * offset the `)` by 0 levels from `foo`. This ensures that the offset between `bar` and the `)` are correctly collapsed
      * in the second case.
-     *
      * @param {Token} token The token
      * @param {Token} fromToken The token that `token` should be offset from
      * @param {number} offset The desired indent level
@@ -358,7 +359,6 @@ class OffsetStorage {
      *
      * The `setDesiredOffsets` methods inserts ranges like the ones above. The third line above would be inserted by using:
      * `setDesiredOffsets([30, 43], fooToken, 1);`
-     *
      * @param {[number, number]} range A [start, end] pair. All tokens with range[0] <= token.start < range[1] will have the offset applied.
      * @param {Token} fromToken The token that this is offset from
      * @param {number} offset The desired indent level

package/lib/rules/init-declarations.js

@@ -11,7 +11,7 @@
 
 /**
  * Checks whether or not a given node is a for loop.
- * @param {ASTNode} block - A node to check.
+ * @param {ASTNode} block A node to check.
  * @returns {boolean} `true` when the node is a for loop.
  */
 function isForLoop(block) {
@@ -22,7 +22,7 @@ function isForLoop(block) {
 
 /**
  * Checks whether or not a given declarator node has its initializer.
- * @param {ASTNode} node - A declarator node to check.
+ * @param {ASTNode} node A declarator node to check.
  * @returns {boolean} `true` when the node has its initializer.
  */
 function isInitialized(node) {

package/lib/rules/jsx-quotes.js

@@ -65,7 +65,7 @@ module.exports = {
 
         /**
          * Checks if the given string literal node uses the expected quotes
-         * @param {ASTNode} node - A string literal node.
+         * @param {ASTNode} node A string literal node.
          * @returns {boolean} Whether or not the string literal used the expected quotes.
          * @public
          */

package/lib/rules/keyword-spacing.js

@@ -41,8 +41,7 @@ const KEYS = keywords.concat(["as", "async", "await", "from", "get", "let", "of"
 
 /**
  * Checks whether or not a given token is a "Template" token ends with "${".
- *
- * @param {Token} token - A token to check.
+ * @param {Token} token A token to check.
  * @returns {boolean} `true` if the token is a "Template" token ends with "${".
  */
 function isOpenParenOfTemplate(token) {
@@ -51,8 +50,7 @@ function isOpenParenOfTemplate(token) {
 
 /**
  * Checks whether or not a given token is a "Template" token starts with "}".
- *
- * @param {Token} token - A token to check.
+ * @param {Token} token A token to check.
  * @returns {boolean} `true` if the token is a "Template" token starts with "}".
  */
 function isCloseParenOfTemplate(token) {
@@ -88,8 +86,8 @@ module.exports = {
                             retv[key] = {
                                 type: "object",
                                 properties: {
-                                    before: { type: "boolean", default: true },
-                                    after: { type: "boolean", default: true }
+                                    before: { type: "boolean" },
+                                    after: { type: "boolean" }
                                 },
                                 additionalProperties: false
                             };
@@ -114,9 +112,8 @@ module.exports = {
 
         /**
          * Reports a given token if there are not space(s) before the token.
-         *
-         * @param {Token} token - A token to report.
-         * @param {RegExp} pattern - A pattern of the previous token to check.
+         * @param {Token} token A token to report.
+         * @param {RegExp} pattern A pattern of the previous token to check.
          * @returns {void}
          */
         function expectSpaceBefore(token, pattern) {
@@ -141,9 +138,8 @@ module.exports = {
 
         /**
          * Reports a given token if there are space(s) before the token.
-         *
-         * @param {Token} token - A token to report.
-         * @param {RegExp} pattern - A pattern of the previous token to check.
+         * @param {Token} token A token to report.
+         * @param {RegExp} pattern A pattern of the previous token to check.
          * @returns {void}
          */
         function unexpectSpaceBefore(token, pattern) {
@@ -168,9 +164,8 @@ module.exports = {
 
         /**
          * Reports a given token if there are not space(s) after the token.
-         *
-         * @param {Token} token - A token to report.
-         * @param {RegExp} pattern - A pattern of the next token to check.
+         * @param {Token} token A token to report.
+         * @param {RegExp} pattern A pattern of the next token to check.
          * @returns {void}
          */
         function expectSpaceAfter(token, pattern) {
@@ -195,9 +190,8 @@ module.exports = {
 
         /**
          * Reports a given token if there are space(s) after the token.
-         *
-         * @param {Token} token - A token to report.
-         * @param {RegExp} pattern - A pattern of the next token to check.
+         * @param {Token} token A token to report.
+         * @param {RegExp} pattern A pattern of the next token to check.
          * @returns {void}
          */
         function unexpectSpaceAfter(token, pattern) {
@@ -222,8 +216,7 @@ module.exports = {
 
         /**
          * Parses the option object and determines check methods for each keyword.
-         *
-         * @param {Object|undefined} options - The option object to parse.
+         * @param {Object|undefined} options The option object to parse.
          * @returns {Object} - Normalized option object.
          *      Keys are keywords (there are for every keyword).
          *      Values are instances of `{"before": function, "after": function}`.
@@ -263,9 +256,8 @@ module.exports = {
         /**
          * Reports a given token if usage of spacing followed by the token is
          * invalid.
-         *
-         * @param {Token} token - A token to report.
-         * @param {RegExp|undefined} pattern - Optional. A pattern of the previous
+         * @param {Token} token A token to report.
+         * @param {RegExp} [pattern] Optional. A pattern of the previous
          *      token to check.
          * @returns {void}
          */
@@ -276,9 +268,8 @@ module.exports = {
         /**
          * Reports a given token if usage of spacing preceded by the token is
          * invalid.
-         *
-         * @param {Token} token - A token to report.
-         * @param {RegExp|undefined} pattern - Optional. A pattern of the next
+         * @param {Token} token A token to report.
+         * @param {RegExp} [pattern] Optional. A pattern of the next
          *      token to check.
          * @returns {void}
          */
@@ -288,8 +279,7 @@ module.exports = {
 
         /**
          * Reports a given token if usage of spacing around the token is invalid.
-         *
-         * @param {Token} token - A token to report.
+         * @param {Token} token A token to report.
          * @returns {void}
          */
         function checkSpacingAround(token) {
@@ -300,8 +290,7 @@ module.exports = {
         /**
          * Reports the first token of a given node if the first token is a keyword
          * and usage of spacing around the token is invalid.
-         *
-         * @param {ASTNode|null} node - A node to report.
+         * @param {ASTNode|null} node A node to report.
          * @returns {void}
          */
         function checkSpacingAroundFirstToken(node) {
@@ -318,8 +307,7 @@ module.exports = {
          *
          * This is used for unary operators (e.g. `typeof`), `function`, and `super`.
          * Other rules are handling usage of spacing preceded by those keywords.
-         *
-         * @param {ASTNode|null} node - A node to report.
+         * @param {ASTNode|null} node A node to report.
          * @returns {void}
          */
         function checkSpacingBeforeFirstToken(node) {
@@ -333,8 +321,7 @@ module.exports = {
         /**
          * Reports the previous token of a given node if the token is a keyword and
          * usage of spacing around the token is invalid.
-         *
-         * @param {ASTNode|null} node - A node to report.
+         * @param {ASTNode|null} node A node to report.
          * @returns {void}
          */
         function checkSpacingAroundTokenBefore(node) {
@@ -348,8 +335,7 @@ module.exports = {
         /**
          * Reports `async` or `function` keywords of a given node if usage of
          * spacing around those keywords is invalid.
-         *
-         * @param {ASTNode} node - A node to report.
+         * @param {ASTNode} node A node to report.
          * @returns {void}
          */
         function checkSpacingForFunction(node) {
@@ -366,8 +352,7 @@ module.exports = {
         /**
          * Reports `class` and `extends` keywords of a given node if usage of
          * spacing around those keywords is invalid.
-         *
-         * @param {ASTNode} node - A node to report.
+         * @param {ASTNode} node A node to report.
          * @returns {void}
          */
         function checkSpacingForClass(node) {
@@ -378,8 +363,7 @@ module.exports = {
         /**
          * Reports `if` and `else` keywords of a given node if usage of spacing
          * around those keywords is invalid.
-         *
-         * @param {ASTNode} node - A node to report.
+         * @param {ASTNode} node A node to report.
          * @returns {void}
          */
         function checkSpacingForIfStatement(node) {
@@ -390,8 +374,7 @@ module.exports = {
         /**
          * Reports `try`, `catch`, and `finally` keywords of a given node if usage
          * of spacing around those keywords is invalid.
-         *
-         * @param {ASTNode} node - A node to report.
+         * @param {ASTNode} node A node to report.
          * @returns {void}
          */
         function checkSpacingForTryStatement(node) {
@@ -403,8 +386,7 @@ module.exports = {
         /**
          * Reports `do` and `while` keywords of a given node if usage of spacing
          * around those keywords is invalid.
-         *
-         * @param {ASTNode} node - A node to report.
+         * @param {ASTNode} node A node to report.
          * @returns {void}
          */
         function checkSpacingForDoWhileStatement(node) {
@@ -415,8 +397,7 @@ module.exports = {
         /**
          * Reports `for` and `in` keywords of a given node if usage of spacing
          * around those keywords is invalid.
-         *
-         * @param {ASTNode} node - A node to report.
+         * @param {ASTNode} node A node to report.
          * @returns {void}
          */
         function checkSpacingForForInStatement(node) {
@@ -427,8 +408,7 @@ module.exports = {
         /**
          * Reports `for` and `of` keywords of a given node if usage of spacing
          * around those keywords is invalid.
-         *
-         * @param {ASTNode} node - A node to report.
+         * @param {ASTNode} node A node to report.
          * @returns {void}
          */
         function checkSpacingForForOfStatement(node) {
@@ -449,8 +429,7 @@ module.exports = {
          *
          *     import*as A from "./a"; /*error Expected space(s) after "import".
          *                               error Expected space(s) before "as".
-         *
-         * @param {ASTNode} node - A node to report.
+         * @param {ASTNode} node A node to report.
          * @returns {void}
          */
         function checkSpacingForModuleDeclaration(node) {
@@ -474,8 +453,7 @@ module.exports = {
         /**
          * Reports `as` keyword of a given node if usage of spacing around this
          * keyword is invalid.
-         *
-         * @param {ASTNode} node - A node to report.
+         * @param {ASTNode} node A node to report.
          * @returns {void}
          */
         function checkSpacingForImportNamespaceSpecifier(node) {
@@ -487,8 +465,7 @@ module.exports = {
         /**
          * Reports `static`, `get`, and `set` keywords of a given node if usage of
          * spacing around those keywords is invalid.
-         *
-         * @param {ASTNode} node - A node to report.
+         * @param {ASTNode} node A node to report.
          * @returns {void}
          */
         function checkSpacingForProperty(node) {
@@ -528,8 +505,7 @@ module.exports = {
         /**
          * Reports `await` keyword of a given node if usage of spacing before
          * this keyword is invalid.
-         *
-         * @param {ASTNode} node - A node to report.
+         * @param {ASTNode} node A node to report.
          * @returns {void}
          */
         function checkSpacingForAwaitExpression(node) {

package/lib/rules/lines-around-directive.js

@@ -131,7 +131,7 @@ module.exports = {
 
         /**
          * Check lines around directives in node
-         * @param {ASTNode} node - node to check
+         * @param {ASTNode} node node to check
          * @returns {void}
          */
         function checkDirectives(node) {

package/lib/rules/max-len.js

@@ -198,7 +198,6 @@ module.exports = {
 
         /**
          * Ensure that an array exists at [key] on `object`, and add `value` to it.
-         *
          * @param {Object} object the object to mutate
          * @param {string} key the object's key
          * @param {*} value the value to add
@@ -214,7 +213,6 @@ module.exports = {
 
         /**
          * Retrieves an array containing all strings (" or ') in the source code.
-         *
          * @returns {ASTNode[]} An array of string nodes.
          */
         function getAllStrings() {
@@ -224,7 +222,6 @@ module.exports = {
 
         /**
          * Retrieves an array containing all template literals in the source code.
-         *
          * @returns {ASTNode[]} An array of template literal nodes.
          */
         function getAllTemplateLiterals() {
@@ -234,7 +231,6 @@ module.exports = {
 
         /**
          * Retrieves an array containing all RegExp literals in the source code.
-         *
          * @returns {ASTNode[]} An array of RegExp literal nodes.
          */
         function getAllRegExpLiterals() {
@@ -244,7 +240,6 @@ module.exports = {
 
         /**
          * A reducer to group an AST node by line number, both start and end.
-         *
          * @param {Object} acc the accumulator
          * @param {ASTNode} node the AST node in question
          * @returns {Object} the modified accumulator

package/lib/rules/max-statements-per-line.js

@@ -61,7 +61,6 @@ module.exports = {
 
         /**
          * Reports with the first extra statement, and clears it.
-         *
          * @returns {void}
          */
         function reportFirstExtraStatementAndClear() {
@@ -81,8 +80,7 @@ module.exports = {
 
         /**
          * Gets the actual last token of a given node.
-         *
-         * @param {ASTNode} node - A node to get. This is a node except EmptyStatement.
+         * @param {ASTNode} node A node to get. This is a node except EmptyStatement.
          * @returns {Token} The actual last token.
          */
         function getActualLastToken(node) {
@@ -92,8 +90,7 @@ module.exports = {
         /**
          * Addresses a given node.
          * It updates the state of this rule, then reports the node if the node violated this rule.
-         *
-         * @param {ASTNode} node - A node to check.
+         * @param {ASTNode} node A node to check.
          * @returns {void}
          */
         function enterStatement(node) {
@@ -127,8 +124,7 @@ module.exports = {
 
         /**
          * Updates the state of this rule with the end line of leaving node to check with the next statement.
-         *
-         * @param {ASTNode} node - A node to check.
+         * @param {ASTNode} node A node to check.
          * @returns {void}
          */
         function leaveStatement(node) {

package/lib/rules/multiline-ternary.js

@@ -46,9 +46,9 @@ module.exports = {
 
         /**
          * Tests whether node is preceded by supplied tokens
-         * @param {ASTNode} node - node to check
-         * @param {ASTNode} parentNode - parent of node to report
-         * @param {boolean} expected - whether newline was expected or not
+         * @param {ASTNode} node node to check
+         * @param {ASTNode} parentNode parent of node to report
+         * @param {boolean} expected whether newline was expected or not
          * @returns {void}
          * @private
          */

package/lib/rules/newline-after-var.js

@@ -72,8 +72,7 @@ module.exports = {
          *     var foo = 1
          *
          *     ;(a || b).doSomething()
-         *
-         * @param {ASTNode} node - The node to get.
+         * @param {ASTNode} node The node to get.
          * @returns {Token} The token to compare line to the next statement.
          */
         function getLastToken(node) {
@@ -93,7 +92,7 @@ module.exports = {
         /**
          * Determine if provided keyword is a variable declaration
          * @private
-         * @param {string} keyword - keyword to test
+         * @param {string} keyword keyword to test
          * @returns {boolean} True if `keyword` is a type of var
          */
         function isVar(keyword) {
@@ -103,7 +102,7 @@ module.exports = {
         /**
          * Determine if provided keyword is a variant of for specifiers
          * @private
-         * @param {string} keyword - keyword to test
+         * @param {string} keyword keyword to test
          * @returns {boolean} True if `keyword` is a variant of for specifier
          */
         function isForTypeSpecifier(keyword) {
@@ -113,7 +112,7 @@ module.exports = {
         /**
          * Determine if provided keyword is an export specifiers
          * @private
-         * @param {string} nodeType - nodeType to test
+         * @param {string} nodeType nodeType to test
          * @returns {boolean} True if `nodeType` is an export specifier
          */
         function isExportSpecifier(nodeType) {
@@ -124,7 +123,7 @@ module.exports = {
         /**
          * Determine if provided node is the last of their parent block.
          * @private
-         * @param {ASTNode} node - node to test
+         * @param {ASTNode} node node to test
          * @returns {boolean} True if `node` is last of their parent block.
          */
         function isLastNode(node) {
@@ -159,7 +158,7 @@ module.exports = {
          * set to "always", or checks that there is no blank line when mode is set
          * to "never"
          * @private
-         * @param {ASTNode} node - `VariableDeclaration` node to test
+         * @param {ASTNode} node `VariableDeclaration` node to test
          * @returns {void}
          */
         function checkForBlankLine(node) {

package/lib/rules/newline-before-return.js

@@ -39,8 +39,8 @@ module.exports = {
 
         /**
          * Tests whether node is preceded by supplied tokens
-         * @param {ASTNode} node - node to check
-         * @param {Array} testTokens - array of tokens to test against
+         * @param {ASTNode} node node to check
+         * @param {Array} testTokens array of tokens to test against
          * @returns {boolean} Whether or not the node is preceded by one of the supplied tokens
          * @private
          */
@@ -52,7 +52,7 @@ module.exports = {
 
         /**
          * Checks whether node is the first node after statement or in block
-         * @param {ASTNode} node - node to check
+         * @param {ASTNode} node node to check
          * @returns {boolean} Whether or not the node is the first node after statement or in block
          * @private
          */
@@ -80,8 +80,8 @@ module.exports = {
 
         /**
          * Returns the number of lines of comments that precede the node
-         * @param {ASTNode} node - node to check for overlapping comments
-         * @param {number} lineNumTokenBefore - line number of previous token, to check for overlapping comments
+         * @param {ASTNode} node node to check for overlapping comments
+         * @param {number} lineNumTokenBefore line number of previous token, to check for overlapping comments
          * @returns {number} Number of lines of comments that precede the node
          * @private
          */
@@ -115,7 +115,7 @@ module.exports = {
 
         /**
          * Returns the line number of the token before the node that is passed in as an argument
-         * @param {ASTNode} node - The node to use as the start of the calculation
+         * @param {ASTNode} node The node to use as the start of the calculation
          * @returns {number} Line number of the token before `node`
          * @private
          */
@@ -142,7 +142,7 @@ module.exports = {
 
         /**
          * Checks whether node is preceded by a newline
-         * @param {ASTNode} node - node to check
+         * @param {ASTNode} node node to check
          * @returns {boolean} Whether or not the node is preceded by a newline
          * @private
          */
@@ -160,8 +160,7 @@ module.exports = {
          * The fix is not considered safe if the given return statement has leading comments,
          * as we cannot safely determine if the newline should be added before or after the comments.
          * For more information, see: https://github.com/eslint/eslint/issues/5958#issuecomment-222767211
-         *
-         * @param {ASTNode} node - The return statement node to check.
+         * @param {ASTNode} node The return statement node to check.
          * @returns {boolean} `true` if it can fix the node.
          * @private
          */

package/lib/rules/newline-per-chained-call.js

@@ -53,8 +53,7 @@ module.exports = {
          * Get the prefix of a given MemberExpression node.
          * If the MemberExpression node is a computed value it returns a
          * left bracket. If not it returns a period.
-         *
-         * @param  {ASTNode} node - A MemberExpression node to get
+         * @param  {ASTNode} node A MemberExpression node to get
          * @returns {string} The prefix of the node.
          */
         function getPrefix(node) {
@@ -64,8 +63,7 @@ module.exports = {
         /**
          * Gets the property text of a given MemberExpression node.
          * If the text is multiline, this returns only the first line.
-         *
-         * @param {ASTNode} node - A MemberExpression node to get.
+         * @param {ASTNode} node A MemberExpression node to get.
          * @returns {string} The property text of the node.
          */
         function getPropertyText(node) {

package/lib/rules/no-class-assign.js

@@ -33,7 +33,7 @@ module.exports = {
 
         /**
          * Finds and reports references that are non initializer and writable.
-         * @param {Variable} variable - A variable to check.
+         * @param {Variable} variable A variable to check.
          * @returns {void}
          */
         function checkVariable(variable) {
@@ -45,7 +45,7 @@ module.exports = {
 
         /**
          * Finds and reports references that are non initializer and writable.
-         * @param {ASTNode} node - A ClassDeclaration/ClassExpression node to check.
+         * @param {ASTNode} node A ClassDeclaration/ClassExpression node to check.
          * @returns {void}
          */
         function checkForClass(node) {

package/lib/rules/no-compare-neg-zero.js

@@ -35,8 +35,7 @@ module.exports = {
 
         /**
          * Checks a given node is -0
-         *
-         * @param {ASTNode} node - A node to check.
+         * @param {ASTNode} node A node to check.
          * @returns {boolean} `true` if the node is -0.
          */
         function isNegZero(node) {