feat: add an off preset

Author: RebeccaStevens

README.md

@@ -152,6 +152,7 @@ Presets:
 
 - **Recommended** (plugin:functional/recommended)
 - **Lite** (plugin:functional/lite)
+- **Off** (plugin:functional/off)
 
 Categorized:
 

src/configs/off.ts

@@ -0,0 +1,21 @@
+import type { Linter } from "eslint";
+
+import all from "./all";
+
+function turnRulesOff(rules: Linter.Config["rules"]): Linter.Config["rules"] {
+  return rules === undefined
+    ? undefined
+    : Object.fromEntries(
+        Object.entries(rules).map(([name, value]) => [name, "off"])
+      );
+}
+
+const config: Linter.Config = {
+  rules: turnRulesOff(all.rules),
+  overrides: all.overrides?.map((override) => ({
+    ...override,
+    rules: turnRulesOff(override.rules),
+  })),
+};
+
+export default config;

src/index.ts

@@ -9,6 +9,7 @@ import noExceptions from "~/configs/no-exceptions";
 import noMutations from "~/configs/no-mutations";
 import noObjectOrientation from "~/configs/no-object-orientation";
 import noStatements from "~/configs/no-statements";
+import off from "~/configs/off";
 import stylistic from "~/configs/stylistic";
 import { rules } from "~/rules";
 
@@ -24,6 +25,7 @@ const config: EslintPluginConfig = {
     recommended: functional,
     "external-recommended": externalRecommended,
     lite: functionalLite,
+    off,
     "no-mutations": noMutations,
     "no-exceptions": noExceptions,
     "no-object-orientation": noObjectOrientation,

tests/configs.test.ts

@@ -11,22 +11,40 @@ import noExceptions from "~/configs/no-exceptions";
 import noMutations from "~/configs/no-mutations";
 import noObjectOrientation from "~/configs/no-object-orientation";
 import noStatements from "~/configs/no-statements";
+import off from "~/configs/off";
 import stylistic from "~/configs/stylistic";
 import { rules } from "~/rules";
 
-test('Config "All" - should have all the non-deprecated rules', (t) => {
-  const allRules = Object.values(rules);
-  const allNonDeprecatedRules = allRules.filter(
-    (rule) => rule.meta.deprecated !== true
-  );
+const allRules = Object.values(rules);
+const allNonDeprecatedRules = allRules.filter(
+  (rule) => rule.meta.deprecated !== true
+);
 
+test('Config "All" - should have all the non-deprecated rules', (t) => {
   const configAllJSRules = Object.keys(all.rules ?? {});
   const configAllTSRules = Object.keys(all.overrides?.[0].rules ?? {});
   const configAllRules = new Set([...configAllJSRules, ...configAllTSRules]);
 
   t.is(configAllRules.size, allNonDeprecatedRules.length);
 });
 
+test('Config "Off" - should have all the rules "All" has but turned off', (t) => {
+  const configOffJSRules = Object.keys(off.rules ?? {});
+  const configOffTSRules = Object.keys(off.overrides?.[0].rules ?? {});
+  const configOffRules = new Set([...configOffJSRules, ...configOffTSRules]);
+
+  t.is(configOffRules.size, allNonDeprecatedRules.length);
+
+  for (const [name, value] of Object.entries(off.rules)) {
+    const severity = Array.isArray(value) ? value[0] : value;
+    t.is(
+      severity,
+      "off",
+      `Rule "${name}"" should be turned off in the off config.`
+    );
+  }
+});
+
 /**
  * A map of each config (except the "all" config) to it's name.
  */