eslint 6.3.0 → 6.6.0

package/lib/cli.js

@@ -20,7 +20,8 @@ const fs = require("fs"),
     mkdirp = require("mkdirp"),
     { CLIEngine } = require("./cli-engine"),
     options = require("./options"),
-    log = require("./shared/logging");
+    log = require("./shared/logging"),
+    RuntimeInfo = require("./shared/runtime-info");
 
 const debug = require("debug")("eslint:cli");
 
@@ -159,13 +160,18 @@ const cli = {
         }
 
         const files = currentOptions._;
-
         const useStdin = typeof text === "string";
 
-        if (currentOptions.version) { // version from package.json
-
-            log.info(`v${require("../package.json").version}`);
-
+        if (currentOptions.version) {
+            log.info(RuntimeInfo.version());
+        } else if (currentOptions.envInfo) {
+            try {
+                log.info(RuntimeInfo.environment());
+                return 0;
+            } catch (err) {
+                log.error(err.message);
+                return 2;
+            }
         } else if (currentOptions.printConfig) {
             if (files.length) {
                 log.error("The --print-config option must be used with exactly one file name.");
@@ -177,17 +183,13 @@ const cli = {
             }
 
             const engine = new CLIEngine(translateOptions(currentOptions));
-
             const fileConfig = engine.getConfigForFile(currentOptions.printConfig);
 
             log.info(JSON.stringify(fileConfig, null, "  "));
             return 0;
         } else if (currentOptions.help || (!files.length && !useStdin)) {
-
             log.info(options.generateHelp());
-
         } else {
-
             debug(`Running on ${useStdin ? "text" : "files"}`);
 
             if (currentOptions.fix && currentOptions.fixDryRun) {
@@ -227,9 +229,8 @@ const cli = {
 
                 return (report.errorCount || tooManyWarnings) ? 1 : 0;
             }
-            return 2;
-
 
+            return 2;
         }
 
         return 0;

package/lib/init/autoconfig.js

@@ -31,7 +31,6 @@ const MAX_CONFIG_COMBINATIONS = 17, // 16 combinations + 1 for severity only
 
 /**
  * Information about a rule configuration, in the context of a Registry.
- *
  * @typedef {Object}     registryItem
  * @param   {ruleConfig} config        A valid configuration for the rule
  * @param   {number}     specificity   The number of elements in the ruleConfig array
@@ -70,6 +69,7 @@ function makeRegistryItems(rulesConfig) {
  */
 class Registry {
 
+    // eslint-disable-next-line jsdoc/require-description
     /**
      * @param {rulesConfig} [rulesConfig] Hash of rule names and arrays of possible configurations
      */
@@ -82,7 +82,6 @@ class Registry {
      *
      * It will set the registry's `rule` property to an object having rule names
      * as keys and an array of registryItems as values.
-     *
      * @returns {void}
      */
     populateFromCoreRules() {
@@ -101,7 +100,6 @@ class Registry {
      * configurations.
      *
      * The length of the returned array will be <= MAX_CONFIG_COMBINATIONS.
-     *
      * @returns {Object[]}          "rules" configurations to use for linting
      */
     buildRuleSets() {
@@ -114,7 +112,6 @@ class Registry {
          *
          * This is broken out into its own function so that it doesn't need to be
          * created inside of the while loop.
-         *
          * @param   {string} rule The ruleId to add.
          * @returns {void}
          */
@@ -162,7 +159,6 @@ class Registry {
      *
      * Note: this also removes rule configurations which were not linted
      * (meaning, they have an undefined errorCount).
-     *
      * @returns {void}
      */
     stripFailingConfigs() {
@@ -185,7 +181,6 @@ class Registry {
 
     /**
      * Removes rule configurations which were not included in a ruleSet
-     *
      * @returns {void}
      */
     stripExtraConfigs() {
@@ -204,7 +199,6 @@ class Registry {
      * Creates a registry of rules which had no error-free configs.
      * The new registry is intended to be analyzed to determine whether its rules
      * should be disabled or set to warning.
-     *
      * @returns {Registry}  A registry of failing rules.
      */
     getFailingRulesRegistry() {
@@ -225,7 +219,6 @@ class Registry {
     /**
      * Create an eslint config for any rules which only have one configuration
      * in the registry.
-     *
      * @returns {Object} An eslint config with rules section populated
      */
     createConfig() {
@@ -243,7 +236,6 @@ class Registry {
 
     /**
      * Return a cloned registry containing only configs with a desired specificity
-     *
      * @param   {number} specificity Only keep configs with this specificity
      * @returns {Registry}           A registry of rules
      */
@@ -261,7 +253,6 @@ class Registry {
 
     /**
      * Lint SourceCodes against all configurations in the registry, and record results
-     *
      * @param   {Object[]} sourceCodes  SourceCode objects for each filename
      * @param   {Object}   config       ESLint config object
      * @param   {progressCallback} [cb] Optional callback for reporting execution status
@@ -327,7 +318,6 @@ class Registry {
  *
  * This will return a new config with `"extends": "eslint:recommended"` and
  * only the rules which have configurations different from the recommended config.
- *
  * @param   {Object} config config object
  * @returns {Object}        config object using `"extends": "eslint:recommended"`
  */

package/lib/init/config-file.js

@@ -23,7 +23,6 @@ const debug = require("debug")("eslint:config-file");
  * Determines sort order for object keys for json-stable-stringify
  *
  * see: https://github.com/samn/json-stable-stringify#cmp
- *
  * @param   {Object} a The first comparison object ({key: akey, value: avalue})
  * @param   {Object} b The second comparison object ({key: bkey, value: bvalue})
  * @returns {number}   1 or -1, used in stringify cmp method

package/lib/init/config-initializer.js

@@ -147,7 +147,6 @@ function getModulesList(config, installESLint) {
  *
  * Note: This clones the config object and returns a new config to avoid mutating
  * the original config parameter.
- *
  * @param   {Object} answers  answers received from inquirer
  * @param   {Object} config   config object
  * @returns {Object}          config object with configured rules

package/lib/init/config-rule.js

@@ -33,7 +33,6 @@ function explodeArray(xs) {
  *
  * For example:
  * combineArrays([a, [b, c]], [x, y]); // -> [[a, x], [a, y], [b, c, x], [b, c, y]]
- *
  * @param   {Array} arr1 The first array to combine.
  * @param   {Array} arr2 The second array to combine.
  * @returns {Array}      A mixture of the elements of the first and second arrays.
@@ -71,7 +70,6 @@ function combineArrays(arr1, arr2) {
  *     [{before: true}, {before: false}],
  *     [{after: true}, {after: false}]
  * ]
- *
  * @param   {Object[]} objects Array of objects, each with one property/value pair
  * @returns {Array[]}          Array of arrays of objects grouped by property
  */
@@ -98,8 +96,7 @@ function groupByProperty(objects) {
  * element in the array is the severity, and is the only required element.
  * Configs may also have one or more additional elements to specify rule
  * configuration or options.
- *
- * @typedef {array|number} ruleConfig
+ * @typedef {Array|number} ruleConfig
  * @param {number}  0  The rule's severity (0, 1, 2).
  */
 
@@ -134,7 +131,6 @@ function groupByProperty(objects) {
  *     {before: false, after: true},
  *     {before: false, after: false}
  * ]
- *
  * @param   {Object[]} objArr1 Single key/value objects, all with the same key
  * @param   {Object[]} objArr2 Single key/value objects, all with another key
  * @returns {Object[]}         Combined objects for each combination of input properties and values
@@ -178,6 +174,7 @@ function combinePropertyObjects(objArr1, objArr2) {
  */
 class RuleConfigSet {
 
+    // eslint-disable-next-line jsdoc/require-description
     /**
      * @param {ruleConfig[]} configs Valid rule configurations
      */
@@ -185,7 +182,7 @@ class RuleConfigSet {
 
         /**
          * Stored valid rule configurations for this instance
-         * @type {array}
+         * @type {Array}
          */
         this.ruleConfigs = configs || [];
     }
@@ -193,7 +190,6 @@ class RuleConfigSet {
     /**
      * Add a severity level to the front of all configs in the instance.
      * This should only be called after all configs have been added to the instance.
-     *
      * @returns {void}
      */
     addErrorSeverity() {

package/lib/init/npm-utils.js

@@ -21,7 +21,6 @@ const fs = require("fs"),
 /**
  * Find the closest package.json file, starting at process.cwd (by default),
  * and working up to root.
- *
  * @param   {string} [startDir=process.cwd()] Starting directory
  * @returns {string}                          Absolute path to closest package.json file
  */
@@ -88,7 +87,6 @@ function fetchPeerDependencies(packageName) {
 
 /**
  * Check whether node modules are include in a project's package.json.
- *
  * @param   {string[]} packages           Array of node module names
  * @param   {Object}  opt                 Options Object
  * @param   {boolean} opt.dependencies    Set to true to check for direct dependencies
@@ -136,7 +134,6 @@ function check(packages, opt) {
  * package.json.
  *
  * Convenience wrapper around check().
- *
  * @param   {string[]} packages  Array of node modules to check.
  * @param   {string}   rootDir   The directory contianing a package.json
  * @returns {Object}             An object whose keys are the module names
@@ -151,7 +148,6 @@ function checkDeps(packages, rootDir) {
  * package.json.
  *
  * Convenience wrapper around check().
- *
  * @param   {string[]} packages  Array of node modules to check.
  * @returns {Object}             An object whose keys are the module names
  *                               and values are booleans indicating installation.
@@ -162,8 +158,7 @@ function checkDevDeps(packages) {
 
 /**
  * Check whether package.json is found in current path.
- *
- * @param   {string=} startDir Starting directory
+ * @param   {string} [startDir] Starting directory
  * @returns {boolean} Whether a package.json is found in current path.
  */
 function checkPackageJson(startDir) {

package/lib/linter/code-path-analysis/code-path-analyzer.js

@@ -22,8 +22,7 @@ const assert = require("assert"),
 
 /**
  * Checks whether or not a given node is a `case` node (not `default` node).
- *
- * @param {ASTNode} node - A `SwitchCase` node to check.
+ * @param {ASTNode} node A `SwitchCase` node to check.
  * @returns {boolean} `true` if the node is a `case` node (not `default` node).
  */
 function isCaseNode(node) {
@@ -33,8 +32,7 @@ function isCaseNode(node) {
 /**
  * Checks whether the given logical operator is taken into account for the code
  * path analysis.
- *
- * @param {string} operator - The operator found in the LogicalExpression node
+ * @param {string} operator The operator found in the LogicalExpression node
  * @returns {boolean} `true` if the operator is "&&" or "||"
  */
 function isHandledLogicalOperator(operator) {
@@ -43,8 +41,7 @@ function isHandledLogicalOperator(operator) {
 
 /**
  * Gets the label if the parent node of a given node is a LabeledStatement.
- *
- * @param {ASTNode} node - A node to get.
+ * @param {ASTNode} node A node to get.
  * @returns {string|null} The label or `null`.
  */
 function getLabel(node) {
@@ -57,8 +54,7 @@ function getLabel(node) {
 /**
  * Checks whether or not a given logical expression node goes different path
  * between the `true` case and the `false` case.
- *
- * @param {ASTNode} node - A node to check.
+ * @param {ASTNode} node A node to check.
  * @returns {boolean} `true` if the node is a test of a choice statement.
  */
 function isForkingByTrueOrFalse(node) {
@@ -86,8 +82,7 @@ function isForkingByTrueOrFalse(node) {
  * This is used to detect infinity loops (e.g. `while (true) {}`).
  * Statements preceded by an infinity loop are unreachable if the loop didn't
  * have any `break` statement.
- *
- * @param {ASTNode} node - A node to get.
+ * @param {ASTNode} node A node to get.
  * @returns {boolean|undefined} a boolean value if the node is a Literal node,
  *   otherwise `undefined`.
  */
@@ -102,8 +97,7 @@ function getBooleanValueIfSimpleConstant(node) {
  * Checks that a given identifier node is a reference or not.
  *
  * This is used to detect the first throwable node in a `try` block.
- *
- * @param {ASTNode} node - An Identifier node to check.
+ * @param {ASTNode} node An Identifier node to check.
  * @returns {boolean} `true` if the node is a reference.
  */
 function isIdentifierReference(node) {
@@ -153,9 +147,8 @@ function isIdentifierReference(node) {
  *
  * In this process, both "onCodePathSegmentStart" and "onCodePathSegmentEnd"
  * events are fired.
- *
- * @param {CodePathAnalyzer} analyzer - The instance.
- * @param {ASTNode} node - The current AST node.
+ * @param {CodePathAnalyzer} analyzer The instance.
+ * @param {ASTNode} node The current AST node.
  * @returns {void}
  */
 function forwardCurrentToHead(analyzer, node) {
@@ -211,9 +204,8 @@ function forwardCurrentToHead(analyzer, node) {
 /**
  * Updates the current segment with empty.
  * This is called at the last of functions or the program.
- *
- * @param {CodePathAnalyzer} analyzer - The instance.
- * @param {ASTNode} node - The current AST node.
+ * @param {CodePathAnalyzer} analyzer The instance.
+ * @param {ASTNode} node The current AST node.
  * @returns {void}
  */
 function leaveFromCurrentSegment(analyzer, node) {
@@ -242,9 +234,8 @@ function leaveFromCurrentSegment(analyzer, node) {
  *
  * For example, if the node is `parent.consequent`, this creates a fork from the
  * current path.
- *
- * @param {CodePathAnalyzer} analyzer - The instance.
- * @param {ASTNode} node - The current AST node.
+ * @param {CodePathAnalyzer} analyzer The instance.
+ * @param {ASTNode} node The current AST node.
  * @returns {void}
  */
 function preprocess(analyzer, node) {
@@ -352,9 +343,8 @@ function preprocess(analyzer, node) {
 
 /**
  * Updates the code path due to the type of a given node in entering.
- *
- * @param {CodePathAnalyzer} analyzer - The instance.
- * @param {ASTNode} node - The current AST node.
+ * @param {CodePathAnalyzer} analyzer The instance.
+ * @param {ASTNode} node The current AST node.
  * @returns {void}
  */
 function processCodePathToEnter(analyzer, node) {
@@ -449,9 +439,8 @@ function processCodePathToEnter(analyzer, node) {
 
 /**
  * Updates the code path due to the type of a given node in leaving.
- *
- * @param {CodePathAnalyzer} analyzer - The instance.
- * @param {ASTNode} node - The current AST node.
+ * @param {CodePathAnalyzer} analyzer The instance.
+ * @param {ASTNode} node The current AST node.
  * @returns {void}
  */
 function processCodePathToExit(analyzer, node) {
@@ -563,9 +552,8 @@ function processCodePathToExit(analyzer, node) {
 
 /**
  * Updates the code path to finalize the current code path.
- *
- * @param {CodePathAnalyzer} analyzer - The instance.
- * @param {ASTNode} node - The current AST node.
+ * @param {CodePathAnalyzer} analyzer The instance.
+ * @param {ASTNode} node The current AST node.
  * @returns {void}
  */
 function postprocess(analyzer, node) {
@@ -609,8 +597,9 @@ function postprocess(analyzer, node) {
  */
 class CodePathAnalyzer {
 
+    // eslint-disable-next-line jsdoc/require-description
     /**
-     * @param {EventGenerator} eventGenerator - An event generator to wrap.
+     * @param {EventGenerator} eventGenerator An event generator to wrap.
      */
     constructor(eventGenerator) {
         this.original = eventGenerator;
@@ -624,8 +613,7 @@ class CodePathAnalyzer {
     /**
      * Does the process to enter a given AST node.
      * This updates state of analysis and calls `enterNode` of the wrapped.
-     *
-     * @param {ASTNode} node - A node which is entering.
+     * @param {ASTNode} node A node which is entering.
      * @returns {void}
      */
     enterNode(node) {
@@ -651,8 +639,7 @@ class CodePathAnalyzer {
     /**
      * Does the process to leave a given AST node.
      * This updates state of analysis and calls `leaveNode` of the wrapped.
-     *
-     * @param {ASTNode} node - A node which is leaving.
+     * @param {ASTNode} node A node which is leaving.
      * @returns {void}
      */
     leaveNode(node) {
@@ -676,9 +663,8 @@ class CodePathAnalyzer {
     /**
      * This is called on a code path looped.
      * Then this raises a looped event.
-     *
-     * @param {CodePathSegment} fromSegment - A segment of prev.
-     * @param {CodePathSegment} toSegment - A segment of next.
+     * @param {CodePathSegment} fromSegment A segment of prev.
+     * @param {CodePathSegment} toSegment A segment of next.
      * @returns {void}
      */
     onLooped(fromSegment, toSegment) {

package/lib/linter/code-path-analysis/code-path-segment.js

@@ -17,8 +17,7 @@ const debug = require("./debug-helpers");
 
 /**
  * Checks whether or not a given 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) {
@@ -34,11 +33,12 @@ function isReachable(segment) {
  */
 class CodePathSegment {
 
+    // eslint-disable-next-line jsdoc/require-description
     /**
-     * @param {string} id - An identifier.
-     * @param {CodePathSegment[]} allPrevSegments - An array of the previous segments.
+     * @param {string} id An identifier.
+     * @param {CodePathSegment[]} allPrevSegments An array of the previous segments.
      *   This array includes unreachable segments.
-     * @param {boolean} reachable - A flag which shows this is reachable.
+     * @param {boolean} reachable A flag which shows this is reachable.
      */
     constructor(id, allPrevSegments, reachable) {
 
@@ -98,8 +98,7 @@ class CodePathSegment {
 
     /**
      * Checks a given previous segment is coming from the end of a loop.
-     *
-     * @param {CodePathSegment} segment - A previous segment to check.
+     * @param {CodePathSegment} segment A previous segment to check.
      * @returns {boolean} `true` if the segment is coming from the end of a loop.
      */
     isLoopedPrevSegment(segment) {
@@ -108,8 +107,7 @@ class CodePathSegment {
 
     /**
      * Creates the root segment.
-     *
-     * @param {string} id - An identifier.
+     * @param {string} id An identifier.
      * @returns {CodePathSegment} The created segment.
      */
     static newRoot(id) {
@@ -118,9 +116,8 @@ class CodePathSegment {
 
     /**
      * Creates a segment that follows given segments.
-     *
-     * @param {string} id - An identifier.
-     * @param {CodePathSegment[]} allPrevSegments - An array of the previous segments.
+     * @param {string} id An identifier.
+     * @param {CodePathSegment[]} allPrevSegments An array of the previous segments.
      * @returns {CodePathSegment} The created segment.
      */
     static newNext(id, allPrevSegments) {
@@ -133,9 +130,8 @@ class CodePathSegment {
 
     /**
      * Creates an unreachable segment that follows given segments.
-     *
-     * @param {string} id - An identifier.
-     * @param {CodePathSegment[]} allPrevSegments - An array of the previous segments.
+     * @param {string} id An identifier.
+     * @param {CodePathSegment[]} allPrevSegments An array of the previous segments.
      * @returns {CodePathSegment} The created segment.
      */
     static newUnreachable(id, allPrevSegments) {
@@ -154,9 +150,8 @@ class CodePathSegment {
      * Creates a segment that follows given segments.
      * This factory method does not connect with `allPrevSegments`.
      * But this inherits `reachable` flag.
-     *
-     * @param {string} id - An identifier.
-     * @param {CodePathSegment[]} allPrevSegments - An array of the previous segments.
+     * @param {string} id An identifier.
+     * @param {CodePathSegment[]} allPrevSegments An array of the previous segments.
      * @returns {CodePathSegment} The created segment.
      */
     static newDisconnected(id, allPrevSegments) {
@@ -167,8 +162,7 @@ class CodePathSegment {
      * Makes a given segment being used.
      *
      * And this function registers the segment into the previous segments as a next.
-     *
-     * @param {CodePathSegment} segment - A segment to mark.
+     * @param {CodePathSegment} segment A segment to mark.
      * @returns {void}
      */
     static markUsed(segment) {
@@ -195,9 +189,8 @@ class CodePathSegment {
 
     /**
      * Marks a previous segment as looped.
-     *
-     * @param {CodePathSegment} segment - A segment.
-     * @param {CodePathSegment} prevSegment - A previous segment to mark.
+     * @param {CodePathSegment} segment A segment.
+     * @param {CodePathSegment} prevSegment A previous segment to mark.
      * @returns {void}
      */
     static markPrevSegmentAsLooped(segment, prevSegment) {
@@ -206,8 +199,7 @@ class CodePathSegment {
 
     /**
      * Replaces unused segments with the previous segments of each unused segment.
-     *
-     * @param {CodePathSegment[]} segments - An array of segments to replace.
+     * @param {CodePathSegment[]} segments An array of segments to replace.
      * @returns {CodePathSegment[]} The replaced array.
      */
     static flattenUnusedSegments(segments) {