fix: add eslint check and fix scripts (#87)

Signed-off-by: Denis Golovin <[email protected]>

Author: dgolovin

.eslintcache

@@ -0,0 +1,7 @@
+test-resources
+scripts
+builtin/**
+www
+*.config.js
+types/**/*.ts
+__mocks__

.eslintignore

@@ -0,0 +1,112 @@
+{
+  "root": true,
+  "env": {
+    "es2021": true,
+    "node": true,
+    "browser": false
+  },
+  "extends": [
+    "eslint:recommended",
+    /** @see https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin#recommended-configs */
+    "plugin:@typescript-eslint/recommended",
+    "plugin:import/recommended",
+    "plugin:import/typescript",
+    "plugin:etc/recommended",
+    "plugin:sonarjs/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 12,
+    "sourceType": "module",
+    "warnOnUnsupportedTypeScriptVersion": false,
+    "project": [
+      "tsconfig.json"
+    ]
+  },
+  "overrides": [
+    {
+      // enable the rule specifically for TypeScript files
+      "files": ["*.ts"],
+      "rules": {
+        "@typescript-eslint/explicit-function-return-type": "error"
+      }
+    }
+  ],
+  "settings": {
+    "import/resolver": {
+      "typescript": true,
+      "node": true,
+      "eslint-import-resolver-custom-alias": {
+        "alias": {
+          "/@": "./src",
+          "/@gen": "./src-generated"
+        },
+        "extensions": [".ts"],
+        "packages": []
+      }
+    }
+  },
+  "plugins": [
+    "@typescript-eslint",
+    "sonarjs",
+    "etc",
+    "redundant-undefined",
+    "no-null",
+    "header",
+    "simple-import-sort",
+    "unicorn"
+  ],
+  "ignorePatterns": [
+    "node_modules/**",
+    "dist/**",
+    "builtin/**"
+  ],
+  "rules": {
+    "eqeqeq": "error",
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }],
+    "@typescript-eslint/no-var-requires": "off",
+    "@typescript-eslint/consistent-type-imports": "error",
+    "@typescript-eslint/no-explicit-any": "error",
+    "prefer-promise-reject-errors": "error",
+    "@typescript-eslint/await-thenable": "error",
+    "@typescript-eslint/no-floating-promises": "error",
+    "@typescript-eslint/no-misused-promises": "error",
+    "@typescript-eslint/prefer-optional-chain": "error",
+    "no-null/no-null": "error",
+
+    /**
+     * Having a semicolon helps the optimizer interpret your code correctly.
+     * This avoids rare errors in optimized code.
+     * @see https://twitter.com/alex_kozack/status/1364210394328408066
+     */
+    "semi": ["error", "always"],
+    /**
+     * This will make the history of changes in the hit a little cleaner
+     */
+    "comma-dangle": ["warn", "always-multiline"],
+    /**
+     * Just for beauty
+     */
+    "quotes": ["error", "single", { "allowTemplateLiterals": true }],
+    "import/no-duplicates": "error",
+    "import/no-unresolved": "off",
+    "import/default": "off",
+    "import/no-named-as-default-member": "off",
+    "import/no-named-as-default": "off",
+    "import/first": "error",
+    "import/newline-after-import": "error",
+    "sonarjs/cognitive-complexity": "off",
+    "sonarjs/no-duplicate-string": "off",
+    "sonarjs/no-empty-collection": "off",
+    "sonarjs/no-small-switch": "off",
+    "etc/no-commented-out-code": "error",
+    "etc/no-deprecated": "off",
+    "redundant-undefined/redundant-undefined": "error",
+    "import/no-extraneous-dependencies": "error",
+    "header/header": [2, "block", [{ "pattern": "SPDX-License-Identifier: Apache-2\\.0" }]],
+    "simple-import-sort/imports": "error",
+    "simple-import-sort/exports": "error",
+    "unicorn/prefer-node-protocol": "error"
+  }
+}

.eslintrc.json

@@ -23,6 +23,9 @@
     "watch": "rollup --bundleConfigAsCjs --config rollup.config.js -w",
     "format:check": "prettier --cache --check \"{src,types,scripts}/**/*.{ts,js}\"",
     "format:fix": "prettier --cache --write \"{src,types,scripts}/**/*.{ts,js}\"",
+    "lint:clean": "rimraf .eslintcache",
+    "lint:fix": "node --max-old-space-size=6144 node_modules/eslint/bin/eslint.js --cache . --fix --ext js,ts",
+    "lint:check": "node --max-old-space-size=6144 node_modules/eslint/bin/eslint.js --cache . --ext js,ts",
     "test": "vitest run --coverage"
   },
   "dependencies": {
@@ -41,7 +44,20 @@
     "@rollup/plugin-node-resolve": "^15.0.2",
     "@rollup/plugin-typescript": "^11.1.0",
     "@types/js-yaml": "^4.0.5",
+    "@typescript-eslint/eslint-plugin": "^7.0.0",
+    "@typescript-eslint/parser": "^6.21.0",
     "@vitest/coverage-v8": "^1.2.1",
+    "eslint": "^8.57.0",
+    "eslint-import-resolver-custom-alias": "^1.3.2",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-etc": "^2.0.3",
+    "eslint-plugin-header": "^3.1.1",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-no-null": "^1.0.2",
+    "eslint-plugin-redundant-undefined": "^1.0.0",
+    "eslint-plugin-simple-import-sort": "^12.0.0",
+    "eslint-plugin-sonarjs": "^0.24.0",
+    "eslint-plugin-unicorn": "^51.0.1",
     "mkdirp": "^2.1.3",
     "prettier": "^3.2.5",
     "rollup": "^3.20.4",

package.json

@@ -14,6 +14,6 @@
     "allowSyntheticDefaultImports": true
 },
 "include": [
-    "src"
+    "src/**/*.ts"
 ]
 }