@effect/language-service 0.4.0 → 0.5.0

package/index.js

@@ -1434,12 +1434,47 @@ var missingStarInYieldEffectGen = createDiagnostic({
   }
 });
 
+// src/diagnostics/unnecessaryEffectGen.ts
+var unnecessaryEffectGen = createDiagnostic({
+  code: 5,
+  apply: (ts, program) => (sourceFile) => {
+    const typeChecker = program.getTypeChecker();
+    const effectDiagnostics = [];
+    const brokenGenerators = /* @__PURE__ */ new Set();
+    const visit = (node) => {
+      const effectGenLike = effectGen(ts, typeChecker)(node);
+      if (isSome2(effectGenLike)) {
+        const body = effectGenLike.value.body;
+        if (body.statements.length === 1 && ts.isReturnStatement(body.statements[0]) && body.statements[0].expression && ts.isYieldExpression(body.statements[0].expression) && body.statements[0].expression.expression) {
+          const nodeToCheck = body.statements[0].expression.expression;
+          const type = typeChecker.getTypeAtLocation(nodeToCheck);
+          const maybeEffect = effectType(ts, typeChecker)(type, nodeToCheck);
+          if (isSome2(maybeEffect)) {
+            brokenGenerators.add(node);
+          }
+        }
+      }
+      ts.forEachChild(node, visit);
+    };
+    ts.forEachChild(sourceFile, visit);
+    brokenGenerators.forEach(
+      (node) => effectDiagnostics.push({
+        node,
+        category: ts.DiagnosticCategory.Warning,
+        messageText: `This Effect.gen is useless here because it only contains a single return statement.`
+      })
+    );
+    return effectDiagnostics;
+  }
+});
+
 // src/diagnostics.ts
 var diagnostics = {
   missingEffectContext,
   missingEffectError,
   floatingEffect,
-  missingStarInYieldEffectGen
+  missingStarInYieldEffectGen,
+  unnecessaryEffectGen
 };
 
 // src/quickinfo.ts
@@ -1458,6 +1493,47 @@ function dedupeJsDocTags(quickInfo) {
   }
   return quickInfo;
 }
+function formatTypeForQuickInfo(ts, typeChecker) {
+  return (channelType, channelName) => {
+    const stringRepresentation = typeChecker.typeToString(
+      channelType,
+      void 0,
+      ts.TypeFormatFlags.NoTruncation
+    );
+    return `type ${channelName} = ${stringRepresentation}`;
+  };
+}
+function prependEffectTypeArguments(ts, program) {
+  return (sourceFileName, position, quickInfo) => {
+    const sourceFile = program.getSourceFile(sourceFileName);
+    if (!sourceFile) return quickInfo;
+    const hasTruncationHappened = ts.displayPartsToString(quickInfo.displayParts).indexOf("...") > -1;
+    if (!hasTruncationHappened) return quickInfo;
+    const typeChecker = program.getTypeChecker();
+    const effectTypeArgsDocumentation = pipe(
+      getNodesContainingRange(ts)(sourceFile, toTextRange(position)),
+      head,
+      flatMap(
+        (_) => effectType(ts, typeChecker)(typeChecker.getTypeAtLocation(_), _)
+      ),
+      map((_) => [{
+        kind: "text",
+        text: "```ts\n/* Effect Type Parameters */\n" + formatTypeForQuickInfo(ts, typeChecker)(_.A, "Success") + "\n" + formatTypeForQuickInfo(ts, typeChecker)(_.E, "Failure") + "\n" + formatTypeForQuickInfo(ts, typeChecker)(_.R, "Requirements") + "\n```\n"
+      }]),
+      getOrElse(() => [])
+    );
+    if (quickInfo.documentation) {
+      return {
+        ...quickInfo,
+        documentation: effectTypeArgsDocumentation.concat(quickInfo.documentation)
+      };
+    }
+    return {
+      ...quickInfo,
+      documentation: effectTypeArgsDocumentation
+    };
+  };
+}
 
 // src/refactors/asyncAwaitToGen.ts
 var asyncAwaitToGen = createRefactor({
@@ -1800,7 +1876,9 @@ var toggleTypeAnnotation = createRefactor({
   description: "Toggle type annotation",
   apply: (ts, program) => (sourceFile, textRange) => pipe(
     getNodesContainingRange(ts)(sourceFile, textRange),
-    filter(ts.isVariableDeclaration),
+    filter(
+      (node) => ts.isVariableDeclaration(node) || ts.isPropertyDeclaration(node)
+    ),
     filter((node) => isNodeInRange(textRange)(node.name)),
     filter((node) => !!node.initializer),
     head,
@@ -1872,7 +1950,8 @@ var init = (modules) => {
   function create(info) {
     const languageService = info.languageService;
     const pluginOptions = {
-      diagnostics: info.config && "diagnostics" in info.config && typeof info.config.diagnostics === "boolean" ? info.config.diagnostics : true
+      diagnostics: info.config && "diagnostics" in info.config && typeof info.config.diagnostics === "boolean" ? info.config.diagnostics : true,
+      quickinfo: info.config && "quickinfo" in info.config && typeof info.config.quickinfo === "boolean" ? info.config.quickinfo : true
     };
     const proxy = /* @__PURE__ */ Object.create(null);
     for (const k of Object.keys(info.languageService)) {
@@ -2005,8 +2084,13 @@ var init = (modules) => {
     };
     proxy.getQuickInfoAtPosition = (fileName, position, ...args) => {
       const quickInfo = languageService.getQuickInfoAtPosition(fileName, position, ...args);
-      if (quickInfo) {
-        return dedupeJsDocTags(quickInfo);
+      if (pluginOptions.quickinfo && quickInfo) {
+        const dedupedTagsQuickInfo = dedupeJsDocTags(quickInfo);
+        const program = languageService.getProgram();
+        if (program) {
+          return prependEffectTypeArguments(ts, program)(fileName, position, dedupedTagsQuickInfo);
+        }
+        return dedupedTagsQuickInfo;
       }
       return quickInfo;
     };