eslint 5.0.0 → 5.3.0

package/CHANGELOG.md

@@ -1,3 +1,81 @@
+v5.3.0 - August 3, 2018
+
+* dd6cb19 Docs: Updated no-return-await Rule Documentation (fixes #9695) (#10699) (Marla Foreman)
+* 6009239 Chore: rename utils for consistency (#10727) (薛定谔的猫)
+* 6eb972c New: require-unicode-regexp rule (fixes #9961) (#10698) (Toru Nagashima)
+* 5c5d64d Fix: ignored-paths for Windows path (fixes #10687) (#10691) (Toru Nagashima)
+* 5f6a765 Build: ensure URL fragments remain in documentation links (fixes #10717) (#10720) (Teddy Katz)
+* 863aa78 Docs: add another example for when not to use no-await-in-loop (#10714) (Valeri Karpov)
+* 6e78b7d Docs: remove links to terminated jscs.info domain (#10706) (Piotr Kuczynski)
+* d56c39d Fix: ESLint cache no longer stops autofix (fixes #10679) (#10694) (Kevin Partington)
+* 2cc3240 New: add no-misleading-character-class (fixes #10049) (#10511) (Toru Nagashima)
+* 877f4b8 Fix: The "../.." folder is always ignored (fixes #10675) (#10682) (Sridhar)
+* 5984820 Chore: Move lib/file-finder.js to lib/util/ (refs #10559) (#10695) (Kevin Partington)
+* e37a593 Update: Fix incorrect default value for position (#10670) (Iulian Onofrei)
+* 8084bfc Docs: change when not to use object spread (#10621) (Benny Powers)
+* 7f496e2 Chore: Update require path for ast-utils (#10693) (Kevin Partington)
+* 648a33a Chore: reorganize code structure of utilities (refs #10599) (#10680) (薛定谔的猫)
+* f026fe1 Update: Fix 'function' in padding-line-between-statements (fixes #10487) (#10676) (Kevin Partington)
+* c2bb8bb Docs: Remove superfluous object option sample code (#10652) (Iulian Onofrei)
+* d34a13b Docs: add subheader in configuring/configuring-rules (#10686) (薛定谔的猫)
+* d8aea28 Chore: rm unnecessary plugin in eslint-config-eslint (#10685) (薛定谔的猫)
+* 9e76be7 Update: indent comments w/ nearby code if no blank lines (fixes #9733) (#10640) (Kevin Partington)
+* 9e93d46 New: add no-async-promise-executor rule (fixes #10217) (#10661) (Teddy Katz)
+* 5a2538c New: require-atomic-updates rule (fixes #10405) (#10655) (Teddy Katz)
+* 8b83d2b Fix: always resolve default ignore patterns from CWD (fixes #9227) (#10638) (Teddy Katz)
+* acb6658 Fix: ESLint crash with prefer-object-spread (fixes #10646) (#10649) (薛定谔的猫)
+* 99fb7d3 Docs: fix misleading no-prototype-builtins description (#10666) (薛定谔的猫)
+* 005b849 Docs: fix outdated description of `baseConfig` option (#10657) (Teddy Katz)
+* 15a77c4 Docs: fix broken links (fixes eslint/eslint-jp#6) (#10658) (Toru Nagashima)
+* 87cd344 Docs: Make marking a default option consistent with other rules (#10650) (Iulian Onofrei)
+* 0cb5e3e Chore: Replace some function application with spread operators (#10645) (Kevin Partington)
+* b6daf0e Docs: Remove superfluous section from no-unsafe-negation (#10648) (Iulian Onofrei)
+* e1a3cac Chore: rm deprecated experimentalObjectRestSpread option in tests (#10647) (薛定谔的猫)
+
+v5.2.0 - July 20, 2018
+
+* 81283d0 Update: Cache files that failed linting (fixes #9948) (#10571) (Kevin Partington)
+* 13cc63e Upgrade: ignore@4.0.2 (#10619) (Rouven Weßling)
+* ac77a80 Chore: Fixing a call to Object.assign.apply in Linter (#10629) (Kevin Partington)
+* 761f802 Upgrade: eslint-plugin-node to 7.0.1 (#10612) (Toru Nagashima)
+* c517b2a Build: fix npm run perf failing(fixes #10577) (#10607) (薛定谔的猫)
+* e596939 Chore: fix redundant equality check (#10617) (Toru Nagashima)
+* 9f93d5f Docs: Updated Working with Custom Formatters (fixes #9950) (#10592) (Marla Foreman)
+* 9aaf195 Chore: Extract lint result cache logic (refs #9948) (#10562) (Kevin Partington)
+* 80b296e Build: package.json update for eslint-config-eslint release (ESLint Jenkins)
+* e4e7ff2 Chore: fix error message in eslint-config-eslint (#10588) (薛定谔的猫)
+* 1e88170 Chore: Move lib/logging and lib/timing to lib/util/ (refs #10559) (#10579) (Kevin Partington)
+* 64dfa21 Build: Fix prerelease logic in blog post generation (fixes #10578) (#10581) (Kevin Partington)
+* 0faf633 Chore: Simplify helper method in Linter tests (#10580) (Kevin Partington)
+
+v5.1.0 - July 8, 2018
+
+* 7328f99 Build: package.json update for eslint-config-eslint release (ESLint Jenkins)
+* b161f6b Build: Include prerelease install info in release blog post (#10463) (Kevin Partington)
+* b2df738 Fix: prefer-object-spread duplicated comma (fixes #10512, fixes #10532) (#10524) (Toru Nagashima)
+* d8c3a25 Fix: wrap-regex doesn't work in some expression(fixes #10573) (#10576) (薛定谔的猫)
+* 114f42e Docs: Clarify option defaults in max-lines-per-function docs (#10569) (Chris Harwood)
+* 63f36f7 Fix: sort-keys in an object that contains spread (fixes #10261) (#10495) (katerberg)
+* 601a5c4 Fix: Prefer-const rule crashing on array destructuring (fixes #10520) (#10527) (Michael Mason)
+* 143890a Update: Adjust grammar of error/warnings fixable (#10546) (Matt Mischuk)
+* 8ee39c5 Chore: small refactor config-validator (#10565) (薛定谔的猫)
+* 100f1be Docs: add note about release issues to readme (#10572) (Teddy Katz)
+* 02efeac Fix: do not fail on nested unknown operators (#10561) (Rubén Norte)
+* 92b19ca Chore: use eslintrc overrides(dogfooding) (#10566) (薛定谔的猫)
+* 076a6b6 Docs: add actionable fix to no-irregular-whitespace (#10558) (Matteo Collina)
+* de663ec Docs: Only successfully linted files are cached (fixes #9802) (#10557) (Kevin Partington)
+* f0e22fc Upgrade: globals@11.7.0 (#10497) (薛定谔的猫)
+* 8a2ff2c Docs:  adding a section about disable rules for some files (#10536) (Wellington Soares)
+* f22a3f8 Docs: fix a word in no-implied-eval (#10539) (Dan Homola)
+* 20d8bbd Docs: add missing paragraph about "custom parsers" (#10547) (Pig Fang)
+* b7addf6 Update: deprecate no-catch-shadow (fixes #10466) (#10526) (Toru Nagashima)
+* e862dc3 Fix: Remove autofixer for no-debugger (fixes #10242) (#10509) (Teddy Katz)
+
+v5.0.1 - June 25, 2018
+
+* 196c102 Fix: valid-jsdoc should allow optional returns for async (fixes #10386) (#10480) (Mark Banner)
+* 4c823bd Docs: Fix max-lines-per-function correct code's max value (#10513) (Rhys Bower)
+
 v5.0.0 - June 22, 2018
 
 * 0feedfd New: Added max-lines-per-function rule (fixes #9842) (#10188) (peteward44)

package/README.md

@@ -157,7 +157,7 @@ Join our [Mailing List](https://groups.google.com/group/eslint) or [Chatroom](ht
 
 ## Releases
 
-We have scheduled releases every two weeks on Friday or Saturday.
+We have scheduled releases every two weeks on Friday or Saturday. You can follow a [release issue](https://github.com/eslint/eslint/issues?q=is%3Aopen+is%3Aissue+label%3Arelease) for updates about the scheduling of any particular release.
 
 ## Semantic Versioning Policy
 

package/conf/eslint-recommended.js

@@ -83,6 +83,7 @@ module.exports = {
         "newline-per-chained-call": "off",
         "no-alert": "off",
         "no-array-constructor": "off",
+        "no-async-promise-executor": "off",
         "no-await-in-loop": "off",
         "no-bitwise": "off",
         "no-buffer-constructor": "off",
@@ -139,6 +140,7 @@ module.exports = {
         "no-lonely-if": "off",
         "no-loop-func": "off",
         "no-magic-numbers": "off",
+        "no-misleading-character-class": "off",
         "no-mixed-operators": "off",
         "no-mixed-requires": "off",
         "no-mixed-spaces-and-tabs": "error",
@@ -240,8 +242,10 @@ module.exports = {
         "quote-props": "off",
         quotes: "off",
         radix: "off",
+        "require-atomic-updates": "off",
         "require-await": "off",
         "require-jsdoc": "off",
+        "require-unicode-regexp": "off",
         "require-yield": "error",
         "rest-spread-spacing": "off",
         semi: "off",

package/lib/cli-engine.js

@@ -21,10 +21,9 @@ const fs = require("fs"),
     Linter = require("./linter"),
     IgnoredPaths = require("./ignored-paths"),
     Config = require("./config"),
-    fileEntryCache = require("file-entry-cache"),
-    globUtil = require("./util/glob-util"),
+    LintResultCache = require("./util/lint-result-cache"),
+    globUtils = require("./util/glob-utils"),
     validator = require("./config/config-validator"),
-    stringify = require("json-stable-stringify-without-jsonify"),
     hash = require("./util/hash"),
     ModuleResolver = require("./util/module-resolver"),
     naming = require("./util/naming"),
@@ -42,7 +41,7 @@ const resolver = new ModuleResolver();
  * The options to configure a CLI engine with.
  * @typedef {Object} CLIEngineOptions
  * @property {boolean} allowInlineConfig Enable or disable inline configuration comments.
- * @property {boolean|Object} baseConfig Base config object. True enables recommend rules and environments.
+ * @property {Object} baseConfig Base config object, extended by all configs used with this CLIEngine instance
  * @property {boolean} cache Enable result caching.
  * @property {string} cacheLocation The cache file to use instead of .eslintcache.
  * @property {string} configFile The configuration file to use.
@@ -359,8 +358,6 @@ function getCacheFile(cacheFile, cwd) {
     return resolvedCacheFile;
 }
 
-const configHashCache = new WeakMap();
-
 //------------------------------------------------------------------------------
 // Public Interface
 //------------------------------------------------------------------------------
@@ -403,18 +400,6 @@ class CLIEngine {
         this.options = options;
         this.linter = new Linter();
 
-        if (options.cache) {
-            const cacheFile = getCacheFile(this.options.cacheLocation || this.options.cacheFile, this.options.cwd);
-
-            /**
-             * Cache used to avoid operating on files that haven't changed since the
-             * last successful execution (e.g., file passed linting with no errors and
-             * no warnings).
-             * @type {Object}
-             */
-            this._fileCache = fileEntryCache.create(cacheFile);
-        }
-
         // load in additional rules
         if (this.options.rulePaths) {
             const cwd = this.options.cwd;
@@ -434,6 +419,17 @@ class CLIEngine {
         }
 
         this.config = new Config(this.options, this.linter);
+
+        if (this.options.cache) {
+            const cacheFile = getCacheFile(this.options.cacheLocation || this.options.cacheFile, this.options.cwd);
+
+            /**
+             * Cache used to avoid operating on files that haven't changed since the
+             * last successful execution.
+             * @type {Object}
+             */
+            this._lintResultCache = new LintResultCache(cacheFile, this.config);
+        }
     }
 
     getRules() {
@@ -496,7 +492,7 @@ class CLIEngine {
      * @returns {string[]} The equivalent glob patterns.
      */
     resolveFileGlobPatterns(patterns) {
-        return globUtil.resolveFileGlobPatterns(patterns.filter(Boolean), this.options);
+        return globUtils.resolveFileGlobPatterns(patterns.filter(Boolean), this.options);
     }
 
     /**
@@ -506,7 +502,7 @@ class CLIEngine {
      */
     executeOnFiles(patterns) {
         const options = this.options,
-            fileCache = this._fileCache,
+            lintResultCache = this._lintResultCache,
             configHelper = this.config;
         const cacheFile = getCacheFile(this.options.cacheLocation || this.options.cacheFile, this.options.cwd);
 
@@ -514,49 +510,26 @@ class CLIEngine {
             fs.unlinkSync(cacheFile);
         }
 
-        /**
-         * Calculates the hash of the config file used to validate a given file
-         * @param  {string} filename The path of the file to retrieve a config object for to calculate the hash
-         * @returns {string}         the hash of the config
-         */
-        function hashOfConfigFor(filename) {
-            const config = configHelper.getConfig(filename);
-
-            if (!configHashCache.has(config)) {
-                configHashCache.set(config, hash(`${pkg.version}_${stringify(config)}`));
-            }
-
-            return configHashCache.get(config);
-        }
-
         const startTime = Date.now();
-        const fileList = globUtil.listFilesToProcess(patterns, options);
+        const fileList = globUtils.listFilesToProcess(patterns, options);
         const results = fileList.map(fileInfo => {
             if (fileInfo.ignored) {
                 return createIgnoreResult(fileInfo.filename, options.cwd);
             }
 
             if (options.cache) {
+                const cachedLintResults = lintResultCache.getCachedLintResults(fileInfo.filename);
 
-                /*
-                 * get the descriptor for this file
-                 * with the metadata and the flag that determines if
-                 * the file has changed
-                 */
-                const descriptor = fileCache.getFileDescriptor(fileInfo.filename);
-                const hashOfConfig = hashOfConfigFor(fileInfo.filename);
-                const changed = descriptor.changed || descriptor.meta.hashOfConfig !== hashOfConfig;
-
-                if (!changed) {
-                    debug(`Skipping file since hasn't changed: ${fileInfo.filename}`);
-
-                    /*
-                     * Add the the cached results (always will be 0 error and
-                     * 0 warnings). We should not cache results for files that
-                     * failed, in order to guarantee that next execution will
-                     * process those files as well.
-                     */
-                    return descriptor.meta.results;
+                if (cachedLintResults) {
+                    const resultHadMessages = cachedLintResults.messages && cachedLintResults.messages.length;
+
+                    if (resultHadMessages && options.fix) {
+                        debug(`Reprocessing cached file to allow autofix: ${fileInfo.filename}`);
+                    } else {
+                        debug(`Skipping file since it hasn't changed: ${fileInfo.filename}`);
+
+                        return cachedLintResults;
+                    }
                 }
             }
 
@@ -567,30 +540,18 @@ class CLIEngine {
 
         if (options.cache) {
             results.forEach(result => {
-                if (result.messages.length) {
-
-                    /*
-                     * if a file contains errors or warnings we don't want to
-                     * store the file in the cache so we can guarantee that
-                     * next execution will also operate on this file
-                     */
-                    fileCache.removeEntry(result.filePath);
-                } else {
-
-                    /*
-                     * since the file passed we store the result here
-                     * TODO: it might not be necessary to store the results list in the cache,
-                     * since it should always be 0 errors/warnings
-                     */
-                    const descriptor = fileCache.getFileDescriptor(result.filePath);
-
-                    descriptor.meta.hashOfConfig = hashOfConfigFor(result.filePath);
-                    descriptor.meta.results = result;
-                }
+
+                /*
+                 * Store the lint result in the LintResultCache.
+                 * NOTE: The LintResultCache will remove the file source and any
+                 * other properties that are difficult to serialize, and will
+                 * hydrate those properties back in on future lint runs.
+                 */
+                lintResultCache.setCachedLintResults(result.filePath, result);
             });
 
             // persist the cache to disk
-            fileCache.reconcile();
+            lintResultCache.reconcile();
         }
 
         const stats = calculateStatsPerRun(results);

package/lib/cli.js

@@ -20,7 +20,7 @@ const fs = require("fs"),
     options = require("./options"),
     CLIEngine = require("./cli-engine"),
     mkdirp = require("mkdirp"),
-    log = require("./logging");
+    log = require("./util/logging");
 
 const debug = require("debug")("eslint:cli");
 

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

@@ -14,7 +14,7 @@ const assert = require("assert"),
     CodePathSegment = require("./code-path-segment"),
     IdGenerator = require("./id-generator"),
     debug = require("./debug-helpers"),
-    astUtils = require("../ast-utils");
+    astUtils = require("../util/ast-utils");
 
 //------------------------------------------------------------------------------
 // Helpers
@@ -60,7 +60,7 @@ function isForkingByTrueOrFalse(node) {
             return parent.test === node;
 
         case "LogicalExpression":
-            return true;
+            return isHandledLogicalOperator(parent.operator);
 
         default:
             return false;

package/lib/config/config-initializer.js

@@ -16,11 +16,11 @@ const util = require("util"),
     autoconfig = require("./autoconfig.js"),
     ConfigFile = require("./config-file"),
     ConfigOps = require("./config-ops"),
-    getSourceCodeOfFiles = require("../util/source-code-util").getSourceCodeOfFiles,
+    getSourceCodeOfFiles = require("../util/source-code-utils").getSourceCodeOfFiles,
     ModuleResolver = require("../util/module-resolver"),
-    npmUtil = require("../util/npm-util"),
+    npmUtils = require("../util/npm-utils"),
     recConfig = require("../../conf/eslint-recommended"),
-    log = require("../logging");
+    log = require("../util/logging");
 
 const debug = require("debug")("eslint:config-initializer");
 
@@ -61,7 +61,7 @@ function writeFile(config, format) {
 /**
  * Get the peer dependencies of the given module.
  * This adds the gotten value to cache at the first time, then reuses it.
- * In a process, this function is called twice, but `npmUtil.fetchPeerDependencies` needs to access network which is relatively slow.
+ * In a process, this function is called twice, but `npmUtils.fetchPeerDependencies` needs to access network which is relatively slow.
  * @param {string} moduleName The module name to get.
  * @returns {Object} The peer dependencies of the given module.
  * This object is the object of `peerDependencies` field of `package.json`.
@@ -73,7 +73,7 @@ function getPeerDependencies(moduleName) {
     if (!result) {
         log.info(`Checking peerDependencies of ${moduleName}`);
 
-        result = npmUtil.fetchPeerDependencies(moduleName);
+        result = npmUtils.fetchPeerDependencies(moduleName);
         getPeerDependencies.cache.set(moduleName, result);
     }
 
@@ -109,7 +109,7 @@ function getModulesList(config, installESLint) {
     if (installESLint === false) {
         delete modules.eslint;
     } else {
-        const installStatus = npmUtil.checkDevDeps(["eslint"]);
+        const installStatus = npmUtils.checkDevDeps(["eslint"]);
 
         // Mark to show messages if it's new installation of eslint.
         if (installStatus.eslint === false) {
@@ -373,7 +373,7 @@ function hasESLintVersionConflict(answers) {
  */
 function installModules(modules) {
     log.info(`Installing ${modules.join(", ")}`);
-    npmUtil.installSyncSaveDev(modules);
+    npmUtils.installSyncSaveDev(modules);
 }
 
 /* istanbul ignore next: no need to test inquirer */
@@ -438,7 +438,7 @@ function promptUser() {
                 { name: "Google (https://github.com/google/eslint-config-google)", value: "google" }
             ],
             when(answers) {
-                answers.packageJsonExists = npmUtil.checkPackageJson();
+                answers.packageJsonExists = npmUtils.checkPackageJson();
                 return answers.source === "guide" && answers.packageJsonExists;
             }
         },

package/lib/config/config-validator.js

@@ -23,10 +23,15 @@ const ruleValidators = new WeakMap();
 let validateSchema;
 
 // Defitions for deprecation warnings.
-const deprecationWarningMessages = Object.freeze({
+const deprecationWarningMessages = {
     ESLINT_LEGACY_ECMAFEATURES: "The 'ecmaFeatures' config file property is deprecated, and has no effect.",
     ESLINT_LEGACY_OBJECT_REST_SPREAD: "The 'parserOptions.ecmaFeatures.experimentalObjectRestSpread' option is deprecated. Use 'parserOptions.ecmaVersion' instead."
-});
+};
+const severityMap = {
+    error: 2,
+    warn: 1,
+    off: 0
+};
 
 /**
  * Gets a complete options schema for a rule.
@@ -65,12 +70,14 @@ function getRuleOptionsSchema(rule) {
  */
 function validateRuleSeverity(options) {
     const severity = Array.isArray(options) ? options[0] : options;
+    const normSeverity = typeof severity === "string" ? severityMap[severity.toLowerCase()] : severity;
 
-    if (severity !== 0 && severity !== 1 && severity !== 2 && !(typeof severity === "string" && /^(?:off|warn|error)$/i.test(severity))) {
-        throw new Error(`\tSeverity should be one of the following: 0 = off, 1 = warn, 2 = error (you passed '${util.inspect(severity).replace(/'/g, "\"").replace(/\n/g, "")}').\n`);
+    if (normSeverity === 0 || normSeverity === 1 || normSeverity === 2) {
+        return normSeverity;
     }
 
-    return severity;
+    throw new Error(`\tSeverity should be one of the following: 0 = off, 1 = warn, 2 = error (you passed '${util.inspect(severity).replace(/'/g, "\"").replace(/\n/g, "")}').\n`);
+
 }
 
 /**
@@ -116,7 +123,7 @@ function validateRuleOptions(rule, ruleId, options, source) {
     try {
         const severity = validateRuleSeverity(options);
 
-        if (severity !== 0 && !(typeof severity === "string" && severity.toLowerCase() === "off")) {
+        if (severity !== 0) {
             validateRuleSchema(rule, Array.isArray(options) ? options.slice(1) : []);
         }
     } catch (err) {

package/lib/config.js

@@ -15,7 +15,7 @@ const path = require("path"),
     ConfigFile = require("./config/config-file"),
     ConfigCache = require("./config/config-cache"),
     Plugins = require("./config/plugins"),
-    FileFinder = require("./file-finder"),
+    FileFinder = require("./util/file-finder"),
     isResolvable = require("is-resolvable");
 
 const debug = require("debug")("eslint:config");

package/lib/formatters/stylish.js

@@ -89,7 +89,7 @@ module.exports = function(results) {
 
         if (fixableErrorCount > 0 || fixableWarningCount > 0) {
             output += chalk[summaryColor].bold([
-                "  ", fixableErrorCount, pluralize(" error", fixableErrorCount), ", ",
+                "  ", fixableErrorCount, pluralize(" error", fixableErrorCount), " and ",
                 fixableWarningCount, pluralize(" warning", fixableWarningCount),
                 " potentially fixable with the `--fix` option.\n"
             ].join(""));