@lidofinance/eslint-config 0.0.1 → 0.11.0

package/.eslintrc.js

@@ -0,0 +1,14 @@
+const buildConfig = require("./lib/build-config");
+const rulesets = require("./rulesets/hard");
+
+const { plugins, rules, ...base } = buildConfig({}, rulesets);
+
+module.exports = {
+  root: true,
+  ...base,
+  plugins: [...plugins, "prettier"],
+  rules: {
+    ...rules,
+    "prettier/prettier": "error",
+  },
+};

package/README.md

@@ -1,10 +1,64 @@
-This is pre-release stage software for evaluation purposes; full release will come soon.
+# Lido ESint config
+Automated, non-opinionated ESLint config foundation
+> 
+>❗ _Please note that this ESLint config is still 0.x and is subject to significant changes; it is mainly used by internal Lido teams._
 
-Please, do not use it unless you specifically know what you are doing.
 
----
+### Installation
+```bash
+npm install --dev @lidofinance/eslint-config
+# and plugins
+npm install --dev eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-import-resolver-typescript eslint-plugin-eslint-comments eslint-plugin-import eslint-plugin-jest eslint-plugin-promise eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-sonarjs eslint-plugin-unicorn @next/eslint-plugin-next
+```
 
-Behavior changes are dependent upon:
+If using TypeScript, alter `tsconfig.json` line `includes` to include everything, like that:
+`"include": ["**/*","**/.*"]`
 
--   presence of React, Jest, Next.js, Typescript in dependencies/devDependencies
--   Typescript `strict` flag in tsconfig
+> ℹ️ Modern module resolution [ESLint patch](https://www.npmjs.com/package/@rushstack/eslint-patch) by Rush team is intentionally not used, as it conflicts with same patch in `@next/eslint-plugin`.
+
+### Configuration
+Style rules are intentionally not provided; bring your own code style, whatever it is - prettier, airbnb, xo or standard.
+
+```json5
+// .eslintrc.js.js
+{
+  "root": true,
+  
+  "extends": [
+    // note: use every other config BEFORE @lidofinance config, 
+    // EXCEPT prettier; prettier is bundled with multiple 
+    // disable rules that should be turned off to avoid conflicts
+    
+    //"airbnb",
+    "@lidofinance",
+    //"prettier"
+  ]
+}
+```
+
+### What's inside
+
+`@lidofinance/eslint-config` is feature-packed config that ships with some logic.
+
+Following assumptions are done:
+- ES version target is latest (2022); if you need other, change `env` in `.eslintrc`
+- code is always server-ready
+- code is client-ready if `react` package is present
+- there is no magic resolution mechanism and usage of webpack loaders; only explicit file paths and `tsconfig.json` `paths` are considered
+- latest version of TypeScript (4.6.x) and ESLint (^8.13) are used
+
+For performance, developer experience and accuracy reasons some rules will turn on if following conditions will happen:
+
+- `React` package is declared in `package.json`
+  - `react`, `react-hooks` rules will be used
+- `Next` package is declared in `package.json` 
+  - `next` plugin rules will be used
+  - react rule `react/react-in-jsx-scope` will turn off
+- `Jest` package is declared in `package.json`
+  - `jest` plugin rules will be used
+  - some rules will be disabled (like "avoid code duplication" and "do not use any") for test-specific file patterns
+- `Typescript` package is declared in `package.json`:
+  - `typescript-eslint` rules will be enabled 
+  - parser will be switched to typescript-eslint
+  - if `tsconfig.json` is present, type-level lint rules will be enabled
+  - if `compilerOptions.strict` is `true`, additional anti-any rules will be enabled

package/all-hard.js

@@ -1,12 +1,12 @@
-const buildConfig = require('./lib/build-config')
-const rulesets = require('./rulesets/hard')
+const buildConfig = require("./lib/build-config");
+const rulesets = require("./rulesets/hard");
 
 module.exports = buildConfig(
-    {
-        typescript: true,
-        react: true,
-        next: true,
-        jest: true,
-    },
-    rulesets
-)
+  {
+    typescript: true,
+    react: true,
+    next: true,
+    jest: true,
+  },
+  rulesets
+);

package/all.js

@@ -1,12 +1,12 @@
-const buildConfig = require('./lib/build-config')
-const rulesets = require('./rulesets/easy')
+const buildConfig = require("./lib/build-config");
+const rulesets = require("./rulesets/easy");
 
 module.exports = buildConfig(
-    {
-        typescript: true,
-        react: true,
-        next: true,
-        jest: true,
-    },
-    rulesets
-)
+  {
+    typescript: true,
+    react: true,
+    next: true,
+    jest: true,
+  },
+  rulesets
+);

package/auto-hard.js

