BSA-270: add linters

Author: fshabanov

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+charset = utf-8
+
+[*.md]
+indent_size = unset

.gitignore

@@ -1,3 +1,3 @@
 node_modules
 build
-.vscode
+.vscode

.ls-lint.yml

@@ -0,0 +1,13 @@
+ls:
+    .dir: regex:([.a-z0-9]*)([-.][a-z0-9]+)*
+    .css: regex:([.a-z0-9]*)([-.][a-z0-9]+)*
+    .ts: regex:([.a-z0-9]*)([-.][a-z0-9]+)*
+    .js: regex:([.a-z0-9]*)([-.][a-z0-9]+)*
+    .mjs: regex:([.a-z0-9]*)([-.][a-z0-9]+)*
+
+ignore:
+    - .git
+    - .github
+    - .idea/**
+    - node_modules
+    - build

.prettierrc

@@ -2,10 +2,10 @@
     "tabWidth": 4,
     "useTabs": false,
     "semi": true,
-    "singleQuote": true,
+    "singleQuote": false,
     "trailingComma": "none",
     "bracketSpacing": true,
-    "arrowParens": "avoid",
+    "arrowParens": "always",
     "quoteProps": "preserve",
     "printWidth": 120
 }

eslint.config.js

@@ -0,0 +1,275 @@
+import js from "@eslint/js";
+import stylistic from "@stylistic/eslint-plugin";
+import ts from "@typescript-eslint/eslint-plugin";
+import tsParser from "@typescript-eslint/parser";
+import { resolve as tsResolver } from "eslint-import-resolver-typescript";
+import importPlugin from "eslint-plugin-import";
+import jsdoc from "eslint-plugin-jsdoc";
+import perfectionist from "eslint-plugin-perfectionist";
+import explicitGenerics from "eslint-plugin-require-explicit-generics";
+import sonarjs from "eslint-plugin-sonarjs";
+import unicorn from "eslint-plugin-unicorn";
+import globals from "globals";
+
+const JS_MAX_PARAMS_ALLOWED = 3;
+
+/** @typedef {import("eslint").Linter.Config} */
+let Config;
+/** @typedef {import("eslint").Linter.ParserModule} */
+let ParserModule;
+
+/** @type {Config} */
+const filesConfig = {
+    files: ["./src/**/*.{js,ts,mjs}"]
+};
+
+/** @type {Config} */
+const ignoresConfig = {
+    ignores: ["public", "build"]
+};
+
+/** @type {Config} */
+const jsConfig = {
+    languageOptions: {
+        globals: globals.node,
+        parserOptions: {
+            ecmaVersion: 14,
+            sourceType: "module"
+        }
+    },
+    rules: {
+        ...js.configs.recommended.rules,
+        "arrow-parens": ["error", "always"],
+        curly: ["error", "all"],
+        "max-params": ["error", JS_MAX_PARAMS_ALLOWED],
+        "no-console": ["error"],
+        "no-multiple-empty-lines": [
+            "error",
+            {
+                max: 1
+            }
+        ],
+        "no-restricted-syntax": [
+            "error",
+            {
+                message: "Export/Import all (*) is forbidden.",
+                selector: "ExportAllDeclaration,ImportAllDeclaration"
+            },
+            {
+                message: "Exports should be at the end of the file.",
+                selector: "ExportNamedDeclaration[declaration!=null]"
+            },
+            {
+                message: "TS features are forbidden.",
+                selector: "TSEnumDeclaration,ClassDeclaration[abstract=true]"
+            },
+            {
+                message:
+                    "Avoid import/export type { Type } from './module'. Prefer import/export { type Type } from './module'.",
+                selector: "ImportDeclaration[importKind=type],ExportNamedDeclaration[exportKind=type]"
+            }
+        ],
+        "no-unused-vars": [
+            "error",
+            {
+                "argsIgnorePattern": "^_",
+                "caughtErrorsIgnorePattern": "^_",
+                "varsIgnorePattern": "^_"
+            }
+        ],
+        "object-shorthand": ["error"],
+        "prefer-destructuring": ["error"],
+        quotes: ["error", "double"]
+    }
+};
+
+/** @type {Config} */
+const importConfig = {
+    plugins: {
+        import: importPlugin
+    },
+    rules: {
+        ...importPlugin.configs.recommended.rules,
+        "import/exports-last": ["error"],
+        "import/extensions": [
+            "error",
+            {
+                js: "always"
+            }
+        ],
+        "import/newline-after-import": ["error"],
+        "import/no-default-export": ["error"],
+        "import/no-duplicates": ["error"]
+    },
+    settings: {
+        "import/parsers": {
+            espree: [".js", ".cjs"]
+        },
+        "import/resolver": {
+            typescript: tsResolver
+        }
+    }
+};
+
+/** @type {Config} */
+const sonarConfig = {
+    plugins: {
+        sonarjs
+    },
+    rules: {
+        ...sonarjs.configs.recommended.rules,
+        "sonarjs/no-duplicate-string": ["off"],
+        "sonarjs/no-unused-vars": ["off"]
+    }
+};
+
+/** @type {Config} */
+const unicornConfig = {
+    plugins: {
+        unicorn
+    },
+    rules: {
+        ...unicorn.configs.recommended.rules,
+        "unicorn/no-null": ["off"]
+    }
+};
+
+/** @type {Config} */
+const perfectionistConfig = {
+    plugins: {
+        perfectionist
+    },
+    rules: perfectionist.configs["recommended-natural"].rules
+};
+
+/** @type {Config} */
+const typescriptConfig = {
+    ignores: ["eslint.config.js", "lint-staged.config.js", "stylelint.config.js"],
+    languageOptions: {
+        parser: /** @type {ParserModule} */ (tsParser),
+        parserOptions: {
+            project: "./tsconfig.json"
+        }
+    },
+    plugins: {
+        "@typescript-eslint": ts
+    },
+    rules: {
+        ...ts.configs["strict-type-checked"].rules,
+        "@typescript-eslint/consistent-type-exports": ["error"],
+        "@typescript-eslint/consistent-type-imports": [
+            "error",
+            {
+                fixStyle: "inline-type-imports"
+            }
+        ],
+        "@typescript-eslint/explicit-function-return-type": [
+            "error",
+            {
+                allowTypedFunctionExpressions: true
+            }
+        ],
+        "@typescript-eslint/no-magic-numbers": [
+            "error",
+            {
+                ignoreEnums: true,
+                ignoreReadonlyClassProperties: true
+            }
+        ],
+        "@typescript-eslint/no-misused-promises": [
+            "error",
+            {
+                "checksVoidReturn": false
+            }
+        ],
+        "@typescript-eslint/no-unused-vars": ["off"],
+        "@typescript-eslint/return-await": ["error", "always"]
+    }
+};
+
+/** @type {Config} */
+const jsdocConfig = {
+    files: ["eslint.config.js", "lint-staged.config.js"],
+    plugins: {
+        jsdoc
+    },
+    rules: {
+        ...jsdoc.configs["recommended-typescript-flavor-error"].rules,
+        "jsdoc/no-undefined-types": ["error"]
+    }
+};
+
+/** @type {Config} */
+const stylisticConfig = {
+    plugins: {
+        "@stylistic": stylistic
+    },
+    rules: {
+        "@stylistic/padding-line-between-statements": [
+            "error",
+            {
+                blankLine: "never",
+                next: "export",
+                prev: "export"
+            },
+            {
+                blankLine: "always",
+                next: "*",
+                prev: ["block-like", "throw"]
+            },
+            {
+                blankLine: "always",
+                next: ["return", "block-like", "throw"],
+                prev: "*"
+            }
+        ]
+    }
+};
+
+/** @type {Config} */
+const explicitGenericsConfig = {
+    plugins: {
+        "require-explicit-generics": explicitGenerics
+    }
+};
+
+/** @type {Config[]} */
+const overridesConfigs = [
+    {
+        files: ["packages.d.ts", "lint-staged.config.js", "eslint.config.js"],
+        rules: {
+            "import/no-default-export": ["off"]
+        }
+    },
+    {
+        files: ["*.js"],
+        rules: {
+            "@typescript-eslint/explicit-function-return-type": ["off"]
+        }
+    },
+    {
+        files: ["./src/server.ts"],
+        rules: {
+            "import/no-default-export": ["off"],
+            "no-console": ["off"]
+        }
+    }
+];
+
+/** @type {Config[]} */
+const config = [
+    filesConfig,
+    ignoresConfig,
+    jsConfig,
+    importConfig,
+    sonarConfig,
+    unicornConfig,
+    perfectionistConfig,
+    typescriptConfig,
+    jsdocConfig,
+    stylisticConfig,
+    explicitGenericsConfig,
+    ...overridesConfigs
+];
+
+export default config;

lint-staged.config.js

@@ -0,0 +1,6 @@
+/** @type {import('lint-staged').Config} */
+const config = {
+    "*": [() => "npm run lint:editor", () => "npm run lint:fs", () => "npm run lint:js", () => "npm run lint:format"]
+};
+
+export default config;