Extend node builtin import diagnostic to http modules (#686)

Author: mattiamanzati

.changeset/famous-garlics-lie.md

@@ -0,0 +1,5 @@
+---
+"@effect/language-service": patch
+---
+
+Extend the node built-in import diagnostic to also recommend the Effect HTTP client for `http` and `https` imports.

packages/harness-effect-v4/__snapshots__/diagnostics/nodeBuiltinImport.ts.codefixes

@@ -16,7 +16,11 @@ nodeBuiltinImport_skipNextLine from 398 to 413
 nodeBuiltinImport_skipFile from 398 to 413
 nodeBuiltinImport_skipNextLine from 436 to 456
 nodeBuiltinImport_skipFile from 436 to 456
-nodeBuiltinImport_skipNextLine from 496 to 505
-nodeBuiltinImport_skipFile from 496 to 505
-nodeBuiltinImport_skipNextLine from 557 to 566
-nodeBuiltinImport_skipFile from 557 to 566
+nodeBuiltinImport_skipNextLine from 474 to 480
+nodeBuiltinImport_skipFile from 474 to 480
+nodeBuiltinImport_skipNextLine from 499 to 511
+nodeBuiltinImport_skipFile from 499 to 511
+nodeBuiltinImport_skipNextLine from 551 to 560
+nodeBuiltinImport_skipFile from 551 to 560
+nodeBuiltinImport_skipNextLine from 612 to 621
+nodeBuiltinImport_skipFile from 612 to 621

packages/harness-effect-v4/__snapshots__/diagnostics/nodeBuiltinImport.ts.output

@@ -25,8 +25,14 @@
 "node:child_process"
 13:22 - 13:42 | 0 | Prefer using ChildProcess from effect instead of the Node.js 'child_process' module.    effect(nodeBuiltinImport)
 
+"http"
+14:17 - 14:23 | 0 | Prefer using HttpClient from effect/unstable/http instead of the Node.js 'http' module.    effect(nodeBuiltinImport)
+
+"node:https"
+15:18 - 15:30 | 0 | Prefer using HttpClient from effect/unstable/http instead of the Node.js 'https' module.    effect(nodeBuiltinImport)
+
 "node:fs"
-16:7 - 16:16 | 0 | Prefer using FileSystem from effect instead of the Node.js 'fs' module.    effect(nodeBuiltinImport)
+18:7 - 18:16 | 0 | Prefer using FileSystem from effect instead of the Node.js 'fs' module.    effect(nodeBuiltinImport)
 
 "node:fs"
-19:20 - 19:29 | 0 | Prefer using FileSystem from effect instead of the Node.js 'fs' module.    effect(nodeBuiltinImport)
+21:20 - 21:29 | 0 | Prefer using FileSystem from effect instead of the Node.js 'fs' module.    effect(nodeBuiltinImport)

packages/harness-effect-v4/examples/diagnostics/nodeBuiltinImport.ts

@@ -11,6 +11,8 @@ import path from "node:path"
 import { join as join2 } from "path/posix"
 import { exec } from "child_process"
 import { spawn } from "node:child_process"
+import http from "http"
+import https from "node:https"
 
 // Flagged: side-effect import
 import "node:fs"
@@ -22,9 +24,6 @@ const fs3 = require("node:fs")
 // @ts-expect-error - @effect/platform not installed in harness
 import { FileSystem } from "@effect/platform"
 
-// Not flagged: unrelated Node built-ins
-import http from "http"
-
 // Not flagged: third-party modules with similar names
 // @ts-expect-error - fs-extra not installed in harness
 import fsExtra from "fs-extra"

packages/language-service/src/diagnostics/nodeBuiltinImport.ts

@@ -15,7 +15,11 @@ const moduleAlternativesV3 = new Map<string, { alternative: string; module: stri
   ["path/win32", { alternative: "Path", module: "path", package: "@effect/platform" }],
   ["node:path/win32", { alternative: "Path", module: "path", package: "@effect/platform" }],
   ["child_process", { alternative: "CommandExecutor", module: "child_process", package: "@effect/platform" }],
-  ["node:child_process", { alternative: "CommandExecutor", module: "child_process", package: "@effect/platform" }]
+  ["node:child_process", { alternative: "CommandExecutor", module: "child_process", package: "@effect/platform" }],
+  ["http", { alternative: "HttpClient", module: "http", package: "@effect/platform" }],
+  ["node:http", { alternative: "HttpClient", module: "http", package: "@effect/platform" }],
+  ["https", { alternative: "HttpClient", module: "https", package: "@effect/platform" }],
+  ["node:https", { alternative: "HttpClient", module: "https", package: "@effect/platform" }]
 ])
 
 const moduleAlternativesV4 = new Map<string, { alternative: string; module: string; package: string }>([
@@ -30,7 +34,11 @@ const moduleAlternativesV4 = new Map<string, { alternative: string; module: stri
   ["path/win32", { alternative: "Path", module: "path", package: "effect" }],
   ["node:path/win32", { alternative: "Path", module: "path", package: "effect" }],
   ["child_process", { alternative: "ChildProcess", module: "child_process", package: "effect" }],
-  ["node:child_process", { alternative: "ChildProcess", module: "child_process", package: "effect" }]
+  ["node:child_process", { alternative: "ChildProcess", module: "child_process", package: "effect" }],
+  ["http", { alternative: "HttpClient", module: "http", package: "effect/unstable/http" }],
+  ["node:http", { alternative: "HttpClient", module: "http", package: "effect/unstable/http" }],
+  ["https", { alternative: "HttpClient", module: "https", package: "effect/unstable/http" }],
+  ["node:https", { alternative: "HttpClient", module: "https", package: "effect/unstable/http" }]
 ])
 
 export const nodeBuiltinImport = LSP.createDiagnostic({