Add better eslint rules for importing

Author: EhabY

.eslintrc.json

@@ -20,7 +20,15 @@
 			"files": ["*.ts"],
 			"rules": {
 				"require-await": "off",
-				"@typescript-eslint/require-await": "error"
+				"@typescript-eslint/require-await": "error",
+				"@typescript-eslint/consistent-type-imports": [
+					"error",
+					{
+						"disallowTypeAnnotations": false, // Used in tests
+						"prefer": "type-imports",
+						"fixStyle": "inline-type-imports"
+					}
+				]
 			}
 		},
 		{
@@ -42,12 +50,25 @@
 		"import/order": [
 			"error",
 			{
-				"alphabetize": {
-					"order": "asc"
-				},
-				"groups": [["builtin", "external", "internal"], "parent", "sibling"]
+				"groups": [
+					["builtin", "external"],
+					"internal",
+					["parent", "sibling", "index"],
+					"type"
+				],
+				"pathGroups": [
+					{ "pattern": "@/**", "group": "internal", "position": "after" }
+				],
+				// Don't reclassify real externals like @babel/* into the alias group
+				"pathGroupsExcludedImportTypes": ["builtin", "external"],
+				"newlines-between": "always",
+				"alphabetize": { "order": "asc", "caseInsensitive": true },
+				"distinctGroup": true // separates type imports into the "type" group
 			}
 		],
+		// Prevent duplicates and prefer merging into a single import
+		"no-duplicate-imports": "off",
+		"import/no-duplicates": ["error", { "prefer-inline": true }],
 		"import/no-unresolved": [
 			"error",
 			{
@@ -72,7 +93,8 @@
 	"ignorePatterns": ["out", "dist", "**/*.d.ts"],
 	"settings": {
 		"import/resolver": {
-			"typescript": {}
-		}
+			"typescript": { "project": "./tsconfig.json" }
+		},
+		"import/internal-regex": "^@/"
 	}
 }

src/agentMetadataHelper.ts

@@ -1,11 +1,12 @@
-import { WorkspaceAgent } from "coder/site/src/api/typesGenerated";
+import { type WorkspaceAgent } from "coder/site/src/api/typesGenerated";
 import * as vscode from "vscode";
+
 import {
-	AgentMetadataEvent,
+	type AgentMetadataEvent,
 	AgentMetadataEventSchemaArray,
 	errToStr,
 } from "./api/api-helper";
-import { CoderApi } from "./api/coderApi";
+import { type CoderApi } from "./api/coderApi";
 
 export type AgentMetadataWatcher = {
 	onChange: vscode.EventEmitter<null>["event"];

src/api/api-helper.ts

@@ -1,8 +1,8 @@
 import { isApiError, isApiErrorResponse } from "coder/site/src/api/errors";
 import {
-	Workspace,
-	WorkspaceAgent,
-	WorkspaceResource,
+	type Workspace,
+	type WorkspaceAgent,
+	type WorkspaceResource,
 } from "coder/site/src/api/typesGenerated";
 import { ErrorEvent } from "eventsource";
 import { z } from "zod";

src/api/coderApi.ts

@@ -1,30 +1,34 @@
-import { AxiosInstance } from "axios";
+import { type AxiosInstance } from "axios";
 import { Api } from "coder/site/src/api/api";
 import {
-	GetInboxNotificationResponse,
-	ProvisionerJobLog,
-	ServerSentEvent,
-	Workspace,
-	WorkspaceAgent,
+	type GetInboxNotificationResponse,
+	type ProvisionerJobLog,
+	type ServerSentEvent,
+	type Workspace,
+	type WorkspaceAgent,
 } from "coder/site/src/api/typesGenerated";
 import { type WorkspaceConfiguration } from "vscode";
-import { ClientOptions } from "ws";
+import { type ClientOptions } from "ws";
+
 import { CertificateError } from "../error";
 import { getHeaderCommand, getHeaders } from "../headers";
+import { createHttpAgent } from "./utils";
 import {
 	createRequestMeta,
 	logRequest,
 	logError,
 	logResponse,
 } from "../logging/httpLogger";
-import { Logger } from "../logging/logger";
-import { RequestConfigWithMeta, HttpClientLogLevel } from "../logging/types";
+import { type Logger } from "../logging/logger";
+import {
+	type RequestConfigWithMeta,
+	HttpClientLogLevel,
+} from "../logging/types";
 import { WsLogger } from "../logging/wsLogger";
 import {
 	OneWayWebSocket,
-	OneWayWebSocketInit,
+	type OneWayWebSocketInit,
 } from "../websocket/oneWayWebSocket";
-import { createHttpAgent } from "./utils";
 
 const coderSessionTokenHeader = "Coder-Session-Token";
 

src/api/utils.ts

@@ -1,6 +1,7 @@
 import fs from "fs";
 import { ProxyAgent } from "proxy-agent";
 import { type WorkspaceConfiguration } from "vscode";
+
 import { getProxyForUrl } from "../proxy";
 import { expandPath } from "../util";
 

src/api/workspace.ts

@@ -1,12 +1,13 @@
 import { spawn } from "child_process";
-import { Api } from "coder/site/src/api/api";
-import { Workspace } from "coder/site/src/api/typesGenerated";
+import { type Api } from "coder/site/src/api/api";
+import { type Workspace } from "coder/site/src/api/typesGenerated";
 import * as vscode from "vscode";
-import { FeatureSet } from "../featureSet";
+
+import { type FeatureSet } from "../featureSet";
 import { getGlobalFlags } from "../globalFlags";
 import { escapeCommandArg } from "../util";
 import { errToStr, createWorkspaceIdentifier } from "./api-helper";
-import { CoderApi } from "./coderApi";
+import { type CoderApi } from "./coderApi";
 
 /**
  * Start or update a workspace and return the updated workspace.

src/cliUtils.test.ts

@@ -1,9 +1,10 @@
-import * as cli from "@/cliUtils";
 import fs from "fs/promises";
 import os from "os";
 import path from "path";
 import { beforeAll, describe, expect, it } from "vitest";
 
+import * as cli from "@/cliUtils";
+
 describe("cliUtils", () => {
 	const tmp = path.join(os.tmpdir(), "vscode-coder-tests");
 

src/commands.ts

@@ -1,25 +1,26 @@
-import { Api } from "coder/site/src/api/api";
+import { type Api } from "coder/site/src/api/api";
 import { getErrorMessage } from "coder/site/src/api/errors";
 import {
-	User,
-	Workspace,
-	WorkspaceAgent,
+	type User,
+	type Workspace,
+	type WorkspaceAgent,
 } from "coder/site/src/api/typesGenerated";
 import * as vscode from "vscode";
+
 import { createWorkspaceIdentifier, extractAgents } from "./api/api-helper";
 import { CoderApi } from "./api/coderApi";
 import { needToken } from "./api/utils";
-import { CliManager } from "./core/cliManager";
-import { MementoManager } from "./core/mementoManager";
-import { PathResolver } from "./core/pathResolver";
-import { SecretsManager } from "./core/secretsManager";
+import { type CliManager } from "./core/cliManager";
+import { type MementoManager } from "./core/mementoManager";
+import { type PathResolver } from "./core/pathResolver";
+import { type SecretsManager } from "./core/secretsManager";
 import { CertificateError } from "./error";
 import { getGlobalFlags } from "./globalFlags";
-import { Logger } from "./logging/logger";
+import { type Logger } from "./logging/logger";
 import { escapeCommandArg, toRemoteAuthority, toSafeHost } from "./util";
 import {
 	AgentTreeItem,
-	OpenableTreeItem,
+	type OpenableTreeItem,
 	WorkspaceTreeItem,
 } from "./workspacesProvider";
 

src/core/cliManager.ts

@@ -2,20 +2,20 @@ import globalAxios, {
 	type AxiosInstance,
 	type AxiosRequestConfig,
 } from "axios";
-import { Api } from "coder/site/src/api/api";
-import { createWriteStream, WriteStream } from "fs";
+import { type Api } from "coder/site/src/api/api";
+import { createWriteStream, type WriteStream } from "fs";
 import fs from "fs/promises";
-import { IncomingMessage } from "http";
+import { type IncomingMessage } from "http";
 import path from "path";
 import prettyBytes from "pretty-bytes";
 import * as semver from "semver";
-
 import * as vscode from "vscode";
+
 import { errToStr } from "../api/api-helper";
 import * as cli from "../cliUtils";
-import { Logger } from "../logging/logger";
+import { type Logger } from "../logging/logger";
 import * as pgp from "../pgp";
-import { PathResolver } from "./pathResolver";
+import { type PathResolver } from "./pathResolver";
 
 export class CliManager {
 	constructor(

src/error.ts

@@ -3,7 +3,8 @@ import { isApiError, isApiErrorResponse } from "coder/site/src/api/errors";
 import * as forge from "node-forge";
 import * as tls from "tls";
 import * as vscode from "vscode";
-import { Logger } from "./logging/logger";
+
+import { type Logger } from "./logging/logger";
 
 // X509_ERR_CODE represents error codes as returned from BoringSSL/OpenSSL.
 export enum X509_ERR_CODE {