@effect/language-service 0.53.2 → 0.54.0

package/README.md

@@ -69,6 +69,7 @@ And you're done! You'll now be able to use a set of refactors and diagnostics th
 - Warn when `@effect-diagnostics-next-line` comments have no effect (i.e., they don't suppress any diagnostic)
 - Detect nested function calls that can be converted to pipeable style for better readability
 - Warn when using catch functions (`catchAll`, `catch`, `catchIf`, `catchSome`, `catchTag`, `catchTags`) on effects that never fail
+- Warn when catch callbacks in `Effect.tryPromise`, `Effect.tryMap`, or `Effect.tryMapPromise` return `unknown` or `any` types
 
 ### Completions
 

package/cli.js

@@ -35288,6 +35288,63 @@ var tryCatchInEffectGen = createDiagnostic({
   })
 });
 
+// src/diagnostics/unknownInEffectCatch.ts
+var unknownInEffectCatch = createDiagnostic({
+  name: "unknownInEffectCatch",
+  code: 31,
+  severity: "warning",
+  apply: fn2("unknownInEffectCatch.apply")(function* (sourceFile, report) {
+    const ts = yield* service2(TypeScriptApi);
+    const typeParser = yield* service2(TypeParser);
+    const typeChecker = yield* service2(TypeCheckerApi);
+    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 isEffectWithCatch = yield* pipe(
+          typeParser.isNodeReferenceToEffectModuleApi("tryPromise")(node.expression),
+          orElse14(() => typeParser.isNodeReferenceToEffectModuleApi("try")(node.expression)),
+          orElse14(() => typeParser.isNodeReferenceToEffectModuleApi("tryMap")(node.expression)),
+          orElse14(() => typeParser.isNodeReferenceToEffectModuleApi("tryMapPromise")(node.expression)),
+          orElse14(() => void_8)
+        );
+        if (isEffectWithCatch) {
+          const signature = typeChecker.getResolvedSignature(node);
+          if (signature) {
+            const objectType = typeChecker.getParameterType(signature, 0);
+            const catchFunctionSymbol = typeChecker.getPropertyOfType(objectType, "catch");
+            if (catchFunctionSymbol) {
+              const catchFunctionType = typeChecker.getTypeOfSymbolAtLocation(catchFunctionSymbol, node);
+              const signatures = typeChecker.getSignaturesOfType(catchFunctionType, ts.SignatureKind.Call);
+              if (signatures.length > 0) {
+                const returnType = typeChecker.getReturnTypeOfSignature(signatures[0]);
+                if (returnType && (returnType.flags & ts.TypeFlags.Unknown || returnType.flags & ts.TypeFlags.Any)) {
+                  const nodeText = sourceFile.text.substring(
+                    ts.getTokenPosOfNode(node.expression, sourceFile),
+                    node.expression.end
+                  );
+                  report({
+                    location: node.expression,
+                    messageText: `The 'catch' callback in ${nodeText} returns 'unknown'. The catch callback should be used to provide typed errors.
+Consider wrapping unknown errors into Effect's Data.TaggedError for example, or narrow down the type to the specific error raised.`,
+                    fixes: []
+                  });
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  })
+});
+
 // src/diagnostics/unnecessaryEffectGen.ts
 var unnecessaryEffectGen = createDiagnostic({
   name: "unnecessaryEffectGen",
@@ -35535,7 +35592,8 @@ var diagnostics = [
   nonObjectEffectServiceType,
   deterministicKeys,
   missedPipeableOpportunity,
-  strictEffectProvide
+  strictEffectProvide,
+  unknownInEffectCatch
 ];
 
 // src/cli/diagnostics.ts
@@ -35596,6 +35654,13 @@ var diagnostics2 = make58(
     }
     const filesToCheckArray = fromIterable(filesToCheck);
     const batches = chunksOf(filesToCheckArray, BATCH_SIZE);
+    let lastLanguageService;
+    const disposeIfLanguageServiceChanged = (languageService) => {
+      if (lastLanguageService !== languageService) {
+        lastLanguageService?.dispose();
+        lastLanguageService = languageService;
+      }
+    };
     for (const batch of batches) {
       const { service: service3 } = (0, import_project_service.createProjectService)({ options: { loadTypeScriptPlugins: false } });
       for (const filePath of batch) {
@@ -35605,6 +35670,7 @@ var diagnostics2 = make58(
           if (!scriptInfo) continue;
           const project4 = scriptInfo.getDefaultProject();
           const languageService = project4.getLanguageService(true);
+          disposeIfLanguageServiceChanged(languageService);
           const program = languageService.getProgram();
           if (!program) continue;
           const sourceFile = program.getSourceFile(filePath);
@@ -35621,7 +35687,7 @@ var diagnostics2 = make58(
             provideService7(TypeScriptApi, tsInstance),
             provideService7(
               LanguageServicePluginOptions,
-              parse4(pluginConfig)
+              { ...parse4(pluginConfig), diagnosticsName: false }
             ),
             run9,
             map((_) => _.diagnostics),
@@ -35637,11 +35703,14 @@ var diagnostics2 = make58(
           warningsCount += results.filter((_) => _.category === tsInstance.DiagnosticCategory.Warning).length;
           messagesCount += results.filter((_) => _.category === tsInstance.DiagnosticCategory.Message).length;
           if (results.length > 0) {
-            const formattedResults = tsInstance.formatDiagnosticsWithColorAndContext(results, {
+            let formattedResults = tsInstance.formatDiagnosticsWithColorAndContext(results, {
               getCanonicalFileName: (fileName) => path2.resolve(fileName),
               getCurrentDirectory: () => path2.resolve("."),
               getNewLine: () => "\n"
             });
+            Object.values(diagnostics).forEach(
+              (_) => formattedResults = formattedResults.replace(new RegExp(`TS${_.code}:`, "g"), `effect(${_.name}):`)
+            );
             console.log(formattedResults);
           }
         } finally {
@@ -35650,6 +35719,7 @@ var diagnostics2 = make58(
       }
       yield* yieldNow4();
     }
+    disposeIfLanguageServiceChanged(void 0);
     console.log(
       `Checked ${checkedFilesCount} files out of ${filesToCheck.size} files. 
 ${errorsCount} errors, ${warningsCount} warnings and ${messagesCount} messages.`
@@ -35782,7 +35852,7 @@ var getPatchesForModule = fn("getPatchesForModule")(
         sourceFile.text,
         insertCheckSourceFilePosition.value.position,
         insertCheckSourceFilePosition.value.position,
-        `effectLspPatchUtils().checkSourceFileWorker(${moduleName === "typescript" ? "module.exports" : "effectLspTypeScriptApis()"}, host, node, compilerOptions, diagnostics.add)
+        `effectLspPatchUtils().checkSourceFileWorker(${moduleName === "typescript" ? "module.exports" : "effectLspTypeScriptApis()"}, host, node, compilerOptions, diagnostics.add, "${moduleName}")
 `,
         "\n",
         version