fix(eslint-config): disabling all rules that are crashing with the prettier config, updated the readme with the info

Signed-off-by: prisis <d.bannert@anolilab.de>

Author: prisis

packages/eslint-config/README.md

@@ -34,7 +34,7 @@ The goal is to reduce noise in code version control and promote use of the lates
 -   Includes many useful ESLint plugins, like [unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn), [import](https://github.com/benmosher/eslint-plugin-import) and [more](#plugins).
 -   Automatically enables rules based on the [engines](https://docs.npmjs.com/files/package.json#engines) field in your package.json.
 -   Specify indent and semicolon preferences easily without messing with the rule config.
--   Disables rules that conflict with Prettier.
+-   Disables rules that conflict with [Prettier](#let-prettier-handle-style-related-rules).
 
 ## Install
 
@@ -215,13 +215,13 @@ Default: `undefined`
 
 Prettier is a code formatting tool that offers fewer options but is more professional than the style-related rules in ESLint.
 
-Now that Prettier has become a necessary tool in front end projects, `@anolilab/eslint-config` does not need to maintain the style-related rules in ESLint anymore, so we completely removed all Prettier related rules in the v3 version, and use ESLint to check logical errors which it’s good at.
+Now that Prettier has become a necessary tool in front end projects, `@anolilab/eslint-config` does not need to maintain the style-related rules in ESLint anymore,
+so we completely removed all Prettier related rules, if `prettier` is found in your `package.json` and use ESLint to check logical errors which it’s good at.
 
-As for whether two spaces or four spaces are used for indentation and whether there is a semicolon at the end, you can configure it in the project’s .prettierrc.cjs. Of course, we also provide a recommended Prettier configuration for your reference.
+As for whether two spaces or four spaces are used for indentation and whether there is a semicolon at the end, you can configure it in the project’s `.prettierrc.js`.
+Of course, we also provide a recommended Prettier [configuration](../prettier-config/README.md) for your reference.
 
-`@anolilab/eslint-config` does not include all style-related rules, so there is no need to install `eslint-config-prettier`. Install `prettier` and if you use `VSCode` the related plugins.
-
-This the used [.prettierrc.cjs](../prettier-config/index.cjs) configuration by Anolilab Team only for reference.
+`@anolilab/eslint-config` does disable all included style-related rules, so there is no need to install [`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier).
 
 ## Using experimental features with JavaScript
 

packages/eslint-config/src/config.ts

@@ -142,7 +142,7 @@ const pluginConfig: PackageRules = [
 const loadedPlugins: string[] = [...internalPluginConfig];
 const possiblePlugins: { [rule: string]: { [packageName: string]: boolean } } = {};
 
-let anolilabEslintConfig: { [key: string]: { [key: string]: false | undefined} } = {};
+let anolilabEslintConfig: { [key: string]: { [key: string]: false | undefined } } = {};
 
 if (pkg) {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment,@typescript-eslint/no-unsafe-member-access

packages/eslint-config/src/config/plugins/babel.ts

@@ -1,6 +1,8 @@
+import { hasAnyDep } from "@anolilab/package-json-utils";
 import type { Linter } from "eslint";
 
 import createConfig from "../../utils/create-config";
+import { consoleLog } from "../../utils/loggers";
 import bestPracticesConfig from "../best-practices";
 import errorsConfig from "../errors";
 import styleConfig from "../style";
@@ -9,6 +11,28 @@ const bestPracticesRules = bestPracticesConfig.rules as Linter.RulesRecord;
 const errorsRules = errorsConfig.rules as Linter.RulesRecord;
 const styleRules = styleConfig.rules as Linter.RulesRecord;
 
+let prettierRules: Linter.RulesRecord = {};
+
+if (
+    hasAnyDep(["prettier"], {
+        peerDeps: false,
+    })
+) {
+    // Workaround VS Code trying to run this file twice!
+    if (!global.hasAnolilabEsLintConfigBabelPrettier) {
+        global.hasAnolilabEsLintConfigBabelPrettier = true;
+
+        consoleLog("\nFound prettier as dependency, disabling some rules to fix wrong behavior of the rule with eslint and prettier");
+    }
+
+    prettierRules = {
+        "babel/quotes": 0,
+
+        "@babel/object-curly-spacing": "off",
+        "@babel/semi": "off",
+    };
+}
+
 const config: Linter.Config = createConfig("all", {
     plugins: ["babel"],
     rules: {
@@ -39,6 +63,8 @@ const config: Linter.Config = createConfig("all", {
 
         "valid-typeof": "off",
         "babel/valid-typeof": errorsRules["valid-typeof"],
+
+        ...prettierRules,
     },
 });
 

packages/eslint-config/src/config/plugins/jsdoc.ts

@@ -12,7 +12,11 @@ const overrides: Linter.Config["overrides"] = [
 ];
 
 if (hasTypescript) {
-    if (hasAnyDep(["eslint-plugin-tsdoc"])) {
+    if (
+        hasAnyDep(["eslint-plugin-tsdoc"], {
+            peerDeps: false,
+        })
+    ) {
         consoleLog("\nFound eslint-plugin-tsdoc as dependency, disabling the jsdoc rules for *.ts and *.tsx files.");
     } else {
         overrides.push({

packages/eslint-config/src/config/plugins/jsonc.ts

@@ -5,7 +5,11 @@ import { consoleLog } from "../../utils/loggers";
 
 const extendedPlugins: string[] = [];
 
-if (hasAnyDep(["prettier"])) {
+if (
+    hasAnyDep(["prettier"], {
+        peerDeps: false,
+    })
+) {
     // Workaround VS Code trying to run this file twice!
     if (!global.hasAnolilabEsLintConfigJsonCPrettier) {
         global.hasAnolilabEsLintConfigJsonCPrettier = true;

packages/eslint-config/src/config/plugins/node.ts

@@ -90,10 +90,7 @@ const config: Linter.Config = {
             files: ["*.js", "*.mjs", "*.cjs"],
             rules: {
                 // We have this enabled in addition to `import/extensions` as this one has an auto-fix.
-                "n/file-extension-in-import": [
-                    "error",
-                    "always",
-                ],
+                "n/file-extension-in-import": ["error", "always"],
             },
         },
     ],

packages/eslint-config/src/config/plugins/react.ts

@@ -12,24 +12,33 @@ const dangleRules = styleRules["no-underscore-dangle"] as any[];
 let prettierReactRules = {};
 
 if (
-    hasAnyDep(["react", "react-dom"], {
+    hasAnyDep(["prettier"], {
         peerDeps: false,
     })
 ) {
+    // Workaround VS Code trying to run this file twice!
+    if (!global.hasAnolilabEsLintConfigReactPrettier) {
+        global.hasAnolilabEsLintConfigReactPrettier = true;
+
+        consoleLog("\nFound prettier as dependency, disabling some rules to fix wrong behavior of the rule with eslint and prettier");
+    }
+
     prettierReactRules = {
-        "react/jsx-indent": "off",
-        "react/jsx-closing-tag-location": "off",
+        "react/jsx-child-element-spacing": "off",
         "react/jsx-closing-bracket-location": "off",
+        "react/jsx-closing-tag-location": "off",
+        "react/jsx-curly-newline": "off",
         "react/jsx-curly-spacing": "off",
         "react/jsx-equals-spacing": "off",
         "react/jsx-first-prop-new-line": "off",
+        "react/jsx-indent": "off",
         "react/jsx-indent-props": "off",
         "react/jsx-max-props-per-line": "off",
-        "react/jsx-tag-spacing": "off",
-        "react/jsx-wrap-multilines": "off",
-        "react/prefer-stateless-function": "off",
+        "react/jsx-newline": "off",
         "react/jsx-one-expression-per-line": "off",
         "react/jsx-props-no-multi-spaces": "off",
+        "react/jsx-tag-spacing": "off",
+        "react/jsx-wrap-multilines": "off",
     };
 }
 

packages/eslint-config/src/config/plugins/typescript.ts

@@ -20,19 +20,43 @@ const importsRules = importsConfig.rules as Linter.RulesRecord;
 const variablesRules = variablesConfig.rules as Linter.RulesRecord;
 
 const { quotes, semi } = styleRules;
-let { indent } = styleRules;
+const { indent } = styleRules;
 
-if (hasAnyDep(["prettier"])) {
+let prettierRules: Linter.RulesRecord = {};
+
+if (
+    hasAnyDep(["prettier"], {
+        peerDeps: false,
+    })
+) {
     // Workaround VS Code trying to run this file twice!
     if (!global.hasAnolilabEsLintConfigTypescriptPrettier) {
         global.hasAnolilabEsLintConfigTypescriptPrettier = true;
 
-        consoleLog(
-            "\nFound prettier as dependency, disabling the '@typescript-eslint/indent' rule to fix wrong behavior of the rule; @see https://github.com/typescript-eslint/typescript-eslint/issues/1824",
-        );
+        consoleLog("\nFound prettier as dependency, disabling some rules to fix wrong behavior of the rule with eslint and prettier");
     }
 
-    indent = "off";
+    prettierRules = {
+        "@typescript-eslint/lines-around-comment": 0,
+        "@typescript-eslint/quotes": 0,
+        "@typescript-eslint/block-spacing": "off",
+        "@typescript-eslint/brace-style": "off",
+        "@typescript-eslint/comma-dangle": "off",
+        "@typescript-eslint/comma-spacing": "off",
+        "@typescript-eslint/func-call-spacing": "off",
+        "@typescript-eslint/indent": "off",
+        "@typescript-eslint/key-spacing": "off",
+        "@typescript-eslint/keyword-spacing": "off",
+        "@typescript-eslint/member-delimiter-style": "off",
+        "@typescript-eslint/no-extra-parens": "off",
+        "@typescript-eslint/no-extra-semi": "off",
+        "@typescript-eslint/object-curly-spacing": "off",
+        "@typescript-eslint/semi": "off",
+        "@typescript-eslint/space-before-blocks": "off",
+        "@typescript-eslint/space-before-function-paren": "off",
+        "@typescript-eslint/space-infix-ops": "off",
+        "@typescript-eslint/type-annotation-spacing": "off",
+    };
 }
 
 const importExtensions = importsRules["import/extensions"] as any[];
@@ -490,6 +514,9 @@ const config: Linter.Config = {
 
                 // https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/eslint-plugin/docs/rules/no-import-type-side-effects.md
                 "@typescript-eslint/no-import-type-side-effects": "error",
+
+                // Disable rules that are handled by prettier
+                ...prettierRules,
             },
         },
         {

packages/eslint-config/src/config/plugins/unicorn.ts

@@ -2,14 +2,31 @@ import { hasAnyDep, packageIsTypeModule } from "@anolilab/package-json-utils";
 import type { Linter } from "eslint";
 import semver from "semver";
 
+import { consoleLog } from "../../utils/loggers";
 import styleConfig from "../style";
 
 const styleRules = styleConfig.rules as Linter.RulesRecord;
 
-let identLevel: Linter.RuleLevel = "error";
+let prettierRules: Linter.RulesRecord = {};
 
-if (hasAnyDep(["prettier"])) {
-    identLevel = "off";
+if (
+    hasAnyDep(["prettier"], {
+        peerDeps: false,
+    })
+) {
+    // Workaround VS Code trying to run this file twice!
+    if (!global.hasAnolilabEsLintConfigUnicornPrettier) {
+        global.hasAnolilabEsLintConfigUnicornPrettier = true;
+
+        consoleLog("\nFound prettier as dependency, disabling some rules to fix wrong behavior of the rule with eslint and prettier");
+    }
+
+    prettierRules = {
+        "unicorn/empty-brace-spaces": "off",
+        "unicorn/no-nested-ternary": "off",
+        "unicorn/number-literal-case": "off",
+        "unicorn/template-indent": "off",
+    };
 }
 
 // @see https://github.com/sindresorhus/eslint-plugin-unicorn
@@ -18,7 +35,7 @@ const config: Linter.Config = {
     extends: ["plugin:unicorn/recommended"],
     rules: {
         "unicorn/prefer-node-protocol": semver.gte(process.version, "v16.0.0") ? "error" : "off",
-        "unicorn/template-indent": [identLevel, { indent: (styleRules["indent"] as any[])[1] as number }],
+        "unicorn/template-indent": ["error", { indent: (styleRules["indent"] as any[])[1] as number }],
         "unicorn/no-array-for-each": "off",
         "unicorn/prefer-module": packageIsTypeModule ? "error" : "off",
 
@@ -50,6 +67,8 @@ const config: Linter.Config = {
 
         // TODO: Temporarily disabled as the rule is buggy.
         "function-call-argument-newline": "off",
+
+        ...prettierRules,
     },
     overrides: [
         {

packages/eslint-config/src/global.d.ts

@@ -8,4 +8,12 @@ declare global {
     var hasAnolilabEsLintConfigReactRuntimePath: boolean;
 
     var hasAnolilabEsLintTestConfigLoaded: boolean;
+
+    var hasAnolilabEsLintConfigUnicornPrettier: boolean;
+
+    var hasAnolilabEsLintConfigReactPrettier: boolean;
+
+    var hasAnolilabEsLintConfigBabelPrettier: boolean;
+
+    var hasAnolilabEsLintConfigPrettier: boolean;
 }

packages/eslint-config/src/index.ts

@@ -6,7 +6,7 @@
  */
 import "@rushstack/eslint-patch/modern-module-resolution";
 
-import { packageIsTypeModule, pkg } from "@anolilab/package-json-utils";
+import { hasAnyDep, packageIsTypeModule, pkg } from "@anolilab/package-json-utils";
 import type { Linter } from "eslint";
 import { join } from "node:path";
 import semver from "semver";
@@ -67,8 +67,7 @@ if (!global.hasAnolilabEsLintConfigLoaded) {
     global.hasAnolilabEsLintConfigLoaded = true;
 }
 
-const configRules: Linter.RulesRecord = {};
-
+let configRules: Linter.RulesRecord = {};
 let nodeVersion: string | undefined;
 
 if (pkg?.engines?.["node"]) {
@@ -85,6 +84,95 @@ Object.entries(engineRules).forEach(([rule, ruleConfig]) => {
         });
 });
 
+if (
+    hasAnyDep(["prettier"], {
+        peerDeps: false,
+    })
+) {
+    // Workaround VS Code trying to run this file twice!
+    if (!global.hasAnolilabEsLintConfigPrettier) {
+        global.hasAnolilabEsLintConfigPrettier = true;
+
+        consoleLog("\nFound prettier as dependency, disabling some rules to fix wrong behavior of the rule with eslint and prettier");
+    }
+
+    configRules = {
+        ...configRules,
+
+        // The following rules can be used in some cases. See the README for more
+        // information. (These are marked with `0` instead of `"off"` so that a
+        // script can distinguish them.)
+        curly: 0,
+        "lines-around-comment": 0,
+        "max-len": 0,
+        "no-confusing-arrow": 0,
+        "no-mixed-operators": 0,
+        "no-tabs": 0,
+        "no-unexpected-multiline": 0,
+        quotes: 0,
+
+        // The rest are rules that you never need to enable when using Prettier.
+        "array-bracket-newline": "off",
+        "array-bracket-spacing": "off",
+        "array-element-newline": "off",
+        "arrow-parens": "off",
+        "arrow-spacing": "off",
+        "block-spacing": "off",
+        "brace-style": "off",
+        "comma-dangle": "off",
+        "comma-spacing": "off",
+        "comma-style": "off",
+        "computed-property-spacing": "off",
+        "dot-location": "off",
+        "eol-last": "off",
+        "func-call-spacing": "off",
+        "function-call-argument-newline": "off",
+        "function-paren-newline": "off",
+        "generator-star-spacing": "off",
+        "implicit-arrow-linebreak": "off",
+        indent: "off",
+        "jsx-quotes": "off",
+        "key-spacing": "off",
+        "keyword-spacing": "off",
+        "linebreak-style": "off",
+        "multiline-ternary": "off",
+        "newline-per-chained-call": "off",
+        "new-parens": "off",
+        "no-extra-parens": "off",
+        "no-extra-semi": "off",
+        "no-floating-decimal": "off",
+        "no-mixed-spaces-and-tabs": "off",
+        "no-multi-spaces": "off",
+        "no-multiple-empty-lines": "off",
+        "no-trailing-spaces": "off",
+        "no-whitespace-before-property": "off",
+        "nonblock-statement-body-position": "off",
+        "object-curly-newline": "off",
+        "object-curly-spacing": "off",
+        "object-property-newline": "off",
+        "one-var-declaration-per-line": "off",
+        "operator-linebreak": "off",
+        "padded-blocks": "off",
+        "quote-props": "off",
+        "rest-spread-spacing": "off",
+        semi: "off",
+        "semi-spacing": "off",
+        "semi-style": "off",
+        "space-before-blocks": "off",
+        "space-before-function-paren": "off",
+        "space-in-parens": "off",
+        "space-infix-ops": "off",
+        "space-unary-ops": "off",
+        "switch-colon-spacing": "off",
+        "template-curly-spacing": "off",
+        "template-tag-spacing": "off",
+        "unicode-bom": "off",
+        "wrap-iife": "off",
+        "wrap-regex": "off",
+        "yield-star-spacing": "off",
+    };
+}
+
 const config: Linter.Config = {
     // After an .eslintrc.js file is loaded, ESLint will normally continue visiting all parent folders
     // to look for other .eslintrc.js files, and also consult a personal file ~/.eslintrc.js.  If any files
@@ -98,9 +186,7 @@ const config: Linter.Config = {
     parser: "",
 
     extends: [
-        ...rules
-
-            .map((plugin) => join(__dirname, `./config/${plugin}.${packageIsTypeModule ? "m" : ""}js`)),
+        ...rules.map((plugin) => join(__dirname, `./config/${plugin}.${packageIsTypeModule ? "m" : ""}js`)),
 
         ...pluginRules.map((plugin) => join(__dirname, `./config/plugins/${plugin}.${packageIsTypeModule ? "m" : ""}js`)),
     ],