feat: new eslint and prettier support

.eslintrc.json

@@ -1,91 +1,245 @@
 {
+  "overrides": [
+    {
+      "files": ["src/**/*.ts"]
+    }
+  ],
   "env": {
     "es2021": true,
     "node": true
   },
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:jsdoc/recommended",
-    "plugin:jsdoc/recommended-typescript"
-  ],
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaVersion": 12,
     "sourceType": "module"
   },
-  "plugins": [
-    "@typescript-eslint",
-    "jsdoc"
-  ],
+  "plugins": ["@typescript-eslint", "import"],
   "settings": {},
-  "ignorePatterns": [
-    "node_modules/",
-    "build/"
-  ],
+  "ignorePatterns": ["node_modules/", "build/"],
   "rules": {
-    "@typescript-eslint/ban-types": [
+    "import/order": [
       "error",
       {
-        "types": {
-          "Object": "Use {} instead"
+        "groups": ["builtin", "external", "internal", "index", "sibling", "parent"],
+        "alphabetize": {
+          "order": "asc"
         }
       }
     ],
-    "@typescript-eslint/explicit-function-return-type": "warn",
-    "@typescript-eslint/no-empty-function": "off",
-    "@typescript-eslint/no-unused-vars": [
-      "warn",
-      {}
+    "no-compare-neg-zero": "error",
+    "no-template-curly-in-string": "error",
+    "no-unsafe-negation": "error",
+    "valid-jsdoc": [
+      "error",
+      {
+        "requireReturn": false,
+        "requireReturnDescription": false,
+        "prefer": {
+          "return": "returns",
+          "arg": "param"
+        },
+        "preferType": {
+          "String": "string",
+          "Number": "number",
+          "Boolean": "boolean",
+          "Symbol": "symbol",
+          "object": "Object",
+          "function": "Function",
+          "array": "Array",
+          "date": "Date",
+          "error": "Error",
+          "null": "void"
+        }
+      }
     ],
-    "@typescript-eslint/no-non-null-assertion": "off",
-    "keyword-spacing": "warn",
-    "default-case-last": "warn",
+    "accessor-pairs": "warn",
+    "array-callback-return": "error",
+    "consistent-return": "error",
+    "curly": ["error", "multi-line", "consistent"],
+    "dot-location": ["error", "property"],
+    "dot-notation": "error",
     "eqeqeq": "error",
-    "no-case-declarations": "error",
-    "dot-notation": "warn",
-    "no-delete-var": "error",
-    "no-else-return": [
-      "warn",
+    "no-empty-function": "error",
+    "no-floating-decimal": "error",
+    "no-implied-eval": "error",
+    "no-invalid-this": "error",
+    "no-lone-blocks": "error",
+    "no-multi-spaces": "error",
+    "no-new-func": "error",
+    "no-new-wrappers": "error",
+    "no-new": "error",
+    "no-octal-escape": "error",
+    "no-return-assign": "error",
+    "no-return-await": "error",
+    "no-self-compare": "error",
+    "no-sequences": "error",
+    "no-throw-literal": "error",
+    "no-unmodified-loop-condition": "error",
+    "no-unused-expressions": "error",
+    "no-useless-call": "error",
+    "no-useless-concat": "error",
+    "no-useless-escape": "error",
+    "no-useless-return": "error",
+    "no-void": "error",
+    "no-warning-comments": "warn",
+    "prefer-promise-reject-errors": "error",
+    "require-await": "warn",
+    "wrap-iife": "error",
+    "yoda": "error",
+    "no-label-var": "error",
+    "no-undef-init": "error",
+    "callback-return": "error",
+    "getter-return": "off",
+    "handle-callback-err": "error",
+    "no-mixed-requires": "error",
+    "no-new-require": "error",
+    "no-path-concat": "error",
+    "array-bracket-spacing": "error",
+    "block-spacing": "error",
+    "brace-style": [
+      "error",
+      "1tbs",
       {
-        "allowElseIf": true
+        "allowSingleLine": true
       }
     ],
-    "no-empty": "off",
-    "no-multi-str": "warn",
-    "no-throw-literal": "error",
-    "no-unneeded-ternary": "warn",
-    "no-useless-computed-key": "warn",
-    "no-var": "error",
-    "no-with": "error",
-    "prefer-numeric-literals": "error",
-    "require-await": "error",
-    "require-yield": "error",
-    "yoda": [
-      "warn",
-      "never",
+    "capitalized-comments": [
+      "error",
+      "always",
+      {
+        "ignoreConsecutiveComments": true
+      }
+    ],
+    "comma-dangle": ["error", "always-multiline"],
+    "comma-spacing": "error",
+    "comma-style": "error",
+    "computed-property-spacing": "error",
+    "consistent-this": ["error", "$this"],
+    "eol-last": "error",
+    "func-names": "error",
+    "func-name-matching": "error",
+    "func-style": [
+      "error",
+      "declaration",
       {
-        "exceptRange": true
+        "allowArrowFunctions": true
       }
     ],
-    "array-bracket-spacing": [
-      "warn",
-      "never"
+    "key-spacing": "error",
+    "keyword-spacing": "error",
+    "max-depth": "error",
+    "max-len": ["error", 120, 2],
+    "max-nested-callbacks": [
+      "error",
+      {
+        "max": 4
+      }
+    ],
+    "max-statements-per-line": [
+      "error",
+      {
+        "max": 2
+      }
     ],
-    "comma-dangle": [
-      "warn",
-      "always-multiline"
+    "new-cap": "off",
+    "newline-per-chained-call": [
+      "error",
+      {
+        "ignoreChainWithDepth": 3
+      }
     ],
-    "@typescript-eslint/ban-ts-comment": "off",
-    "linebreak-style": [
+    "no-array-constructor": "error",
+    "no-inline-comments": "error",
+    "no-lonely-if": "error",
+    "no-multiple-empty-lines": [
       "error",
-      "windows"
+      {
+        "max": 2,
+        "maxEOF": 1,
+        "maxBOF": 0
+      }
     ],
+    "no-new-object": "error",
+    "no-spaced-func": "error",
+    "no-trailing-spaces": "error",
+    "no-unneeded-ternary": "error",
+    "no-whitespace-before-property": "error",
+    "nonblock-statement-body-position": "error",
+    "object-curly-spacing": ["error", "always"],
+    "operator-assignment": "error",
+    "padded-blocks": ["error", "never"],
+    "quote-props": ["error", "as-needed"],
     "quotes": [
-      "warn",
-      "single"
+      "error",
+      "single",
+      {
+        "avoidEscape": true,
+        "allowTemplateLiterals": true
+      }
     ],
-    "semi": "off",
-    "@typescript-eslint/semi": "warn"
+    "semi-spacing": "error",
+    "semi": "error",
+    "space-before-blocks": "error",
+    "space-before-function-paren": [
+      "error",
+      {
+        "anonymous": "never",
+        "named": "never",
+        "asyncArrow": "always"
+      }
+    ],
+    "space-in-parens": "error",
+    "space-infix-ops": "error",
+    "space-unary-ops": "error",
+    "spaced-comment": "error",
+    "template-tag-spacing": "error",
+    "unicode-bom": "error",
+    "arrow-body-style": "error",
+    "arrow-parens": ["error", "as-needed"],
+    "arrow-spacing": "error",
+    "no-duplicate-imports": "error",
+    "no-useless-computed-key": "error",
+    "no-useless-constructor": "error",
+    "prefer-arrow-callback": "error",
+    "prefer-numeric-literals": "error",
+    "prefer-rest-params": "error",
+    "prefer-spread": "error",
+    "prefer-template": "error",
+    "prefer-object-has-own": "error",
+    "rest-spread-spacing": "error",
+    "template-curly-spacing": "error",
+    "yield-star-spacing": "error",
+    "no-restricted-globals": [
+      "error",
+      {
+        "name": "Buffer",
+        "message": "Import Buffer from `node:buffer` instead"
+      },
+      {
+        "name": "process",
+        "message": "Import process from `node:process` instead"
+      },
+      {
+        "name": "setTimeout",
+        "message": "Import setTimeout from `node:timers` instead"
+      },
+      {
+        "name": "setInterval",
+        "message": "Import setInterval from `node:timers` instead"
+      },
+      {
+        "name": "setImmediate",
+        "message": "Import setImmediate from `node:timers` instead"
+      },
+      {
+        "name": "clearTimeout",
+        "message": "Import clearTimeout from `node:timers` instead"
+      },
+      {
+        "name": "clearInterval",
+        "message": "Import clearInterval from `node:timers` instead"
+      }
+    ]
   }
-}
+}

.prettierrc.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc.json",
+  "singleQuote": true,
+  "printWidth": 120,
+  "trailingComma": "all",
+  "endOfLine": "lf",
+  "arrowParens": "avoid"
+}

README.md

@@ -1,5 +1,7 @@
 # CountBot API Types
+
 Install the interfaces and types used across CountBot with `npm i -D @countbot/countbot-api-types`.
 
 # Generics
-The generic interfaces should take a `string` or a mongoose `Types.ObjectId`.
+
+The generic interfaces should take a `string` or a mongoose `Types.ObjectId`.