@effect/language-service 0.31.2 → 0.33.0

package/index.js

@@ -1519,16 +1519,34 @@ function parseDiagnosticSeverity(config) {
     )
   );
 }
+var defaults = {
+  refactors: true,
+  diagnostics: true,
+  diagnosticSeverity: {},
+  quickinfo: true,
+  quickinfoEffectParameters: "whentruncated",
+  completions: true,
+  goto: true,
+  inlays: true,
+  allowedDuplicatedPackages: [],
+  namespaceImportPackages: [],
+  barrelImportPackages: [],
+  topLevelNamedReexports: "ignore"
+};
 function parse(config) {
   return {
-    diagnostics: isObject(config) && hasProperty(config, "diagnostics") && isBoolean(config.diagnostics) ? config.diagnostics : true,
-    diagnosticSeverity: isObject(config) && hasProperty(config, "diagnosticSeverity") && isRecord(config.diagnosticSeverity) ? parseDiagnosticSeverity(config.diagnosticSeverity) : {},
-    quickinfo: isObject(config) && hasProperty(config, "quickinfo") && isBoolean(config.quickinfo) ? config.quickinfo : true,
-    completions: isObject(config) && hasProperty(config, "completions") && isBoolean(config.completions) ? config.completions : true,
-    goto: isObject(config) && hasProperty(config, "goto") && isBoolean(config.goto) ? config.goto : true,
-    allowedDuplicatedPackages: isObject(config) && hasProperty(config, "allowedDuplicatedPackages") && isArray(config.allowedDuplicatedPackages) && config.allowedDuplicatedPackages.every(isString) ? config.allowedDuplicatedPackages.map((_) => _.toLowerCase()) : [],
-    namespaceImportPackages: isObject(config) && hasProperty(config, "namespaceImportPackages") && isArray(config.namespaceImportPackages) && config.namespaceImportPackages.every(isString) ? config.namespaceImportPackages.map((_) => _.toLowerCase()) : [],
-    barrelImportPackages: isObject(config) && hasProperty(config, "barrelImportPackages") && isArray(config.barrelImportPackages) && config.barrelImportPackages.every(isString) ? config.barrelImportPackages.map((_) => _.toLowerCase()) : []
+    refactors: isObject(config) && hasProperty(config, "refactors") && isBoolean(config.refactors) ? config.refactors : defaults.refactors,
+    diagnostics: isObject(config) && hasProperty(config, "diagnostics") && isBoolean(config.diagnostics) ? config.diagnostics : defaults.diagnostics,
+    diagnosticSeverity: isObject(config) && hasProperty(config, "diagnosticSeverity") && isRecord(config.diagnosticSeverity) ? parseDiagnosticSeverity(config.diagnosticSeverity) : defaults.diagnosticSeverity,
+    quickinfo: isObject(config) && hasProperty(config, "quickinfo") && isBoolean(config.quickinfo) ? config.quickinfo : defaults.quickinfo,
+    quickinfoEffectParameters: isObject(config) && hasProperty(config, "quickinfoEffectParameters") && isString(config.quickinfoEffectParameters) && ["always", "never", "whentruncated"].includes(config.quickinfoEffectParameters.toLowerCase()) ? config.quickinfoEffectParameters.toLowerCase() : defaults.quickinfoEffectParameters,
+    completions: isObject(config) && hasProperty(config, "completions") && isBoolean(config.completions) ? config.completions : defaults.completions,
+    goto: isObject(config) && hasProperty(config, "goto") && isBoolean(config.goto) ? config.goto : defaults.goto,
+    inlays: isObject(config) && hasProperty(config, "inlays") && isBoolean(config.inlays) ? config.inlays : defaults.inlays,
+    allowedDuplicatedPackages: isObject(config) && hasProperty(config, "allowedDuplicatedPackages") && isArray(config.allowedDuplicatedPackages) && config.allowedDuplicatedPackages.every(isString) ? config.allowedDuplicatedPackages.map((_) => _.toLowerCase()) : defaults.allowedDuplicatedPackages,
+    namespaceImportPackages: isObject(config) && hasProperty(config, "namespaceImportPackages") && isArray(config.namespaceImportPackages) && config.namespaceImportPackages.every(isString) ? config.namespaceImportPackages.map((_) => _.toLowerCase()) : defaults.namespaceImportPackages,
+    barrelImportPackages: isObject(config) && hasProperty(config, "barrelImportPackages") && isArray(config.barrelImportPackages) && config.barrelImportPackages.every(isString) ? config.barrelImportPackages.map((_) => _.toLowerCase()) : defaults.barrelImportPackages,
+    topLevelNamedReexports: isObject(config) && hasProperty(config, "topLevelNamedReexports") && isString(config.topLevelNamedReexports) && ["ignore", "follow"].includes(config.topLevelNamedReexports.toLowerCase()) ? config.topLevelNamedReexports.toLowerCase() : defaults.topLevelNamedReexports
   };
 }
 
