@effect/language-service 0.69.2 → 0.71.0

package/README.md

@@ -78,12 +78,13 @@ And you're done! You'll now be able to use a set of refactors and diagnostics th
 - Warn when using `Schema.Union` with multiple `Schema.Literal` calls that can be simplified to a single `Schema.Literal` call
 - Suggest using `Schema.TaggedStruct` instead of `Schema.Struct` when a `_tag` field with `Schema.Literal` is present to make the tag optional in the constructor
 - Warn when using `yield* Effect.fail()` with yieldable error types that can be yielded directly
-- Warn when using `Effect.fail` with the global `Error` type, recommending tagged errors
+- Warn when the global `Error` type is used in an Effect failure channel, recommending tagged errors
 - Warn when `Layer.mergeAll` contains layers with interdependencies (where one layer provides a service that another layer in the same call requires)
 - Suggest using `Effect.fn` for functions that return `Effect.gen` for better tracing and concise syntax
 - Warn when `Effect.fn` or `Effect.fnUntraced` is used as an IIFE (Immediately Invoked Function Expression), suggesting `Effect.gen` instead
 - Suggest removing redundant identifier argument when it equals the tag value in `Schema.TaggedClass`, `Schema.TaggedError`, or `Schema.TaggedRequest`
 - Suggest using `Schema.is` instead of `instanceof` for Effect Schema types
+- Suggest using `Effect.void` instead of `Effect.succeed(undefined)` or `Effect.succeed(void 0)`
 
 ### Completions
 

package/cli.js

@@ -30214,7 +30214,7 @@ var runMain3 = runMain2;
 // package.json
 var package_default = {
   name: "@effect/language-service",
-  version: "0.69.2",
+  version: "0.71.0",
   packageManager: "pnpm@8.11.0",
   publishConfig: {
     access: "public",
@@ -36899,6 +36899,57 @@ var effectMapVoid = createDiagnostic({
   })
 });
 
