@forsakringskassan/eslint-config-typescript 10.2.0

package/index.js

@@ -0,0 +1,73 @@
+module.exports = {
+    parser: "@typescript-eslint/parser",
+
+    plugins: ["@typescript-eslint", "tsdoc"],
+
+    extends: [
+        "plugin:@typescript-eslint/strict",
+        "plugin:@typescript-eslint/stylistic",
+    ],
+
+    rules: {
+        /* Disabled as it is better to let typescript deal with this. For
+         * instance, ESLint cannot detect when exhaustive checks are made and
+         * the rest of the function is dead thus yielding false positives */
+        "consistent-return": "off",
+
+        /* prefer T[] for simple types, Array<T> for complex types (unions, etc) */
+        "@typescript-eslint/array-type": ["error", { default: "array-simple" }],
+
+        /* require all regular functions and methods to explicitly declare
+         * return value type */
+        "@typescript-eslint/explicit-function-return-type": [
+            "error",
+            {
+                allowExpressions: true,
+                allowHigherOrderFunctions: true,
+                allowTypedFunctionExpressions: true,
+            },
+        ],
+
+        /* require all members to specify "public", "private", etc */
+        "@typescript-eslint/explicit-member-accessibility": "error",
+
+        /* allow "const foo: number = 0" */
+        "@typescript-eslint/no-inferrable-types": "off",
+
+        /* allow function(this: void, ...) */
+        "@typescript-eslint/no-invalid-void-type": [
+            "error",
+            {
+                allowAsThisParameter: true,
+            },
+        ],
+
+        /* allow constructs such as `unknown | null`, while `unknown` does override
+         * `null` it can still serve as a self-documenting type to signal that
+         * `null` has a special meaning. It also helps when the type is to be
+         * replaced with a better type later. */
+        "@typescript-eslint/no-redundant-type-constituents": "off",
+
+        "@typescript-eslint/no-unused-vars": [
+            "error",
+            {
+                /* allow `foo` to be unused when `{ foo, ...spread} = bar` is
+                 * used to extract members from objects */
+                ignoreRestSiblings: true,
+
+                /* allow _ as prefix for intentionally unused variables */
+                argsIgnorePattern: "^_",
+            },
+        ],
+
+        /* allow overloading only if the parameters have different names */
+        "@typescript-eslint/unified-signatures": [
+            "error",
+            {
+                ignoreDifferentlyNamedParameters: true,
+            },
+        ],
+
+        "tsdoc/syntax": "error",
+    },
+};

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@forsakringskassan/eslint-config-typescript",
+  "version": "10.2.0",
+  "description": "Försäkringskassans eslint shareable typescript config",
+  "keywords": [
+    "eslint"
+  ],
+  "homepage": "https://github.com/Forsakringskassan/eslint-config",
+  "bugs": "https://github.com/Forsakringskassan/eslint-config/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Forsakringskassan/eslint-config.git",
+    "directory": "packages/eslint-config-typescript"
+  },
+  "license": "MIT",
+  "author": "Försäkringskassan",
+  "files": [
+    "index.js"
+  ],
+  "dependencies": {
+    "@typescript-eslint/eslint-plugin": "6.21.0",
+    "@typescript-eslint/parser": "7.0.2",
+    "eslint-plugin-tsdoc": "0.2.17"
+  },
+  "peerDependencies": {
+    "typescript": "^3 || ^4 || ^5"
+  },
+  "engines": {
+    "node": ">= 16.10"
+  },
+  "gitHead": "0cd554a08710a08521bac5d79fcce26f2bdd5886"
+}