@effect/tsgo 0.2.1 → 0.3.0

package/README.md

@@ -58,6 +58,7 @@ Some diagnostics are off by default or have a default severity of suggestion, bu
     <tr><td><code>globalErrorInEffectCatch</code></td><td>⚠️</td><td></td><td>Warns when catch callbacks return global Error type instead of typed errors</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>globalErrorInEffectFailure</code></td><td>⚠️</td><td></td><td>Warns when the global Error type is used in an Effect failure channel</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>layerMergeAllWithDependencies</code></td><td>⚠️</td><td>🔧</td><td>Detects interdependencies in Layer.mergeAll calls where one layer provides a service that another layer requires</td><td>✓</td><td>✓</td></tr>
+    <tr><td><code>lazyPromiseInEffectSync</code></td><td>⚠️</td><td></td><td>Warns when Effect.sync lazily returns a Promise instead of using an async Effect constructor</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>leakingRequirements</code></td><td>💡</td><td></td><td>Detects implementation services leaked in service methods</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>multipleEffectProvide</code></td><td>⚠️</td><td>🔧</td><td>Warns against chaining Effect.provide calls which can cause service lifecycle issues</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>returnEffectInGen</code></td><td>💡</td><td>🔧</td><td>Warns when returning an Effect in a generator causes nested Effect&lt;Effect&lt;...&gt;&gt;</td><td>✓</td><td>✓</td></tr>
@@ -68,6 +69,9 @@ Some diagnostics are off by default or have a default severity of suggestion, bu
     <tr><td><code>tryCatchInEffectGen</code></td><td>💡</td><td></td><td>Discourages try/catch in Effect generators in favor of Effect error handling</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>unknownInEffectCatch</code></td><td>⚠️</td><td></td><td>Warns when catch callbacks return unknown instead of typed errors</td><td>✓</td><td>✓</td></tr>
     <tr><td colspan="6"><strong>Effect-native</strong> <em>Prefer Effect-native APIs and abstractions when available.</em></td></tr>
+    <tr><td><code>asyncFunction</code></td><td>➖</td><td></td><td>Warns when declaring async functions and suggests using Effect values and Effect.gen for async control flow</td><td>✓</td><td>✓</td></tr>
+    <tr><td><code>cryptoRandomUUID</code></td><td>➖</td><td></td><td>Warns when using crypto.randomUUID() outside Effect generators instead of the Effect Random module, which uses Effect-injected randomness rather than the crypto module behind the scenes</td><td></td><td>✓</td></tr>
+    <tr><td><code>cryptoRandomUUIDInEffect</code></td><td>➖</td><td></td><td>Warns when using crypto.randomUUID() inside Effect generators instead of the Effect Random module, which uses Effect-injected randomness rather than the crypto module behind the scenes</td><td></td><td>✓</td></tr>
     <tr><td><code>extendsNativeError</code></td><td>➖</td><td></td><td>Warns when a class directly extends the native Error class</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>globalConsole</code></td><td>➖</td><td></td><td>Warns when using console methods outside Effect generators instead of Effect.log/Logger</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>globalConsoleInEffect</code></td><td>➖</td><td></td><td>Warns when using console methods inside Effect generators instead of Effect.log/Logger</td><td>✓</td><td>✓</td></tr>
@@ -80,21 +84,28 @@ Some diagnostics are off by default or have a default severity of suggestion, bu
     <tr><td><code>globalTimers</code></td><td>➖</td><td></td><td>Warns when using setTimeout/setInterval outside Effect generators instead of Effect.sleep/Schedule</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>globalTimersInEffect</code></td><td>➖</td><td></td><td>Warns when using setTimeout/setInterval inside Effect generators instead of Effect.sleep/Schedule</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>instanceOfSchema</code></td><td>➖</td><td>🔧</td><td>Suggests using Schema.is instead of instanceof for Effect Schema types</td><td>✓</td><td>✓</td></tr>