@@ -3599,9 +3617,11 @@ var floatingEffect = createDiagnostic({
           option
         );
         if (isNone2(allowedFloatingEffects)) {
+          const isStrictEffect = yield* option(typeParser.strictEffectType(type, node.expression));
+          const name = isSome2(isStrictEffect) ? "Effect" : "Effect-able " + typeChecker.typeToString(type);
           report({
             location: node,
-            messageText: `Effect must be yielded or assigned to a variable.`,
+            messageText: `${name} must be yielded or assigned to a variable.`,
             fixes: []
           });
         }
@@ -4228,7 +4248,7 @@ var missingReturnYieldStar = createDiagnostic({
                 }] : [];
                 report({
                   location: node,
-                  messageText: `Yielded Effect never succeeds, so it is best to use a 'return yield*' instead.`,
+                  messageText: `It is recommended to use return yield* for Effects that never succeed to signal a definitive exit point for type narrowing and tooling support.`,
                   fixes: fix
                 });
               }
@@ -5307,6 +5327,7 @@ var makeAutoImportProvider = fn("TypeScriptApi")(function* (fromSourceFile) {
     }
   }
   const mapFromBarrelToNamespace = /* @__PURE__ */ new Map();
+  const mapFromBarrelToBarrel = /* @__PURE__ */ new Map();
   const mapFromNamespaceToBarrel = /* @__PURE__ */ new Map();
   const mapFilenameToModuleAlias = /* @__PURE__ */ new Map();
   const mapFilenameToExportExcludes = /* @__PURE__ */ new Map();
