chore: Add eslint-import-resolver-typescript (#771)

* chore: Add eslint-import-resolver-typescript

* Update .eslintrc

Co-authored-by: JounQin <admin@1stg.me>

* Fail on ts-prune nonempty

* build before lint

* order

* confirmed exit code 1

* Add import rules

* Fix lint

* wrap

* npm i

* Address review comments

* Move @types/uuid to devDep

* fix build

* fix lint errors

* fix lint

* fix circular imports; prettier

* rm deleted files

* mv PayloadConverterWithEncoding

* fix

* Fix test-npm-init

* update lint-and-prune

* Remove unused MakeOptional

* address comments

* dedup

* use randomUUID instead of uuid

* update deps

* Update `tsconfig.prune.json`

* fix lint?

* use a duplicate import rule that works in ci

* Fix CI lint

* update core to same as main

* fix lint errors

Co-authored-by: JounQin <admin@1stg.me>

Author: lorensr

.eslintrc

@@ -4,14 +4,15 @@
   "parserOptions": {
     "project": "./packages/*/tsconfig.json"
   },
-  "plugins": ["@typescript-eslint", "eslint-plugin-tsdoc", "deprecation"],
+  "plugins": ["@typescript-eslint", "eslint-plugin-tsdoc", "deprecation", "import"],
   "extends": [
     "eslint:recommended",
     "plugin:@typescript-eslint/eslint-recommended",
     "plugin:@typescript-eslint/recommended",
     "prettier"
   ],
   "rules": {
+    "no-duplicate-imports": "error",
     "object-shorthand": ["error", "always"],
     "deprecation/deprecation": "warn",
     "@typescript-eslint/no-explicit-any": 0,
@@ -23,6 +24,42 @@
         "argsIgnorePattern": "^_",
         "varsIgnorePattern": "^_"
       }
-    ]
+    ],
+    "import/no-unresolved": ["error", { "ignore": ["^__temporal_"] }],
+    // TypeScript compilation already ensures that named imports exist in the referenced module
+    "import/named": "off",
+    "import/default": "error",
+    "import/namespace": "error",
+    "import/no-absolute-path": "error",
+    "import/no-self-import": "error",
+    "import/no-cycle": "error",
+    "import/no-useless-path-segments": "error",
+    "import/no-relative-packages": "error",
+    "import/export": "error",
+    "import/no-named-as-default": "error",
+    // TODO enable and fix
+    // "import/no-deprecated": "error",
+    "import/no-extraneous-dependencies": "error",
+    "import/no-mutable-exports": "error",
+    "import/unambiguous": "error",
+    "import/first": "error",
+    // TODO next PR
+    // "import/order": "error",
+    "import/newline-after-import": "error",
+    "import/no-unassigned-import": "error",
+    "import/no-named-default": "error"
+  },
+  "settings": {
+    "import/parsers": {
+      "@typescript-eslint/parser": [".ts"]
+    },
+    "import/resolver": {
+      "typescript": {
+        // always try to resolve types under `<root>@types` directory even it doesn't contain any source code, like
+        // `@types/unist`
+        "alwaysTryTypes": true,
+        "project": ["packages/*/tsconfig.json"]
+      }
+    }
   }
 }

.github/workflows/ci.yml

@@ -116,8 +116,10 @@ jobs:
       - uses: actions/setup-node@v1
         with:
           node-version: 16
-      # Don't build during install phase since we don't need builds for linting
       - run: npm ci --ignore-scripts
+      # eslint-import-resolver-typescript requires packages to be built
+      - name: Compile all non-rust code
+        run: npm run build -- --ignore @temporalio/core-bridge
       - run: npm run lint
       - run: npm run lint.prune