+    <tr><td><code>newPromise</code></td><td>➖</td><td></td><td>Warns when constructing promises with new Promise instead of using Effect APIs</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>nodeBuiltinImport</code></td><td>➖</td><td></td><td>Warns when importing Node.js built-in modules that have Effect-native counterparts</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>preferSchemaOverJson</code></td><td>💡</td><td></td><td>Suggests using Effect Schema for JSON operations instead of JSON.parse/JSON.stringify</td><td>✓</td><td>✓</td></tr>
+    <tr><td><code>processEnv</code></td><td>➖</td><td></td><td>Warns when reading process.env outside Effect generators instead of using Effect Config</td><td>✓</td><td>✓</td></tr>
+    <tr><td><code>processEnvInEffect</code></td><td>➖</td><td></td><td>Warns when reading process.env inside Effect generators instead of using Effect Config</td><td>✓</td><td>✓</td></tr>
     <tr><td colspan="6"><strong>Style</strong> <em>Cleanup, consistency, and idiomatic Effect code.</em></td></tr>
     <tr><td><code>catchAllToMapError</code></td><td>💡</td><td>🔧</td><td>Suggests using Effect.mapError instead of Effect.catch + Effect.fail</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>deterministicKeys</code></td><td>➖</td><td>🔧</td><td>Enforces deterministic naming for service/tag/error identifiers based on class names</td><td>✓</td><td>✓</td></tr>
+    <tr><td><code>effectDoNotation</code></td><td>➖</td><td></td><td>Suggests using Effect.gen or Effect.fn instead of the Effect.Do notation helpers</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>effectFnOpportunity</code></td><td>💡</td><td>🔧</td><td>Suggests using Effect.fn for functions that return an Effect</td><td>✓</td><td>✓</td></tr>
+    <tr><td><code>effectMapFlatten</code></td><td>💡</td><td></td><td>Suggests using Effect.flatMap instead of Effect.map followed by Effect.flatten in piping flows</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>effectMapVoid</code></td><td>💡</td><td>🔧</td><td>Suggests using Effect.asVoid instead of Effect.map(() =&gt; void 0), Effect.map(() =&gt; undefined), or Effect.map(() =&gt; {})</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>effectSucceedWithVoid</code></td><td>💡</td><td>🔧</td><td>Suggests using Effect.void instead of Effect.succeed(undefined) or Effect.succeed(void 0)</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>missedPipeableOpportunity</code></td><td>➖</td><td>🔧</td><td>Suggests using .pipe() for nested function calls</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>missingEffectServiceDependency</code></td><td>➖</td><td></td><td>Checks that Effect.Service dependencies satisfy all required layer inputs</td><td>✓</td><td></td></tr>
+    <tr><td><code>nestedEffectGenYield</code></td><td>➖</td><td></td><td>Warns when yielding a nested bare Effect.gen inside an existing Effect generator context</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>redundantSchemaTagIdentifier</code></td><td>💡</td><td>🔧</td><td>Suggests removing redundant identifier argument when it equals the tag value in Schema.TaggedClass/TaggedError/TaggedRequest</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>schemaStructWithTag</code></td><td>💡</td><td>🔧</td><td>Suggests using Schema.TaggedStruct instead of Schema.Struct with _tag field</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>schemaUnionOfLiterals</code></td><td>➖</td><td>🔧</td><td>Suggests combining multiple Schema.Literal calls in Schema.Union into a single Schema.Literal</td><td>✓</td><td></td></tr>
     <tr><td><code>serviceNotAsClass</code></td><td>➖</td><td>🔧</td><td>Warns when ServiceMap.Service is used as a variable instead of a class declaration</td><td></td><td>✓</td></tr>
     <tr><td><code>strictBooleanExpressions</code></td><td>➖</td><td></td><td>Enforces boolean types in conditional expressions for type safety</td><td>✓</td><td>✓</td></tr>
+    <tr><td><code>unnecessaryArrowBlock</code></td><td>➖</td><td>🔧</td><td>Suggests using a concise arrow body when the block only returns an expression</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>unnecessaryEffectGen</code></td><td>💡</td><td>🔧</td><td>Suggests removing Effect.gen when it contains only a single return statement</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>unnecessaryFailYieldableError</code></td><td>💡</td><td>🔧</td><td>Suggests yielding yieldable errors directly instead of wrapping with Effect.fail</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>unnecessaryPipe</code></td><td>💡</td><td>🔧</td><td>Removes pipe calls with no arguments</td><td>✓</td><td>✓</td></tr>
@@ -197,6 +208,8 @@ Each release of `effect-tsgo` is built against a specific upstream `tsgo` commit
         "quickinfo": true,
         // Controls Effect completions. (default: true)
         "completions": true,
