Refactor test structure, improve linting, and enhance code organization (#594)

This refactor reorganizes the test layout, strengthens linting configuration, and introduces path aliases in tests to improve code maintainability.

Test Structure Changes:
- Move tests from /src to top-level /test directory
  - /test/unit: unit tests with mocks
  - /test/integration: end-to-end tests with real VS Code API
  - /test/mocks: shared mocks
  - /test/fixtures: relocated from /fixtures
  - /test/utils: various test utils
- Prevent test file imports in src
- Unify fixture path resolution

Development Tooling:
- Configure ESLint and TypeScript "fix on save" in VS Code
- Update ESLint-related dependencies
- Address multiple ESLint rule violations (imports, typing)

Code Organization:
- Add path aliases for tests (@ → /src)
- Introduce ServiceContainer to initialize and track services in src/core
- Improve .vscodeignore to ship only necessary files

Author: EhabY

.eslintrc.json

@@ -4,9 +4,9 @@
 	"parserOptions": {
 		"ecmaVersion": 6,
 		"sourceType": "module",
-		"project": "./tsconfig.json"
+		"project": true
 	},
-	"plugins": ["@typescript-eslint", "prettier"],
+	"plugins": ["@typescript-eslint", "prettier", "import"],
 	"extends": [
 		"eslint:recommended",
 		"plugin:@typescript-eslint/recommended",
@@ -15,12 +15,38 @@
 		"plugin:md/prettier",
 		"prettier"
 	],
+	"ignorePatterns": ["out", "dist", "**/*.d.ts"],
+	"settings": {
+		"import/resolver": {
+			"typescript": { "project": "./tsconfig.json" }
+		},
+		"import/internal-regex": "^@/"
+	},
 	"overrides": [
+		{
+			"files": ["test/**/*.{ts,tsx}", "**/*.{test,spec}.ts?(x)"],
+			"settings": {
+				"import/resolver": {
+					"typescript": {
+						// In tests, resolve using the test tsconfig
+						"project": "test/tsconfig.json"
+					}
+				}
+			}
+		},
 		{
 			"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 +68,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": "before" }
+				],
+				"pathGroupsExcludedImportTypes": ["builtin", "external"],
+				"newlines-between": "always",
+				"alphabetize": { "order": "asc", "caseInsensitive": true },
+				"sortTypesGroup": true
 			}
 		],
+		// Prevent duplicates and prefer merging into a single import
+		"no-duplicate-imports": "off",
+		"import/no-duplicates": ["error", { "prefer-inline": true }],
 		"import/no-unresolved": [
 			"error",
 			{
@@ -68,6 +107,5 @@
 				}
 			}
 		]
-	},
-	"ignorePatterns": ["out", "dist", "**/*.d.ts"]
+	}
 }

.vscode-test.mjs

@@ -1,7 +1,7 @@
 import { defineConfig } from "@vscode/test-cli";
 
 export default defineConfig({
-	files: "out/test/**/*.test.js",
+	files: "out/test/integration/**/*.test.js",
 	extensionDevelopmentPath: ".",
 	extensionTestsPath: "./out/test",
 	launchArgs: ["--enable-proposed-api", "coder.coder-remote"],

.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+	"editor.formatOnSave": true,
+	"editor.codeActionsOnSave": {
+		"source.fixAll.ts": "explicit",
+		"source.fixAll.eslint": "explicit"
+	},
+	"editor.defaultFormatter": "esbenp.prettier-vscode",
+	"[json]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
+	},
+	"[jsonc]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
+	}
+}

.vscodeignore

@@ -1,16 +1,42 @@
-.vscode/**
-.vscode-test/**
-.nyc_output/**
-coverage/**
+# Test and coverage output
 out/**
+coverage/**
+.nyc_output/**
+
+# Development files
 src/**
-usage.md
-.gitignore
-node_modules/**
-**/tsconfig.json
-**/.eslintrc.json
-**/.editorconfig
-**/*.map
+test/**
 **/*.ts
+**/*.map
+
+# Configuration files
+.vscode/**
+.vscode-test/**
+.vscode-test.mjs
+tsconfig.json
+.eslintrc.json
+.editorconfig
+.prettierignore
+.eslintignore
+**/.gitignore
+**/.git-blame-ignore-revs
+
+# Package manager files
+yarn.lock
+
+# Nix/flake files
+flake.nix
+flake.lock
+*.nix
+
+# Dependencies
+node_modules/**
+
+# Development tools and CI
+.github/**
+.claude/**
+
+# Documentation and media
+usage.md
+CLAUDE.md
 *.gif
-fixtures/**

package.json

@@ -330,11 +330,12 @@
 		"@types/glob": "^7.1.3",
 		"@types/node": "^22.14.1",
 		"@types/node-forge": "^1.3.14",
+		"@types/semver": "^7.7.1",
 		"@types/ua-parser-js": "0.7.36",
 		"@types/vscode": "^1.73.0",
 		"@types/ws": "^8.18.1",
-		"@typescript-eslint/eslint-plugin": "^7.0.0",
-		"@typescript-eslint/parser": "^6.21.0",
+		"@typescript-eslint/eslint-plugin": "^8.44.0",
+		"@typescript-eslint/parser": "^8.44.0",
 		"@vitest/coverage-v8": "^3.2.4",
 		"@vscode/test-cli": "^0.0.11",
 		"@vscode/test-electron": "^2.5.2",
@@ -343,13 +344,15 @@
 		"coder": "https://github.com/coder/coder#main",
 		"dayjs": "^1.11.13",
 		"eslint": "^8.57.1",
-		"eslint-config-prettier": "^9.1.0",
-		"eslint-plugin-import": "^2.31.0",
+		"eslint-config-prettier": "^10.1.8",
+		"eslint-import-resolver-typescript": "^4.4.4",
+		"eslint-plugin-import": "^2.32.0",
 		"eslint-plugin-md": "^1.0.19",
 		"eslint-plugin-package-json": "^0.56.3",
 		"eslint-plugin-prettier": "^5.5.4",
 		"glob": "^10.4.2",
 		"jsonc-eslint-parser": "^2.4.0",
+		"markdown-eslint-parser": "^1.2.1",
 		"memfs": "^4.47.0",
 		"nyc": "^17.1.0",
 		"prettier": "^3.5.3",

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,14 +1,15 @@
-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 {
@@ -17,13 +18,17 @@ import {
 	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/proxy.ts renamed to src/api/proxy.ts

@@ -1,9 +1,11 @@
 import fs from "fs";
 import { ProxyAgent } from "proxy-agent";
 import { type WorkspaceConfiguration } from "vscode";
-import { getProxyForUrl } from "../proxy";
+
 import { expandPath } from "../util";
 
+import { getProxyForUrl } from "./proxy";
+
 /**
  * Return whether the API will need a token for authorization.
  * If mTLS is in use (as specified by the cert or key files being set) then