eslint 6.5.0 → 6.7.1

package/lib/cli-engine/file-enumerator.js

@@ -40,8 +40,8 @@ const getGlobParent = require("glob-parent");
 const isGlob = require("is-glob");
 const { escapeRegExp } = require("lodash");
 const { Minimatch } = require("minimatch");
+const { IgnorePattern } = require("./config-array");
 const { CascadingConfigArrayFactory } = require("./cascading-config-array-factory");
-const { IgnoredPaths } = require("./ignored-paths");
 const debug = require("debug")("eslint:file-enumerator");
 
 //------------------------------------------------------------------------------
@@ -64,7 +64,6 @@ const IGNORED = 2;
  * @property {string[]} [extensions] The extensions to match files for directory patterns.
  * @property {boolean} [globInputPaths] Set to false to skip glob resolution of input file paths to lint (default: true). If false, each input file paths is assumed to be a non-glob path to an existing file.
  * @property {boolean} [ignore] The flag to check ignored files.
- * @property {IgnoredPaths} [ignoredPaths] The ignored paths.
  * @property {string[]} [rulePaths] The value of `--rulesdir` option.
  */
 
@@ -92,8 +91,7 @@ const IGNORED = 2;
  * @property {RegExp} extensionRegExp The RegExp to test if a string ends with specific file extensions.
  * @property {boolean} globInputPaths Set to false to skip glob resolution of input file paths to lint (default: true). If false, each input file paths is assumed to be a non-glob path to an existing file.
  * @property {boolean} ignoreFlag The flag to check ignored files.
- * @property {IgnoredPaths} ignoredPathsWithDotfiles The ignored paths but don't include dot files.
- * @property {IgnoredPaths} ignoredPaths The ignored paths.
+ * @property {(filePath:string, dot:boolean) => boolean} defaultIgnores The default predicate function to ignore files.
  */
 
 /** @type {WeakMap<FileEnumerator, FileEnumeratorInternalSlots>} */