+        // Enables additional debug-only Effect language service output. (default: false)
+        "debug": false,
         // Controls Effect goto references support. (default: true)
         "goto": true,
         // Controls Effect rename helpers. (default: true)

package/dist/effect-tsgo.js

@@ -197377,7 +197377,7 @@ var FileReadError = class extends TaggedError("FileReadError") {
 //#endregion
 //#region package.json
 var name = "@effect/tsgo";
-var version = "0.2.1";
+var version = "0.3.0";
 
 //#endregion
 //#region src/setup/consts.ts
@@ -198207,6 +198207,9 @@ var presets$1 = [{
 	"name": "effect-native",
 	"description": "Enable all Effect-native diagnostics at warning level.",
 	"diagnosticSeverity": {
+		"asyncFunction": "warning",
+		"cryptoRandomUUID": "warning",
+		"cryptoRandomUUIDInEffect": "warning",
 		"extendsNativeError": "warning",
 		"globalConsole": "warning",
 		"globalConsoleInEffect": "warning",
@@ -198219,8 +198222,11 @@ var presets$1 = [{
 		"globalTimers": "warning",
 		"globalTimersInEffect": "warning",
 		"instanceOfSchema": "warning",
+		"newPromise": "warning",
 		"nodeBuiltinImport": "warning",
-		"preferSchemaOverJson": "warning"
+		"preferSchemaOverJson": "warning",
+		"processEnv": "warning",
+		"processEnvInEffect": "warning"
 	}
 }];
 var rules = [
@@ -198614,6 +198620,23 @@ var rules = [
 			}]
 		}
 	},
+	{
+		"name": "lazyPromiseInEffectSync",
+		"group": "antipattern",
+		"description": "Warns when Effect.sync lazily returns a Promise instead of using an async Effect constructor",
+		"defaultSeverity": "warning",
+		"fixable": false,
+		"supportedEffect": ["v3", "v4"],
+		"codes": [377082],
+		"preview": {
+			"sourceText": "import { Effect } from \"effect\"\n\nexport const preview = Effect.sync(() => Promise.resolve(1))\n",
+			"diagnostics": [{
+				"start": 68,
+				"end": 92,
+				"text": "This `Effect.sync` thunk returns a Promise. Use `Effect.promise` or `Effect.tryPromise` to represent async work. effect(lazyPromiseInEffectSync)"
+			}]
+		}
+	},
 	{
 		"name": "leakingRequirements",
 		"group": "antipattern",
@@ -198771,6 +198794,57 @@ var rules = [
 			}]
 		}
 	},
+	{
+		"name": "asyncFunction",
+		"group": "effectNative",
+		"description": "Warns when declaring async functions and suggests using Effect values and Effect.gen for async control flow",
+		"defaultSeverity": "off",
+		"fixable": false,
+		"supportedEffect": ["v3", "v4"],
+		"codes": [377081],
+		"preview": {
+			"sourceText": "\nexport const preview = async () => {\n  await Promise.resolve(1)\n}\n",
+			"diagnostics": [{
+				"start": 24,
+				"end": 37,
+				"text": "This code declares an async function, consider representing this async control flow with Effect values and `Effect.gen`. effect(asyncFunction)"
+			}]
+		}
+	},
+	{
+		"name": "cryptoRandomUUID",
+		"group": "effectNative",
+		"description": "Warns when using crypto.randomUUID() outside Effect generators instead of the Effect Random module, which uses Effect-injected randomness rather than the crypto module behind the scenes",
+		"defaultSeverity": "off",
+		"fixable": false,
+		"supportedEffect": ["v4"],
+		"codes": [377078],
+		"preview": {
+			"sourceText": "\nexport const preview = crypto.randomUUID()\n",
+			"diagnostics": [{
+				"start": 24,
+				"end": 43,
+				"text": "This code uses `crypto.randomUUID()`, prefer the Effect `Random` module instead because it uses Effect-injected randomness rather than the `crypto` module behind the scenes. effect(cryptoRandomUUID)"
+			}]
+		}
+	},
+	{
+		"name": "cryptoRandomUUIDInEffect",
+		"group": "effectNative",
+		"description": "Warns when using crypto.randomUUID() inside Effect generators instead of the Effect Random module, which uses Effect-injected randomness rather than the crypto module behind the scenes",
+		"defaultSeverity": "off",
+		"fixable": false,
+		"supportedEffect": ["v4"],
+		"codes": [377079],
+		"preview": {
+			"sourceText": "import { Effect } from \"effect\"\n\nexport const preview = Effect.gen(function*() {\n  return crypto.randomUUID()\n})\n",
+			"diagnostics": [{
+				"start": 90,
+				"end": 109,
+				"text": "This Effect code uses `crypto.randomUUID()`, prefer the Effect `Random` module instead because it uses Effect-injected randomness rather than the `crypto` module behind the scenes. effect(cryptoRandomUUIDInEffect)"
+			}]
+		}
+	},
 	{
 		"name": "extendsNativeError",
 		"group": "effectNative",
@@ -198971,6 +199045,23 @@ var rules = [
 			}]
 		}
 	},