@@ -5327,7 +5348,7 @@ var makeAutoImportProvider = fn("TypeScriptApi")(function* (fromSourceFile) {
     mapFilenameToModuleName.set(realPath, absoluteName);
   };
   const collectImportCache = fn("TypeScriptApi")(
-    function* (packagePatterns, kind) {
+    function* (packagePatterns, kind, topLevelNamedReexports) {
       for (const packagePattern of packagePatterns) {
         const packageNames = tsUtils.resolveModulePattern(fromSourceFile, packagePattern);
         for (const packageName of packageNames) {
@@ -5377,11 +5398,28 @@ var makeAutoImportProvider = fn("TypeScriptApi")(function* (fromSourceFile) {
             }
             if (isPackageRoot) {
               for (const namedExport of reExports.namedExports) {
-                mapFilenameToExportExcludes.set(barrelSourceFile.fileName, [
-                  ...mapFilenameToExportExcludes.get(barrelSourceFile.fileName) || [],
-                  namedExport.name
-                ]);
-                break;
+                if (topLevelNamedReexports === "ignore") {
+                  mapFilenameToExportExcludes.set(barrelSourceFile.fileName, [
+                    ...mapFilenameToExportExcludes.get(barrelSourceFile.fileName) || [],
+                    namedExport.name
+                  ]);
+                } else if (topLevelNamedReexports === "follow") {
+                  const reexportedFile = ts.resolveModuleName(
+                    namedExport.moduleSpecifier.text,
+                    barrelSourceFile.fileName,
+                    program.getCompilerOptions(),
+                    host
+                  );
+                  if (!reexportedFile) continue;
+                  if (!reexportedFile.resolvedModule) continue;
+                  mapFromBarrelToBarrel.set(barrelSourceFile.fileName, {
+                    ...mapFromBarrelToBarrel.get(barrelSourceFile.fileName) || {},
+                    [namedExport.name]: {
+                      fileName: reexportedFile.resolvedModule.resolvedFileName,
+                      exportName: namedExport.name
+                    }
+                  });
+                }
               }
             }
           }
@@ -5389,8 +5427,12 @@ var makeAutoImportProvider = fn("TypeScriptApi")(function* (fromSourceFile) {
       }
     }
   );
-  yield* collectImportCache(languageServicePluginOptions.namespaceImportPackages, "namespace");
-  yield* collectImportCache(languageServicePluginOptions.barrelImportPackages, "barrel");
+  yield* collectImportCache(
+    languageServicePluginOptions.namespaceImportPackages,
+    "namespace",
+    languageServicePluginOptions.topLevelNamedReexports
+  );
+  yield* collectImportCache(languageServicePluginOptions.barrelImportPackages, "barrel", "ignore");
   const resolveModuleName = (fileName) => {
     const fixedModuleName = mapFilenameToModuleName.get(fileName);
     if (fixedModuleName) return fixedModuleName;
@@ -5408,6 +5450,18 @@ var makeAutoImportProvider = fn("TypeScriptApi")(function* (fromSourceFile) {
   const resolve = (exportFileName, exportName) => {
     const excludedExports = mapFilenameToExportExcludes.get(exportFileName);
     if (excludedExports && excludedExports.includes(exportName)) return;
+    const mapToBarrelRewritten = mapFromBarrelToBarrel.get(exportFileName);
+    if (mapToBarrelRewritten && exportName in mapToBarrelRewritten) {
+      const reexportedFile = mapToBarrelRewritten[exportName];
+      if (reexportedFile) {
+        return {
+          _tag: "NamedImport",
+          fileName: reexportedFile.fileName,
+          moduleName: resolveModuleName(reexportedFile.fileName),
+          name: exportName
+        };
+      }
+    }
     const mapToNamespace = mapFromBarrelToNamespace.get(exportFileName);
     if (mapToNamespace && exportName in mapToNamespace) {
       const namespacedFileName = mapToNamespace[exportName];
@@ -5892,6 +5946,64 @@ function goto(applicableGotoDefinition, sourceFile, position) {
   return effectRpcDefinition(applicableGotoDefinition, sourceFile, position);
 }
 
+// src/inlays/middlewareGenLike.ts
+var middlewareGenLike = fn("middlewareGenLike")(function* (sourceFile, _span, preferences, inlayHints) {
+  if (!preferences) return inlayHints;
+  if (preferences.includeInlayFunctionLikeReturnTypeHints !== true) return inlayHints;
+  if (!inlayHints) return inlayHints;
+  const tsUtils = yield* service(TypeScriptUtils);
+  const ts = yield* service(TypeScriptApi);
+  const typeParser = yield* service(TypeParser);
+  const typeChecker = yield* service(TypeCheckerApi);
+  const result = [];
+  const parseType = (node) => {
+    return pipe(
+      map3(typeParser.effectGen(node), (_) => {
+        const type = typeChecker.getTypeAtLocation(_.node);
+        const typeString = typeChecker.typeToString(type, _.generatorFunction, ts.TypeFormatFlags.NoTruncation);
+        return { ..._, typeString };
+      }),
+      orElse2(
+        () => map3(pipe(typeParser.effectFnGen(node), orElse2(() => typeParser.effectFnUntracedGen(node))), (_) => {
+          const fnType = typeChecker.getTypeAtLocation(_.node);
+          const types = [];
+          for (const callSig of fnType.getCallSignatures()) {
+            types.push(
+              typeChecker.typeToString(callSig.getReturnType(), _.generatorFunction, ts.TypeFormatFlags.NoTruncation)
+            );
+          }
+          return { ..._, typeString: types.join(" | ") };
+        })
+      )
+    );
+  };
+  for (const inlayHint of inlayHints) {
+    let modifiedInlayHint = inlayHint;
+    if (inlayHint.kind === ts.InlayHintKind.Type) {
+      const node = tsUtils.findNodeAtPositionIncludingTrivia(sourceFile, inlayHint.position - 1);
+      if (node && node.parent) {
+        const possiblyGen = node.parent;
+        yield* pipe(
+          parseType(possiblyGen),
+          map3((_) => {
+            const argsCloseParen = ts.findChildOfKind(_.generatorFunction, ts.SyntaxKind.CloseParenToken, sourceFile);
+            if (argsCloseParen && _.body && inlayHint.position >= argsCloseParen.getEnd() && inlayHint.position <= _.body.getStart(sourceFile)) {
+              const { displayParts: _displayParts, text: _text, ...toKeep } = inlayHint;
+              modifiedInlayHint = {
+                ...toKeep,
+                text: ": " + _.typeString
+              };
+            }
+          }),
+          ignore
+        );
+      }
+    }
+    result.push(modifiedInlayHint);
+  }
+  return result;
+});
+
 // src/quickinfo/dedupeJsDocs.ts
 var SymbolDisplayPartEq = make((fa, fb) => fa.kind === fb.kind && fa.text === fb.text);
 var JSDocTagInfoEq = make(
@@ -5915,6 +6027,8 @@ function effectTypeArgs(sourceFile, position, quickInfo2) {
       const ts = yield* service(TypeScriptApi);
       const typeChecker = yield* service(TypeCheckerApi);
       const typeParser = yield* service(TypeParser);
+      const options = yield* service(LanguageServicePluginOptions);
+      if (options.quickinfoEffectParameters === "never") return quickInfo2;
       function formatTypeForQuickInfo(channelType, channelName) {
         const stringRepresentation = typeChecker.typeToString(
           channelType,
@@ -5960,7 +6074,7 @@ function effectTypeArgs(sourceFile, position, quickInfo2) {
           type: typeChecker.getTypeAtLocation(adjustedNode),
           atLocation: adjustedNode,
           node: adjustedNode,
-          shouldTry: quickInfo2 && ts.displayPartsToString(quickInfo2.displayParts).indexOf("...") > -1
+          shouldTry: options.quickinfoEffectParameters === "always" && quickInfo2 ? true : quickInfo2 && ts.displayPartsToString(quickInfo2.displayParts).indexOf("...") > -1
         };
       }
       const data = getDataForQuickInfo();
@@ -12398,6 +12512,23 @@ var init = (modules) => {
       }
       return applicableDefinition;
     };
+    proxy.provideInlayHints = (fileName, span, preferences, ...args2) => {
+      const applicableInlayHints = languageService.provideInlayHints(fileName, span, preferences, ...args2);
+      if (languageServicePluginOptions.inlays) {
+        const program = languageService.getProgram();
+        if (program) {
+          const sourceFile = program.getSourceFile(fileName);
+          if (sourceFile) {
+            return pipe(
+              middlewareGenLike(sourceFile, span, preferences, applicableInlayHints),
+              runNano(program),
+              getOrElse(() => applicableInlayHints)
+            );
+          }
+        }
+      }
+      return applicableInlayHints;
+    };
     return proxy;
   }
   return { create, onConfigurationChanged };