Various cleanups

.eslintrc.base.js

@@ -1,5 +1,8 @@
 "use strict";
 
+// This file is only used in `./.eslintrc.js` and in the tests – it’s not part
+// of the eslint-config-prettier npm package.
+
 const fs = require("fs");
 
 module.exports = {

.eslintrc.js

@@ -1,5 +1,11 @@
 "use strict";
 
+// This is the internal ESLint config for this project itself – it’s not part of
+// the eslint-config-prettier npm package. The idea here is to extends some
+// sharable config from npm and then include the configs exposed by this package
+// as an “eat your own dogfood” test. That feels like a good test, but
+// complicates things a little sometimes.
+
 const fs = require("fs");
 
 module.exports = {

README.md

@@ -679,6 +679,7 @@ You can also supply a custom message if you want:
 eslint-config-prettier has been tested with:
 
 - ESLint 7.14.0
+  - eslint-config-prettier 7.0.0 requires ESLint 7.0.0 or newer, while eslint-config-prettier 6.15.0 and older should also work with ESLint versions down to 3.x.
   - eslint-config-prettier 6.11.0 and older were tested with ESLint 6.x
   - eslint-config-prettier 5.1.0 and older were tested with ESLint 5.x
   - eslint-config-prettier 2.10.0 and older were tested with ESLint 4.x

bin/cli.js

@@ -104,17 +104,16 @@ function processRules(configRules) {
 
   const regularFlaggedRuleNames = filterRuleNames(
     flaggedRules,
-    (ruleName) => ruleName in regularRules
+    ({ ruleName }) => ruleName in regularRules
   );
   const optionsFlaggedRuleNames = filterRuleNames(
     flaggedRules,
-    (ruleName, options, source) =>
-      ruleName in optionsRules &&
-      !validators[ruleName](options, source, enabledRules)
+    ({ ruleName, ...rule }) =>
+      ruleName in optionsRules && !validators[ruleName](rule, enabledRules)
   );
   const specialFlaggedRuleNames = filterRuleNames(
     flaggedRules,
-    (ruleName) => ruleName in specialRules
+    ({ ruleName }) => ruleName in specialRules
   );
 
   if (
@@ -187,11 +186,7 @@ function filterRules(rules, fn) {
 
 function filterRuleNames(rules, fn) {
   return [
-    ...new Set(
-      rules
-        .filter((rule) => fn(rule.ruleName, rule.options, rule.source))
-        .map((rule) => rule.ruleName)
-    ),
+    ...new Set(rules.filter((rule) => fn(rule)).map((rule) => rule.ruleName)),
   ];
 }
 

bin/validators.js

@@ -4,9 +4,9 @@
 // `false` if the options DO conflict with Prettier, and `true` if they don’t.
 
 module.exports = {
-  "arrow-body-style": checkEslintConfigPrettier,
+  "arrow-body-style": checkEslintPluginPrettier,
 
-  curly(options) {
+  curly({ options }) {
     if (options.length === 0) {
       return true;
     }
@@ -15,7 +15,7 @@ module.exports = {
     return firstOption !== "multi-line" && firstOption !== "multi-or-nest";
   },
 
-  "lines-around-comment"(options) {
+  "lines-around-comment"({ options }) {
     if (options.length === 0) {
       return false;
     }
@@ -32,7 +32,7 @@ module.exports = {
     );
   },
 
-  "no-confusing-arrow"(options) {
+  "no-confusing-arrow"({ options }) {
     if (options.length === 0) {
       return false;
     }
@@ -41,7 +41,7 @@ module.exports = {
     return firstOption ? firstOption.allowParens === false : false;
   },
 
-  "no-tabs"(options) {
+  "no-tabs"({ options }) {
     if (options.length === 0) {
       return false;
     }
@@ -50,9 +50,9 @@ module.exports = {
     return Boolean(firstOption && firstOption.allowIndentationTabs);
   },
 
-  "prefer-arrow-callback": checkEslintConfigPrettier,
+  "prefer-arrow-callback": checkEslintPluginPrettier,
 
-  "vue/html-self-closing"(options) {
+  "vue/html-self-closing"({ options }) {
     if (options.length === 0) {
       return false;
     }
@@ -66,7 +66,7 @@ module.exports = {
   },
 };
 
-function checkEslintConfigPrettier(_options, currentSource, enabledRules) {
+function checkEslintPluginPrettier({ source: currentSource }, enabledRules) {
   return !enabledRules.some(
     ({ ruleName, source }) =>
       ruleName === "prettier/prettier" && currentSource === source

test/validators.test.js

@@ -4,11 +4,11 @@ const validators = require("../bin/validators");
 const { inspect } = require("util");
 
 expect.extend({
-  toPass(validator, opts) {
-    const pass = validator(opts);
+  toPass(validator, options) {
+    const pass = validator({ options, source: "test-source.js" }, []);
     return {
       message: () =>
-        `expected ${inspect(opts)} to be ${pass ? "invalid" : "valid"}`,
+        `expected ${inspect(options)} to be ${pass ? "invalid" : "valid"}`,
       pass,
     };
   },
@@ -17,8 +17,8 @@ expect.extend({
 function rule(name, { valid, invalid }) {
   test(name, () => {
     const validator = validators[name];
-    valid.forEach((opts) => expect(validator).toPass(opts));
-    invalid.forEach((opts) => expect(validator).not.toPass(opts));
+    valid.forEach((options) => expect(validator).toPass(options));
+    invalid.forEach((options) => expect(validator).not.toPass(options));
   });
 }