+	{
+		"name": "newPromise",
+		"group": "effectNative",
+		"description": "Warns when constructing promises with new Promise instead of using Effect APIs",
+		"defaultSeverity": "off",
+		"fixable": false,
+		"supportedEffect": ["v3", "v4"],
+		"codes": [377080],
+		"preview": {
+			"sourceText": "\nexport const preview = new Promise<number>((resolve) => resolve(1))\n",
+			"diagnostics": [{
+				"start": 24,
+				"end": 68,
+				"text": "This code constructs `new Promise(...)`, prefer Effect APIs such as `Effect.async`, `Effect.promise`, or `Effect.tryPromise` instead of manual Promise construction. effect(newPromise)"
+			}]
+		}
+	},
 	{
 		"name": "nodeBuiltinImport",
 		"group": "effectNative",
@@ -199005,6 +199096,40 @@ var rules = [
 			}]
 		}
 	},
+	{
+		"name": "processEnv",
+		"group": "effectNative",
+		"description": "Warns when reading process.env outside Effect generators instead of using Effect Config",
+		"defaultSeverity": "off",
+		"fixable": false,
+		"supportedEffect": ["v3", "v4"],
+		"codes": [377076],
+		"preview": {
+			"sourceText": "/// <reference types=\"node\" />\n\nexport const preview = process.env.PORT\n",
+			"diagnostics": [{
+				"start": 55,
+				"end": 71,
+				"text": "This code reads from `process.env`, environment configuration is represented through `Config` from Effect. effect(processEnv)"
+			}]
+		}
+	},
+	{
+		"name": "processEnvInEffect",
+		"group": "effectNative",
+		"description": "Warns when reading process.env inside Effect generators instead of using Effect Config",
+		"defaultSeverity": "off",
+		"fixable": false,
+		"supportedEffect": ["v3", "v4"],
+		"codes": [377077],
+		"preview": {
+			"sourceText": "/// <reference types=\"node\" />\nimport { Effect } from \"effect\"\n\nexport const preview = Effect.gen(function*() {\n  return process.env.PORT\n})\n",
+			"diagnostics": [{
+				"start": 121,
+				"end": 137,
+				"text": "This Effect code reads from `process.env`, environment configuration in Effect code is represented through `Config` from Effect. effect(processEnvInEffect)"
+			}]
+		}
+	},
 	{
 		"name": "catchAllToMapError",
 		"group": "style",
@@ -199039,6 +199164,23 @@ var rules = [
 			}]
 		}
 	},
+	{
+		"name": "effectDoNotation",
+		"group": "style",
+		"description": "Suggests using Effect.gen or Effect.fn instead of the Effect.Do notation helpers",
+		"defaultSeverity": "off",
+		"fixable": false,
+		"supportedEffect": ["v3", "v4"],
+		"codes": [377085],
+		"preview": {
+			"sourceText": "import { Effect } from \"effect\"\nimport { pipe } from \"effect/Function\"\n\nexport const preview = pipe(\n  Effect.Do,\n  Effect.bind(\"a\", () => Effect.succeed(1)),\n  Effect.let(\"b\", ({ a }) => a + 1),\n  Effect.bind(\"c\", ({ b }) => Effect.succeed(b.toString()))\n)\n",
+			"diagnostics": [{
+				"start": 103,
+				"end": 112,
+				"text": "This uses the Effect do emulation. `Effect.gen` or `Effect.fn` achieve the same result with native JS scopes. effect(effectDoNotation)"
+			}]
+		}
+	},
 	{
 		"name": "effectFnOpportunity",
 		"group": "style",
@@ -199056,6 +199198,23 @@ var rules = [
 			}]
 		}
 	},