@@ -1,5 +1,5 @@
-const buildConfig = require('./lib/build-config')
-const rulesets = require('./rulesets/hard')
-const env = require('./lib/env')
+const buildConfig = require("./lib/build-config");
+const rulesets = require("./rulesets/hard");
+const env = require("./lib/env");
 
-module.exports = buildConfig(env, rulesets)
+module.exports = buildConfig(env, rulesets);

package/auto.js

@@ -1,5 +1,5 @@
-const buildConfig = require('./lib/build-config')
-const rulesets = require('./rulesets/easy')
-const env = require('./lib/env')
+const buildConfig = require("./lib/build-config");
+const rulesets = require("./rulesets/easy");
+const env = require("./lib/env");
 
-module.exports = buildConfig(env, rulesets)
+module.exports = buildConfig(env, rulesets);

package/lib/build-config.js

@@ -1,212 +1,229 @@
-const ts = require('typescript')
+const ts = require("typescript");
 
 const generalLoosenRules = {
-    'unicorn/consistent-function-scoping': 'off',
-    'unicorn/error-message': 'off',
-    'sonarjs/no-identical-conditions': 'off',
-    'sonarjs/no-identical-expressions': 'off',
-    'sonarjs/no-identical-functions': 'off',
-}
+  "unicorn/consistent-function-scoping": "off",
+  "unicorn/error-message": "off",
+  "sonarjs/no-identical-conditions": "off",
+  "sonarjs/no-identical-expressions": "off",
+  "sonarjs/no-identical-functions": "off",
+};
+
 const loosenTsRules = {
-    '@typescript-eslint/no-unsafe-argument': 'off',
-    '@typescript-eslint/no-unsafe-assignment': 'off',
-    '@typescript-eslint/no-unsafe-call': 'off',
-    '@typescript-eslint/no-unsafe-member-access': 'off',
-    '@typescript-eslint/no-unsafe-return': 'off',
-    '@typescript-eslint/require-await': 'off',
-    '@typescript-eslint/await-thenable': 'off',
-    '@typescript-eslint/no-explicit-any': 'off',
-}
+  "@typescript-eslint/no-unsafe-argument": "off",
+  "@typescript-eslint/no-unsafe-assignment": "off",
+  "@typescript-eslint/no-unsafe-call": "off",
+  "@typescript-eslint/no-unsafe-member-access": "off",
+  "@typescript-eslint/no-unsafe-return": "off",
+  "@typescript-eslint/require-await": "off",
+  "@typescript-eslint/await-thenable": "off",
+  "@typescript-eslint/no-explicit-any": "off",
+  "@typescript-eslint/restrict-plus-operands": "off",
+  "@typescript-eslint/restrict-template-expressions": "off",
+};
+
 const loosenReactRules = {
-    // loosen some rules
-    'react/prop-types': 'off',
-    'react/react-in-jsx-scope': 'off',
-}
+  // loosen some rules
+  "react/prop-types": "off",
+  "react/react-in-jsx-scope": "off",
+};
 
