eslint 6.5.1 → 6.6.0

package/lib/rules/vars-on-top.js

@@ -32,8 +32,9 @@ module.exports = {
         // Helpers
         //--------------------------------------------------------------------------
 
+        // eslint-disable-next-line jsdoc/require-description
         /**
-         * @param {ASTNode} node - any node
+         * @param {ASTNode} node any node
          * @returns {boolean} whether the given node structurally represents a directive
          */
         function looksLikeDirective(node) {
@@ -43,7 +44,7 @@ module.exports = {
 
         /**
          * Check to see if its a ES6 import declaration
-         * @param {ASTNode} node - any node
+         * @param {ASTNode} node any node
          * @returns {boolean} whether the given node represents a import declaration
          */
         function looksLikeImport(node) {
@@ -53,8 +54,7 @@ module.exports = {
 
         /**
          * Checks whether a given node is a variable declaration or not.
-         *
-         * @param {ASTNode} node - any node
+         * @param {ASTNode} node any node
          * @returns {boolean} `true` if the node is a variable declaration.
          */
         function isVariableDeclaration(node) {
@@ -70,8 +70,8 @@ module.exports = {
 
         /**
          * Checks whether this variable is on top of the block body
-         * @param {ASTNode} node - The node to check
-         * @param {ASTNode[]} statements - collection of ASTNodes for the parent node block
+         * @param {ASTNode} node The node to check
+         * @param {ASTNode[]} statements collection of ASTNodes for the parent node block
          * @returns {boolean} True if var is on top otherwise false
          */
         function isVarOnTop(node, statements) {
@@ -99,8 +99,8 @@ module.exports = {
 
         /**
          * Checks whether variable is on top at the global level
-         * @param {ASTNode} node - The node to check
-         * @param {ASTNode} parent - Parent of the node
+         * @param {ASTNode} node The node to check
+         * @param {ASTNode} parent Parent of the node
          * @returns {void}
          */
         function globalVarCheck(node, parent) {
@@ -111,9 +111,9 @@ module.exports = {
 
         /**
          * Checks whether variable is on top at functional block scope level
-         * @param {ASTNode} node - The node to check
-         * @param {ASTNode} parent - Parent of the node
-         * @param {ASTNode} grandParent - Parent of the node's parent
+         * @param {ASTNode} node The node to check
+         * @param {ASTNode} parent Parent of the node
+         * @param {ASTNode} grandParent Parent of the node's parent
          * @returns {void}
          */
         function blockScopeVarCheck(node, parent, grandParent) {

package/lib/shared/config-ops.js

@@ -77,7 +77,7 @@ module.exports = {
 
     /**
      * Checks whether a given config has valid severity or not.
-     * @param {number|string|Array} ruleConfig - The configuration for an individual rule.
+     * @param {number|string|Array} ruleConfig The configuration for an individual rule.
      * @returns {boolean} `true` if the configuration has valid severity.
      */
     isValidSeverity(ruleConfig) {
@@ -91,7 +91,7 @@ module.exports = {
 
     /**
      * Checks whether every rule of a given config has valid severity or not.
-     * @param {Object} config - The configuration for rules.
+     * @param {Object} config The configuration for rules.
      * @returns {boolean} `true` if the configuration has valid severity.
      */
     isEverySeverityValid(config) {

package/lib/shared/runtime-info.js

@@ -28,8 +28,8 @@ function environment() {
 
     /**
      * Checks if a path is a child of a directory.
-     * @param {string} parentPath - The parent path to check.
-     * @param {string} childPath - The path to check.
+     * @param {string} parentPath The parent path to check.
+     * @param {string} childPath The path to check.
      * @returns {boolean} Whether or not the given path is a child of a directory.
      */
     function isChildOfDirectory(parentPath, childPath) {
@@ -38,8 +38,8 @@ function environment() {
 
     /**
      * Synchronously executes a shell command and formats the result.
-     * @param {string} cmd - The command to execute.
-     * @param {Array} args - The arguments to be executed with the command.
+     * @param {string} cmd The command to execute.
+     * @param {Array} args The arguments to be executed with the command.
      * @returns {string} The version returned by the command.
      */
     function execCommand(cmd, args) {
@@ -63,7 +63,7 @@ function environment() {
 
     /**
      * Normalizes a version number.
-     * @param {string} versionStr - The string to normalize.
+     * @param {string} versionStr The string to normalize.
      * @returns {string} The normalized version number.
      */
     function normalizeVersionStr(versionStr) {
@@ -72,7 +72,7 @@ function environment() {
 
     /**
      * Gets bin version.
-     * @param {string} bin - The bin to check.
+     * @param {string} bin The bin to check.
      * @returns {string} The normalized version returned by the command.
      */
     function getBinVersion(bin) {
@@ -88,8 +88,8 @@ function environment() {
 
     /**
      * Gets installed npm package version.
-     * @param {string} pkg - The package to check.
-     * @param {boolean} global - Whether to check globally or not.
+     * @param {string} pkg The package to check.
+     * @param {boolean} global Whether to check globally or not.
      * @returns {string} The normalized version returned by the command.
      */
     function getNpmPackageVersion(pkg, { global = false } = {}) {

package/lib/shared/traverser.js

@@ -65,6 +65,7 @@ class Traverser {
         this._leave = null;
     }
 
+    // eslint-disable-next-line jsdoc/require-description
     /**
      * @returns {ASTNode} The current node.
      */
@@ -72,6 +73,7 @@ class Traverser {
         return this._current;
     }
 
+    // eslint-disable-next-line jsdoc/require-description
     /**
      * @returns {ASTNode[]} The ancestor nodes.
      */

package/lib/source-code/source-code.js

@@ -86,13 +86,13 @@ class SourceCode extends TokenStore {
 
     /**
      * Represents parsed source code.
-     * @param {string|Object} textOrConfig - The source code text or config object.
-     * @param {string} textOrConfig.text - The source code text.
-     * @param {ASTNode} textOrConfig.ast - The Program node of the AST representing the code. This AST should be created from the text that BOM was stripped.
-     * @param {Object|null} textOrConfig.parserServices - The parser services.
-     * @param {ScopeManager|null} textOrConfig.scopeManager - The scope of this source code.
-     * @param {Object|null} textOrConfig.visitorKeys - The visitor keys to traverse AST.
-     * @param {ASTNode} [astIfNoConfig] - The Program node of the AST representing the code. This AST should be created from the text that BOM was stripped.
+     * @param {string|Object} textOrConfig The source code text or config object.
+     * @param {string} textOrConfig.text The source code text.
+     * @param {ASTNode} textOrConfig.ast The Program node of the AST representing the code. This AST should be created from the text that BOM was stripped.
+     * @param {Object|null} textOrConfig.parserServices The parser services.
+     * @param {ScopeManager|null} textOrConfig.scopeManager The scope of this source code.
+     * @param {Object|null} textOrConfig.visitorKeys The visitor keys to traverse AST.
+     * @param {ASTNode} [astIfNoConfig] The Program node of the AST representing the code. This AST should be created from the text that BOM was stripped.
      */
     constructor(textOrConfig, astIfNoConfig) {
         let text, ast, parserServices, scopeManager, visitorKeys;
@@ -423,7 +423,7 @@ class SourceCode extends TokenStore {
     isSpaceBetweenTokens(first, second) {
         const text = this.text.slice(first.range[1], second.range[0]);
 
-        return /\s/u.test(text.replace(/\/\*.*?\*\//gu, ""));
+        return /\s/u.test(text.replace(/\/\*.*?\*\//gus, ""));
     }
 
     /**

package/lib/source-code/token-store/backward-token-comment-cursor.js

@@ -22,11 +22,11 @@ module.exports = class BackwardTokenCommentCursor extends Cursor {
 
     /**
      * Initializes this cursor.
-     * @param {Token[]} tokens - The array of tokens.
-     * @param {Comment[]} comments - The array of comments.
-     * @param {Object} indexMap - The map from locations to indices in `tokens`.
-     * @param {number} startLoc - The start location of the iteration range.
-     * @param {number} endLoc - The end location of the iteration range.
+     * @param {Token[]} tokens The array of tokens.
+     * @param {Comment[]} comments The array of comments.
+     * @param {Object} indexMap The map from locations to indices in `tokens`.
+     * @param {number} startLoc The start location of the iteration range.
+     * @param {number} endLoc The end location of the iteration range.
      */
     constructor(tokens, comments, indexMap, startLoc, endLoc) {
         super();

package/lib/source-code/token-store/backward-token-cursor.js

@@ -22,11 +22,11 @@ module.exports = class BackwardTokenCursor extends Cursor {
 
     /**
      * Initializes this cursor.
-     * @param {Token[]} tokens - The array of tokens.
-     * @param {Comment[]} comments - The array of comments.
-     * @param {Object} indexMap - The map from locations to indices in `tokens`.
-     * @param {number} startLoc - The start location of the iteration range.
-     * @param {number} endLoc - The end location of the iteration range.
+     * @param {Token[]} tokens The array of tokens.
+     * @param {Comment[]} comments The array of comments.
+     * @param {Object} indexMap The map from locations to indices in `tokens`.
+     * @param {number} startLoc The start location of the iteration range.
+     * @param {number} endLoc The end location of the iteration range.
      */
     constructor(tokens, comments, indexMap, startLoc, endLoc) {
         super();

package/lib/source-code/token-store/cursors.js

@@ -28,8 +28,8 @@ class CursorFactory {
 
     /**
      * Initializes this cursor.
-     * @param {Function} TokenCursor - The class of the cursor which iterates tokens only.
-     * @param {Function} TokenCommentCursor - The class of the cursor which iterates the mix of tokens and comments.
+     * @param {Function} TokenCursor The class of the cursor which iterates tokens only.
+     * @param {Function} TokenCommentCursor The class of the cursor which iterates the mix of tokens and comments.
      */
     constructor(TokenCursor, TokenCommentCursor) {
         this.TokenCursor = TokenCursor;
@@ -38,13 +38,12 @@ class CursorFactory {
 
     /**
      * Creates a base cursor instance that can be decorated by createCursor.
-     *
-     * @param {Token[]} tokens - The array of tokens.
-     * @param {Comment[]} comments - The array of comments.
-     * @param {Object} indexMap - The map from locations to indices in `tokens`.
-     * @param {number} startLoc - The start location of the iteration range.
-     * @param {number} endLoc - The end location of the iteration range.
-     * @param {boolean} includeComments - The flag to iterate comments as well.
+     * @param {Token[]} tokens The array of tokens.
+     * @param {Comment[]} comments The array of comments.
+     * @param {Object} indexMap The map from locations to indices in `tokens`.
+     * @param {number} startLoc The start location of the iteration range.
+     * @param {number} endLoc The end location of the iteration range.
+     * @param {boolean} includeComments The flag to iterate comments as well.
      * @returns {Cursor} The created base cursor.
      */
     createBaseCursor(tokens, comments, indexMap, startLoc, endLoc, includeComments) {
@@ -55,16 +54,15 @@ class CursorFactory {
 
     /**
      * Creates a cursor that iterates tokens with normalized options.
-     *
-     * @param {Token[]} tokens - The array of tokens.
-     * @param {Comment[]} comments - The array of comments.
-     * @param {Object} indexMap - The map from locations to indices in `tokens`.
-     * @param {number} startLoc - The start location of the iteration range.
-     * @param {number} endLoc - The end location of the iteration range.
-     * @param {boolean} includeComments - The flag to iterate comments as well.
-     * @param {Function|null} filter - The predicate function to choose tokens.
-     * @param {number} skip - The count of tokens the cursor skips.
-     * @param {number} count - The maximum count of tokens the cursor iterates. Zero is no iteration for backward compatibility.
+     * @param {Token[]} tokens The array of tokens.
+     * @param {Comment[]} comments The array of comments.
+     * @param {Object} indexMap The map from locations to indices in `tokens`.
+     * @param {number} startLoc The start location of the iteration range.
+     * @param {number} endLoc The end location of the iteration range.
+     * @param {boolean} includeComments The flag to iterate comments as well.
+     * @param {Function|null} filter The predicate function to choose tokens.
+     * @param {number} skip The count of tokens the cursor skips.
+     * @param {number} count The maximum count of tokens the cursor iterates. Zero is no iteration for backward compatibility.
      * @returns {Cursor} The created cursor.
      */
     createCursor(tokens, comments, indexMap, startLoc, endLoc, includeComments, filter, skip, count) {

package/lib/source-code/token-store/decorative-cursor.js

@@ -21,7 +21,7 @@ module.exports = class DecorativeCursor extends Cursor {
 
     /**
      * Initializes this cursor.
-     * @param {Cursor} cursor - The cursor to be decorated.
+     * @param {Cursor} cursor The cursor to be decorated.
      */
     constructor(cursor) {
         super();

package/lib/source-code/token-store/filter-cursor.js

@@ -21,8 +21,8 @@ module.exports = class FilterCursor extends DecorativeCursor {
 
     /**
      * Initializes this cursor.
-     * @param {Cursor} cursor - The cursor to be decorated.
-     * @param {Function} predicate - The predicate function to decide tokens this cursor iterates.
+     * @param {Cursor} cursor The cursor to be decorated.
+     * @param {Function} predicate The predicate function to decide tokens this cursor iterates.
      */
     constructor(cursor, predicate) {
         super(cursor);

package/lib/source-code/token-store/forward-token-comment-cursor.js

@@ -22,11 +22,11 @@ module.exports = class ForwardTokenCommentCursor extends Cursor {
 
     /**
      * Initializes this cursor.
-     * @param {Token[]} tokens - The array of tokens.
-     * @param {Comment[]} comments - The array of comments.
-     * @param {Object} indexMap - The map from locations to indices in `tokens`.
-     * @param {number} startLoc - The start location of the iteration range.
-     * @param {number} endLoc - The end location of the iteration range.
+     * @param {Token[]} tokens The array of tokens.
+     * @param {Comment[]} comments The array of comments.
+     * @param {Object} indexMap The map from locations to indices in `tokens`.
+     * @param {number} startLoc The start location of the iteration range.
+     * @param {number} endLoc The end location of the iteration range.
      */
     constructor(tokens, comments, indexMap, startLoc, endLoc) {
         super();

package/lib/source-code/token-store/forward-token-cursor.js

@@ -22,11 +22,11 @@ module.exports = class ForwardTokenCursor extends Cursor {
 
     /**
      * Initializes this cursor.
-     * @param {Token[]} tokens - The array of tokens.
-     * @param {Comment[]} comments - The array of comments.
-     * @param {Object} indexMap - The map from locations to indices in `tokens`.
-     * @param {number} startLoc - The start location of the iteration range.
-     * @param {number} endLoc - The end location of the iteration range.
+     * @param {Token[]} tokens The array of tokens.
+     * @param {Comment[]} comments The array of comments.
+     * @param {Object} indexMap The map from locations to indices in `tokens`.
+     * @param {number} startLoc The start location of the iteration range.
+     * @param {number} endLoc The end location of the iteration range.
      */
     constructor(tokens, comments, indexMap, startLoc, endLoc) {
         super();