+	{
+		"name": "effectMapFlatten",
+		"group": "style",
+		"description": "Suggests using Effect.flatMap instead of Effect.map followed by Effect.flatten in piping flows",
+		"defaultSeverity": "suggestion",
+		"fixable": false,
+		"supportedEffect": ["v3", "v4"],
+		"codes": [377086],
+		"preview": {
+			"sourceText": "import { Effect } from \"effect\"\n\nexport const preview = Effect.succeed(1).pipe(\n  Effect.map((n) => Effect.succeed(n + 1)),\n  Effect.flatten\n)\n",
+			"diagnostics": [{
+				"start": 126,
+				"end": 140,
+				"text": "`Effect.map` + `Effect.flatten` is the same as `Effect.flatMap` that expresses the same steps more directly. effect(effectMapFlatten)"
+			}]
+		}
+	},
 	{
 		"name": "effectMapVoid",
 		"group": "style",
@@ -199124,6 +199283,23 @@ var rules = [
 			}]
 		}
 	},
+	{
+		"name": "nestedEffectGenYield",
+		"group": "style",
+		"description": "Warns when yielding a nested bare Effect.gen inside an existing Effect generator context",
+		"defaultSeverity": "off",
+		"fixable": false,
+		"supportedEffect": ["v3", "v4"],
+		"codes": [377083],
+		"preview": {
+			"sourceText": "import { Effect } from \"effect\"\n\nexport const preview = Effect.gen(function*() {\n	yield* Effect.gen(function*() {\n		return 1\n	})\n})\n",
+			"diagnostics": [{
+				"start": 89,
+				"end": 128,
+				"text": "This `yield*` is applied to a nested `Effect.gen(...)` that can be inlined in the parent Effect generator context. effect(nestedEffectGenYield)"
+			}]
+		}
+	},
 	{
 		"name": "redundantSchemaTagIdentifier",
 		"group": "style",
@@ -199213,6 +199389,23 @@ var rules = [
 			}]
 		}
 	},
+	{
+		"name": "unnecessaryArrowBlock",
+		"group": "style",
+		"description": "Suggests using a concise arrow body when the block only returns an expression",
+		"defaultSeverity": "off",
+		"fixable": true,
+		"supportedEffect": ["v3", "v4"],
+		"codes": [377084],
+		"preview": {
+			"sourceText": "export const preview = (value: string) => {\n	return value.trim()\n}\n",
+			"diagnostics": [{
+				"start": 42,
+				"end": 66,
+				"text": "This arrow function block only returns an expression and can use a concise body. effect(unnecessaryArrowBlock)"
+			}]
+		}
+	},
 	{
 		"name": "unnecessaryEffectGen",
 		"group": "style",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effect/tsgo",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Effect Language Service for TypeScript-Go — Effect-specific diagnostics and hover features.",
   "license": "MIT",
   "repository": {
@@ -22,13 +22,13 @@
     "README.md"
   ],
   "optionalDependencies": {
-    "@effect/tsgo-win32-x64": "0.2.1",
-    "@effect/tsgo-win32-arm64": "0.2.1",
-    "@effect/tsgo-linux-x64": "0.2.1",
-    "@effect/tsgo-linux-arm64": "0.2.1",
-    "@effect/tsgo-linux-arm": "0.2.1",
-    "@effect/tsgo-darwin-x64": "0.2.1",
-    "@effect/tsgo-darwin-arm64": "0.2.1"
+    "@effect/tsgo-win32-x64": "0.3.0",
+    "@effect/tsgo-win32-arm64": "0.3.0",
+    "@effect/tsgo-linux-x64": "0.3.0",
+    "@effect/tsgo-linux-arm64": "0.3.0",
+    "@effect/tsgo-linux-arm": "0.3.0",
+    "@effect/tsgo-darwin-x64": "0.3.0",
+    "@effect/tsgo-darwin-arm64": "0.3.0"
   },
   "devDependencies": {
     "@effect/platform-node": "^4.0.0-beta.40",