-module.exports = function buildConfig(env, { nextRules, tsRules, reactRules, defaultRules }) {
-    const config = {
-        extends: ['eslint:recommended'],
-        env: {
-            es2022: true,
-            browser: env.react,
-            node: true,
-        },
-        // future: add @brettz9, css-modules, eslint-comments plugins
-        plugins: ['sonarjs', 'unicorn', 'import', 'promise'],
-        settings: {
-            'import/resolver': {
-                [require.resolve('eslint-import-resolver-node')]: {
-                    extensions: ['.js', '.jsx'],
-                },
-            },
+module.exports = function buildConfig(
+  env,
+  { nextRules, tsRules, reactRules, defaultRules }
+) {
+  const config = {
+    extends: ["eslint:recommended"],
+    env: {
+      es2022: true,
+      browser: env.react,
+      node: true,
+    },
+    // future: add @brettz9, css-modules, eslint-comments plugins
+    plugins: ["sonarjs", "unicorn", "import", "promise"],
+    settings: {
+      "import/resolver": {
+        [require.resolve("eslint-import-resolver-node")]: {
+          extensions: [".js", ".jsx"],
         },
-        rules: defaultRules,
-        overrides: [],
-    }
+      },
+    },
+    rules: defaultRules,
+    overrides: [],
+  };
 
-    const loosenRules = {
-        ...generalLoosenRules,
-        ...(env.react ? loosenReactRules : {}),
-        ...(env.typescript ? loosenTsRules : {}),
-    }
+  const loosenRules = {
+    ...generalLoosenRules,
+    ...(env.react ? loosenReactRules : {}),
+    ...(env.typescript ? loosenTsRules : {}),
+  };
 
-    if (env.react) {
-        Object.assign(config, {
-            plugins: [...config.plugins, 'react', 'react-hooks'],
-            rules: {
-                ...config.rules,
-                ...reactRules,
-            },
-            settings: {
-                ...config.settings,
-                react: {
-                    version: 'detect',
-                },
-            },
-            overrides: [
-                ...config.overrides,
-                {
-                    files: ['*.stories.*', '*.test.*'],
-                    rules: loosenRules,
-                },
-            ],
-        })
-    }
-
-    if (env.next) {
-        Object.assign(config, {
-            plugins: [...config.plugins, '@next/next'],
-            rules: {
-                ...config.rules,
-                ...nextRules,
-            },
-        })
-    }
+  if (env.react) {
+    Object.assign(config, {
+      plugins: [...config.plugins, "react", "react-hooks"],
+      rules: {
+        ...config.rules,
+        ...reactRules,
+      },
+      settings: {
+        ...config.settings,
+        react: {
+          version: "detect",
+        },
+      },
+      overrides: [
+        ...config.overrides,
+        {
+          files: ["*.stories.*", "*.test.*"],
+          rules: loosenRules,
+        },
+      ],
+    });
+  }
 
-    // order is important here
-    if (env.jest) {
-        Object.assign(config, {
-            plugins: [...config.plugins, 'jest'],
-            overrides: [
-                ...config.overrides,
-                {
-                    extends: ['plugin:jest/recommended'],
-                    files: ['__test__/**', 'test/**', '*.spec.*'],
-                    env: {
-                        'jest/globals': true,
-                    },
-                    rules: {
-                        ...loosenRules,
-                        // sometimes there are problems with version detection causing this rule to crash ESLint
-                        'jest/no-deprecated-functions': 'off',
-                    },
-                },
-            ],
-        })
-    }
+  if (env.next) {
+    Object.assign(config, {
+      plugins: [...config.plugins, "@next/next"],
+      rules: {
+        ...config.rules,
+        ...nextRules,
+      },
+    });
+  }
 
-    if (env.typescript) {
-        let tsconfigPath
+  // order is important here
+  if (env.jest) {
+    Object.assign(config, {
+      plugins: [...config.plugins, "jest"],
+      overrides: [
+        ...config.overrides,
+        {
+          extends: ["plugin:jest/recommended"],
+          files: ["__test__/**", "test/**", "*.spec.*", "*.test.js"],
+          env: {
+            "jest/globals": true,
+          },
+          rules: {
+            ...loosenRules,
+            // sometimes there are problems with version detection causing this rule to crash ESLint
+            "jest/no-deprecated-functions": "off",
+          },
+        },
+      ],
+    });
+  }
 
-        try {
-            // eslint-disable-next-line @typescript-eslint/unbound-method
-            tsconfigPath = ts.findConfigFile(process.cwd(), ts.sys.fileExists, 'tsconfig.json')
-            // eslint-disable-next-line @typescript-eslint/unbound-method
-            const { config } = ts.readConfigFile(tsconfigPath, ts.sys.readFile)
-            if (config) {
-                // this are type-aware checks that require tsconfig presence
-                Object.assign(tsRules, {
-                    '@typescript-eslint/await-thenable': 'warn',
-                    '@typescript-eslint/no-floating-promises': 'error',
-                    'no-implied-eval': 'off',
-                    '@typescript-eslint/no-implied-eval': 'error',
-                    '@typescript-eslint/no-misused-promises': 'warn',
-                    '@typescript-eslint/no-unnecessary-type-assertion': 'warn',
-                    'require-await': 'off',
-                    '@typescript-eslint/require-await': 'error',
-                    '@typescript-eslint/unbound-method': ['error', { ignoreStatic: true }],
-                })
-            }
-            if (config?.compilerOptions?.strict) {
-                Object.assign(tsRules, {
-                    '@typescript-eslint/restrict-plus-operands': 'warn',
-                    '@typescript-eslint/no-explicit-any': 'error',
-                    '@typescript-eslint/no-unsafe-argument': 'error',
-                    '@typescript-eslint/no-unsafe-assignment': 'error',
-                    '@typescript-eslint/no-unsafe-call': 'error',
-                    '@typescript-eslint/no-unsafe-member-access': 'error',
-                    '@typescript-eslint/no-unsafe-return': 'error',
-                    '@typescript-eslint/restrict-template-expressions': 'error',
-                })
-            }
-        } catch {
-            void 0
-        }
+  if (env.typescript) {
+    let tsconfigPath;
 
-        Object.assign(config, {
-            plugins: [...config.plugins, '@typescript-eslint'],
-            parser: '@typescript-eslint/parser',
-            parserOptions: {
-                sourceType: 'module',
-                project: tsconfigPath,
-                ecmaFeatures: {
-                    jsx: env.react,
-                },
-                warnOnUnsupportedTypeScriptVersion: true,
-            },
-            settings: {
-                ...config.settings,
-                'import/resolver': {
-                    ...config.settings['import/resolver'],
-                    [require.resolve('eslint-import-resolver-typescript')]: {
-                        alwaysTryTypes: true,
-                    },
-                },
-            },
-            rules: {
-                ...config.rules,
-                ...tsRules,
-            },
-            overrides: [
-                ...config.overrides,
-                // ESLint can only apply one override per file, and takes first one matched,
-                // so multiple overrides should be combined.
-                // order is important.
-                {
-                    files: ['*.stories.ts', '*.stories.tsx', '*.stories.mts', '*.stories.cts'],
-                    rules: {
-                        ...loosenRules,
-                    },
-                },
-                {
-                    files: [
-                        '*.test.ts',
-                        '*.test.tsx',
-                        '*.test.mts',
-                        '*.test.cts',
-                        '__test__/**/*.ts',
-                        '__test__/**/*.tsx',
-                        '__test__/**/*.mts',
-                        '__test__/**/*.cts',
-                    ],
-                    extends: ['plugin:jest/recommended'],
-                    env: {
-                        'jest/globals': true,
-                    },
-                    rules: {
-                        ...loosenRules,
-                        'jest/no-deprecated-functions': 'off',
-                    },
-                },
-                {
-                    files: ['*.ts', '*.tsx', '*.mts', '*.cts'],
-                    rules: {
-                        ...tsRules,
-                    },
-                },
-            ],
-        })
+    try {
+      tsconfigPath = ts.findConfigFile(
+        process.cwd(),
+        ts.sys.fileExists,
+        "tsconfig.json"
+      );
+      const tsConfigFile = ts.readConfigFile(tsconfigPath, ts.sys.readFile);
+      if (tsConfigFile.config) {
+        // this are type-aware checks that require tsconfig presence
+        Object.assign(tsRules, {
+          "@typescript-eslint/await-thenable": "warn",
+          "@typescript-eslint/no-floating-promises": "error",
+          "no-implied-eval": "off",
+          "@typescript-eslint/no-implied-eval": "error",
+          "@typescript-eslint/no-misused-promises": "warn",
+          "@typescript-eslint/no-unnecessary-type-assertion": "warn",
+          "require-await": "off",
+          "@typescript-eslint/require-await": "error",
+          "@typescript-eslint/unbound-method": [
+            "error",
+            { ignoreStatic: true },
+          ],
+        });
+      }
+      if (config?.compilerOptions?.strict) {
+        Object.assign(tsRules, {
+          "@typescript-eslint/restrict-plus-operands": "warn",
+          "@typescript-eslint/no-explicit-any": "error",
+          "@typescript-eslint/no-unsafe-argument": "error",
+          "@typescript-eslint/no-unsafe-assignment": "error",
+          "@typescript-eslint/no-unsafe-call": "error",
+          "@typescript-eslint/no-unsafe-member-access": "error",
+          "@typescript-eslint/no-unsafe-return": "error",
+          "@typescript-eslint/restrict-template-expressions": "error",
+        });
+      }
+    } catch {
+      void 0;
     }
 
-    return config
-}
+    Object.assign(config, {
+      plugins: [...config.plugins, "@typescript-eslint"],
+      parser: "@typescript-eslint/parser",
+      parserOptions: {
+        sourceType: "module",
+        project: tsconfigPath,
+        ecmaFeatures: {
+          jsx: env.react,
+        },
+        warnOnUnsupportedTypeScriptVersion: true,
+      },
+      settings: {
+        ...config.settings,
+        "import/resolver": {
+          ...config.settings["import/resolver"],
+          [require.resolve("eslint-import-resolver-typescript")]: {
+            alwaysTryTypes: true,
+          },
+        },
+      },
+      rules: {
+        ...config.rules,
+        ...tsRules,
+      },
+      overrides: [
+        ...config.overrides,
+        // ESLint can only apply one override per file, and takes first one matched,
+        // so multiple overrides should be combined.
+        // order is important.
+        {
+          files: [
+            "*.stories.ts",
+            "*.stories.tsx",
+            "*.stories.mts",
+            "*.stories.cts",
+          ],
+          rules: {
+            ...loosenRules,
+          },
+        },
+        {
+          files: [
+            "*.test.ts",
+            "*.test.tsx",
+            "*.test.mts",
+            "*.test.cts",
+            "__test__/**/*.ts",
+            "__test__/**/*.tsx",
+            "__test__/**/*.mts",
+            "__test__/**/*.cts",
+          ],
+          extends: ["plugin:jest/recommended"],
+          env: {
+            "jest/globals": true,
+          },
+          rules: {
+            ...loosenRules,
+            "jest/no-deprecated-functions": "off",
+          },
+        },
+        {
+          files: ["*.ts", "*.tsx", "*.mts", "*.cts"],
+          rules: {
+            ...tsRules,
+          },
+        },
+      ],
+    });
+  }
+
+  return config;
+};