@@ -149,9 +147,10 @@ function readdirSafeSync(directoryPath) {
  */
 class NoFilesFoundError extends Error {
 
+    // eslint-disable-next-line jsdoc/require-description
     /**
-     * @param {string} pattern - The glob pattern which was not found.
-     * @param {boolean} globDisabled - If `true` then the pattern was a glob pattern, but glob was disabled.
+     * @param {string} pattern The glob pattern which was not found.
+     * @param {boolean} globDisabled If `true` then the pattern was a glob pattern, but glob was disabled.
      */
     constructor(pattern, globDisabled) {
         super(`No files matching '${pattern}' were found${globDisabled ? " (glob was disabled)" : ""}.`);
@@ -165,8 +164,9 @@ class NoFilesFoundError extends Error {
  */
 class AllFilesIgnoredError extends Error {
 
+    // eslint-disable-next-line jsdoc/require-description
     /**
-     * @param {string} pattern - The glob pattern which was not found.
+     * @param {string} pattern The glob pattern which was not found.
      */
     constructor(pattern) {
         super(`All files matched by '${pattern}' are ignored.`);
@@ -190,12 +190,12 @@ class FileEnumerator {
         configArrayFactory = new CascadingConfigArrayFactory({ cwd }),
         extensions = [".js"],
         globInputPaths = true,
-        ignore = true,
-        ignoredPaths = new IgnoredPaths({ cwd, ignore })
+        ignore = true
     } = {}) {
         internalSlotsMap.set(this, {
             configArrayFactory,
             cwd,
+            defaultIgnores: IgnorePattern.createDefaultIgnore(cwd),
             extensionRegExp: new RegExp(
                 `.\\.(?:${extensions
                     .map(ext => escapeRegExp(
@@ -208,12 +208,7 @@ class FileEnumerator {
                 "u"
             ),
             globInputPaths,
-            ignoreFlag: ignore,
-            ignoredPaths,
-            ignoredPathsWithDotfiles: new IgnoredPaths({
-                ...ignoredPaths.options,
-                dotfiles: true
-            })
+            ignoreFlag: ignore
         });
     }
 
@@ -319,7 +314,7 @@ class FileEnumerator {
 
         const { configArrayFactory } = internalSlotsMap.get(this);
         const config = configArrayFactory.getConfigArrayForFile(filePath);
-        const ignored = this._isIgnoredFile(filePath, { direct: true });
+        const ignored = this._isIgnoredFile(filePath, { config, direct: true });
         const flag = ignored ? IGNORED : NONE;
 
         return [{ config, filePath, flag }];
@@ -351,7 +346,7 @@ class FileEnumerator {
     _iterateFilesWithGlob(pattern, dotfiles) {
         debug(`Glob: ${pattern}`);
 
-        const directoryPath = getGlobParent(pattern);
+        const directoryPath = path.resolve(getGlobParent(pattern));
         const globPart = pattern.slice(directoryPath.length + 1);
 
         /*
@@ -397,9 +392,18 @@ class FileEnumerator {
             // Check if the file is matched.
             if (stat && stat.isFile()) {
                 if (!config) {
-                    config = configArrayFactory.getConfigArrayForFile(filePath);
+                    config = configArrayFactory.getConfigArrayForFile(
+                        filePath,
+
+                        /*
+                         * We must ignore `ConfigurationNotFoundError` at this
+                         * point because we don't know if target files exist in
+                         * this directory.
+                         */
+                        { ignoreNotFoundError: true }
+                    );
                 }
-                const ignored = this._isIgnoredFile(filePath, options);
+                const ignored = this._isIgnoredFile(filePath, { ...options, config });
                 const flag = ignored ? IGNORED_SILENTLY : NONE;
                 const matched = options.selector
 
@@ -411,7 +415,11 @@ class FileEnumerator {
 
                 if (matched) {
                     debug(`Yield: ${filename}${ignored ? " but ignored" : ""}`);
-                    yield { config, filePath, flag };
+                    yield {
+                        config: configArrayFactory.getConfigArrayForFile(filePath),
+                        filePath,
+                        flag
+                    };
                 } else {
                     debug(`Didn't match: ${filename}`);
                 }
@@ -429,24 +437,37 @@ class FileEnumerator {
      * Check if a given file should be ignored.
      * @param {string} filePath The path to a file to check.
      * @param {Object} options Options
+     * @param {ConfigArray} [options.config] The config for this file.
      * @param {boolean} [options.dotfiles] If `true` then this is not ignore dot files by default.
      * @param {boolean} [options.direct] If `true` then this is a direct specified file.
      * @returns {boolean} `true` if the file should be ignored.
      * @private
      */
-    _isIgnoredFile(filePath, { dotfiles = false, direct = false }) {
+    _isIgnoredFile(filePath, {
+        config: providedConfig,
+        dotfiles = false,
+        direct = false
+    }) {
         const {
-            ignoreFlag,
-            ignoredPaths,
-            ignoredPathsWithDotfiles
+            configArrayFactory,
+            defaultIgnores,
+            ignoreFlag
         } = internalSlotsMap.get(this);
-        const adoptedIgnoredPaths = dotfiles
-            ? ignoredPathsWithDotfiles
-            : ignoredPaths;
 
-        return ignoreFlag
-            ? adoptedIgnoredPaths.contains(filePath)
-            : (!direct && adoptedIgnoredPaths.contains(filePath, "default"));
+        if (ignoreFlag) {
+            const config =
+                providedConfig ||
+                configArrayFactory.getConfigArrayForFile(
+                    filePath,
+                    { ignoreNotFoundError: true }
+                );
+            const ignores =
+                config.extractConfig(filePath).ignores || defaultIgnores;
+
+            return ignores(filePath, dotfiles);
+        }
+
+        return !direct && defaultIgnores(filePath, dotfiles);
     }
 }
 

package/lib/cli-engine/formatters/html.js

@@ -96,6 +96,7 @@ function renderMessages(messages, parentIndex, rulesMeta) {
     }).join("\n");
 }
 
+// eslint-disable-next-line jsdoc/require-description
 /**
  * @param {Array} results Test results.
  * @param {Object} rulesMeta Dictionary containing metadata for each rule executed by the analysis.

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
@@ -292,6 +291,7 @@ function processAnswers(answers) {
             jsx: true
         };
         config.plugins = ["react"];
+        config.extends.push("plugin:react/recommended");
     } else if (answers.framework === "vue") {
         config.plugins = ["vue"];
         config.extends.push("plugin:vue/essential");
@@ -523,9 +523,9 @@ function promptUser() {
             name: "styleguide",
             message: "Which style guide do you want to follow?",
             choices: [
-                { name: "Airbnb (https://github.com/airbnb/javascript)", value: "airbnb" },
-                { name: "Standard (https://github.com/standard/standard)", value: "standard" },
-                { name: "Google (https://github.com/google/eslint-config-google)", value: "google" }
+                { name: "Airbnb: https://github.com/airbnb/javascript", value: "airbnb" },
+                { name: "Standard: https://github.com/standard/standard", value: "standard" },
+                { name: "Google: https://github.com/google/eslint-config-google", value: "google" }
             ],
             when(answers) {
                 answers.packageJsonExists = npmUtils.checkPackageJson();

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,7 +96,6 @@ 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
  * @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
      */
@@ -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,7 +158,6 @@ function checkDevDeps(packages) {
 
 /**
  * Check whether package.json is found in current path.
- *
  * @param   {string} [startDir] Starting directory
  * @returns {boolean} Whether a package.json is found in current path.
  */

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) {