+// src/diagnostics/effectSucceedWithVoid.ts
+var effectSucceedWithVoid = createDiagnostic({
+  name: "effectSucceedWithVoid",
+  code: 47,
+  description: "Suggests using Effect.void instead of Effect.succeed(undefined) or Effect.succeed(void 0)",
+  severity: "suggestion",
+  apply: fn2("effectSucceedWithVoid.apply")(function* (sourceFile, report) {
+    const ts = yield* service2(TypeScriptApi);
+    const typeParser = yield* service2(TypeParser);
+    const tsUtils = yield* service2(TypeScriptUtils);
+    const nodeToVisit = [];
+    const appendNodeToVisit = (node) => {
+      nodeToVisit.push(node);
+      return void 0;
+    };
+    ts.forEachChild(sourceFile, appendNodeToVisit);
+    while (nodeToVisit.length > 0) {
+      const node = nodeToVisit.shift();
+      ts.forEachChild(node, appendNodeToVisit);
+      if (ts.isCallExpression(node)) {
+        const isSucceedCall = yield* pipe(
+          typeParser.isNodeReferenceToEffectModuleApi("succeed")(node.expression),
+          option5
+        );
+        if (isSome2(isSucceedCall)) {
+          const argument = node.arguments[0];
+          if (!argument) continue;
+          if (!tsUtils.isVoidExpression(argument)) continue;
+          report({
+            location: node,
+            messageText: "Effect.void can be used instead of Effect.succeed(undefined) or Effect.succeed(void 0)",
+            fixes: [{
+              fixName: "effectSucceedWithVoid_fix",
+              description: "Replace with Effect.void",
+              apply: gen3(function* () {
+                const changeTracker = yield* service2(ChangeTracker);
+                const effectModuleIdentifier = tsUtils.findImportedModuleIdentifierByPackageAndNameOrBarrel(sourceFile, "effect", "Effect") || "Effect";
+                const newNode = ts.factory.createPropertyAccessExpression(
+                  ts.factory.createIdentifier(effectModuleIdentifier),
+                  ts.factory.createIdentifier("void")
+                );
+                changeTracker.replaceNode(sourceFile, node, newNode);
+              })
+            }]
+          });
+        }
+      }
+    }
+  })
+});
+
 // src/diagnostics/floatingEffect.ts
 var floatingEffect = createDiagnostic({
   name: "floatingEffect",
@@ -37042,8 +37093,7 @@ var globalErrorInEffectCatch = createDiagnostic({
                   );
                   report({
                     location: node.expression,
-                    messageText: `The 'catch' callback in ${nodeText} returns the global Error type. It's not recommended to use the global Error type in Effect failures as they can get merged together.
-Instead, use tagged errors or custom errors with a discriminator property to get properly type-checked errors.`,
+                    messageText: `The 'catch' callback in ${nodeText} returns global 'Error', which loses type safety as untagged errors merge together. Consider using a tagged error and optionally wrapping the original in a 'cause' property.`,
                     fixes: []
                   });
                 }
@@ -37060,7 +37110,7 @@ Instead, use tagged errors or custom errors with a discriminator property to get
 var globalErrorInEffectFailure = createDiagnostic({
   name: "globalErrorInEffectFailure",
   code: 35,
-  description: "Warns when Effect.fail is called with the global Error type",
+  description: "Warns when the global Error type is used in an Effect failure channel",
   severity: "warning",
   apply: fn2("globalErrorInEffectFailure.apply")(function* (sourceFile, report) {
     const ts = yield* service2(TypeScriptApi);
@@ -37075,27 +37125,35 @@ var globalErrorInEffectFailure = createDiagnostic({
     while (nodeToVisit.length > 0) {
       const node = nodeToVisit.shift();
       ts.forEachChild(node, appendNodeToVisit);
-      if (ts.isCallExpression(node)) {
-        yield* pipe(
-          typeParser.isNodeReferenceToEffectModuleApi("fail")(node.expression),
-          flatMap18(() => {
-            if (node.arguments.length > 0) {
-              const failArgument = node.arguments[0];
-              const argumentType = typeCheckerUtils.getTypeAtLocation(failArgument);
-              if (argumentType && typeCheckerUtils.isGlobalErrorType(argumentType)) {
-                return sync11(
-                  () => report({
-                    location: node,
-                    messageText: `Effect.fail is called with the global Error type. It's not recommended to use the global Error type in Effect failures as they can get merged together. Instead, use tagged errors or custom errors with a discriminator property to get properly type-checked errors.`,
-                    fixes: []
-                  })
-                );
+      if (ts.isNewExpression(node)) {
+        const newExpressionType = typeCheckerUtils.getTypeAtLocation(node);
+        if (!newExpressionType || !typeCheckerUtils.isGlobalErrorType(newExpressionType)) {
+          continue;
+        }
+        let current = node.parent;
+        while (current) {
+          const currentType = typeCheckerUtils.getTypeAtLocation(current);
+          if (currentType) {
+            const effectTypeResult = yield* pipe(
+              typeParser.effectType(currentType, current),
+              option5
+            );
+            if (effectTypeResult._tag === "Some") {
+              const effectType = effectTypeResult.value;
+              const failureMembers = typeCheckerUtils.unrollUnionMembers(effectType.E);
+              const hasGlobalError = failureMembers.some((member) => typeCheckerUtils.isGlobalErrorType(member));
+              if (hasGlobalError) {
+                report({
+                  location: node,
+                  messageText: `Global 'Error' loses type safety as untagged errors merge together in the Effect failure channel. Consider using a tagged error and optionally wrapping the original in a 'cause' property.`,
+                  fixes: []
+                });
               }
+              break;
             }
-            return void_8;
-          }),
-          ignore3
-        );
+          }
+          current = current.parent;
+        }
       }
     }
   })
@@ -37684,9 +37742,29 @@ var missedPipeableOpportunity = createDiagnostic({
             transformations: flow2.transformations.slice(0, firstPipeableIndex)
           });
           const afterTransformations = flow2.transformations.slice(pipeableEndIndex);
+          const getOriginalSubjectNode = () => {
+            if (firstPipeableIndex === 0) {
+              return flow2.subject.node;
+            }
+            let current = flow2.node;
+            for (let i = flow2.transformations.length; i > firstPipeableIndex; i--) {
+              const t = flow2.transformations[i - 1];
+              if (t.kind === "call" && ts.isCallExpression(current) && current.arguments.length > 0) {
+                current = current.arguments[0];
+              } else {
+                return void 0;
+              }
+            }
+            return current;
+          };
+          const originalSubjectNode = getOriginalSubjectNode();
+          const subjectText = originalSubjectNode ? sourceFile.text.slice(
+            ts.getTokenPosOfNode(originalSubjectNode, sourceFile),
+            originalSubjectNode.end
+          ).trim() : "";
           report({
             location: flow2.node,
-            messageText: `Nested function calls can be converted to pipeable style for better readability.`,
+            messageText: `Nested function calls can be converted to pipeable style for better readability; consider using ${subjectText}.pipe(...) instead.`,
             fixes: [{
               fixName: "missedPipeableOpportunity_fix",
               description: "Convert to pipe style",
@@ -39741,6 +39819,7 @@ var diagnostics = [
   globalErrorInEffectFailure,
   layerMergeAllWithDependencies,
   effectMapVoid,
+  effectSucceedWithVoid,
   effectFnIife,
   effectFnOpportunity,
   redundantSchemaTagIdentifier,