@effect/language-service 0.15.1 → 0.16.0

package/README.md

@@ -26,12 +26,39 @@ This package implements a TypeScript language service plugin that allows additio
 
 And you're done! You'll now be able to use a set of refactor and diagnostics that targets Effect!
 
-## Enable diagnostics at compile time
+## Provided functionalities
 
-TypeScript LSP are loaded only while editing your files. That means that if you run `tsc` in your project, the plugin won't be loaded and you'll miss out on the Effect diagnostics.
+### Quickinfo
 
-HOWEVER, if you use `ts-patch` you can enable the transform as well to get the diagnostics also at compile time.
-Your `tsconfig.json` should look like this:
+- Show the extended type of the current Effect
+- Hovering yield\* of Effect.gen will show the Effect type parameters
+
+### Diagnostics
+
+- Better error readability when you're missing errors or service types in your Effect definitions
+- Floating Effects that are not yielded or run
+- Wrong usage of yield inside Effect.gen
+- Unnecessary usages of Effect.gen
+- Multiple versions of Effect in your project
+
+### Completions
+
+- Autocomplete 'Self' in Effect.Service, Context.Tag, Schema.TaggedClass, Schema.TaggedRequest and family
+
+### Refactors
+
+- Transform an async function definition, into an Effect by using Effect.gen.
+- Transform an async function definition, into an Effect by using Effect.gen, and generating a tagged error for each promise call.
+- Transform a function returning an Effect.gen into a Effect.fn
+- Function calls to pipe: Transform a set of function calls to a pipe() call.
+- Pipe to datafirst: Transform a pipe() call into a series of datafirst function calls (where available).
+- Toggle return type signature: With a single refactor, adds or removes type annotations from the definition.
+- Remove unnecessary `Effect.gen` definitions that contains a single `yield` statement.
+- Wrap an `Effect` expression with `Effect.gen`
+
+## Options
+
+Few options can be provided alongside the initialization of the Language Service Plugin.
 
 ```json
 {
@@ -39,30 +66,22 @@ Your `tsconfig.json` should look like this:
     "plugins": [
       {
         "name": "@effect/language-service",
-        "transform": "@effect/language-service/transform" // enables diagnostics at compile time when using ts-patch
+        "diagnostics": true, // controls Effect diagnostics (default: true)
+        "quickinfo": true, // controls quickinfo over Effect (default: true)
+        "completions": true, // controls Effect completions (default: true)
+        "multipleEffectCheck": true // controls if multiple versions of Effect are referenced (default: true)
       }
     ]
   }
 }
 ```
 
-To get diagnostics you need to install `ts-patch` which will make it possible to run `tspc`.
-
-Running `tspc` in your project will now also run the plugin and give you the diagnostics at compile time.
-
-```ts
-$ npx tspc
-index.ts:3:1 - error TS3: Effect must be yielded or assigned to a variable.
-
-3 Effect.succeed(1)
-  ~~~~~~~~~~~~~~~~~
-
-Found 1 error in index.ts:3 
-```
+## Why diagnostics does not appear at compile time?
 
-## Options
+TypeScript LSP are loaded only while editing your files. That means that if you run `tsc` in your project, the plugin won't be loaded and you'll miss out on the Effect diagnostics.
 
-Few options can be provided alongside the initialization of the Language Service Plugin.
+HOWEVER, if you use `ts-patch` you can enable the transform as well to get the diagnostics also at compile time.
+Your `tsconfig.json` should look like this:
 
 ```json
 {
@@ -70,44 +89,27 @@ Few options can be provided alongside the initialization of the Language Service
     "plugins": [
       {
         "name": "@effect/language-service",
-        "diagnostics": true, // controls Effect diagnostics
-        "quickinfo": true, // controls quickinfo over Effect
-        "completions": true, // controls Effect completions
-        "multipleEffectCheck": true // controls if multiple versions of Effect are referenced
+        "transform": "@effect/language-service/transform" // enables diagnostics at compile time when using ts-patch
       }
     ]
   }
 }
 ```
 
-## Provided functionalities
-
-### Quickinfo
-
-- Show the extended type of the current Effect
-
-### Diagnostics
-
-- Better error readability when you're missing errors or service types in your Effect definitions
-- Floating Effects that are not yielded or run
-- Wrong usage of yield inside Effect.gen
-- Unnecessary usages of Effect.gen
-- Multiple versions of Effect in your project
+To get diagnostics you need to install `ts-patch` which will make it possible to run `tspc`.
 
-### Completions
+Running `tspc` in your project will now also run the plugin and give you the diagnostics at compile time.
+Effect diagnostics will be shown only after standard TypeScript diagnostics has been satisfied.
 
-- Autocomplete 'Self' in Effect.Service, Context.Tag, Schema.TaggedClass, Schema.TaggedRequest and family
+```ts
+$ npx tspc
+index.ts:3:1 - error TS3: Effect must be yielded or assigned to a variable.
 
-### Refactors
+3 Effect.succeed(1)
+  ~~~~~~~~~~~~~~~~~
 
-- Transform an async function definition, into an Effect by using Effect.gen.
-- Transform an async function definition, into an Effect by using Effect.gen, and generating a tagged error for each promise call.
-- Transform a function returning an Effect.gen into a Effect.fn
-- Function calls to pipe: Transform a set of function calls to a pipe() call.
-- Pipe to datafirst: Transform a pipe() call into a series of datafirst function calls (where available).
-- Toggle return type signature: With a single refactor, adds or removes type annotations from the definition.
-- Remove unnecessary `Effect.gen` definitions that contains a single `yield` statement.
-- Wrap an `Effect` expression with `Effect.gen`
+Found 1 error in index.ts:3 
+```
 
 ## Configuring diagnostics
 

package/index.js

@@ -2614,6 +2614,7 @@ var JSDocTagInfoEq = make(
   (fa, fb) => fa.name === fb.name && typeof fa.text === typeof fb.text && (typeof fa.text !== "undefined" ? array(SymbolDisplayPartEq)(fa.text, fb.text) : true)
 );
 function dedupeJsDocTags(quickInfo) {
+  if (!quickInfo) return quickInfo;
   if (quickInfo.tags) {
     return {
       ...quickInfo,
@@ -2639,21 +2640,33 @@ function prependEffectTypeArguments(sourceFile, position, quickInfo) {
     gen2(function* () {
       const ts = yield* service(TypeScriptApi);
       const typeChecker = yield* service(TypeCheckerApi);
-      const hasTruncationHappened = ts.displayPartsToString(quickInfo.displayParts).indexOf("...") > -1;
-      if (!hasTruncationHappened) return quickInfo;
       const maybeNode = pipe(
         yield* getAncestorNodesInRange(sourceFile, toTextRange(position)),
         head
       );
       if (isNone2(maybeNode)) return quickInfo;
+      const node = maybeNode.value;
+      const hasTruncationHappened = quickInfo && ts.displayPartsToString(quickInfo.displayParts).indexOf("...") > -1;
+      const nodeForType = !quickInfo && ts.isYieldExpression(node) && node.asteriskToken && node.expression ? node.expression : hasTruncationHappened ? node : void 0;
+      if (!nodeForType) return quickInfo;
       const effectType2 = yield* effectType(
-        typeChecker.getTypeAtLocation(maybeNode.value),
-        maybeNode.value
+        typeChecker.getTypeAtLocation(nodeForType),
+        nodeForType
       );
       const effectTypeArgsDocumentation = [{
         kind: "text",
         text: "```ts\n/* Effect Type Parameters */\n" + (yield* formatTypeForQuickInfo(effectType2.A, "Success")) + "\n" + (yield* formatTypeForQuickInfo(effectType2.E, "Failure")) + "\n" + (yield* formatTypeForQuickInfo(effectType2.R, "Requirements")) + "\n```\n"
       }];
+      if (!quickInfo) {
+        const start = node.getStart();
+        const end = node.getEnd();
+        return {
+          kind: ts.ScriptElementKind.callSignatureElement,
+          kindModifiers: "",
+          textSpan: { start, length: end - start },
+          documentation: effectTypeArgsDocumentation
+        };
+      }
       if (quickInfo.documentation) {
         return {
           ...quickInfo,
@@ -4287,7 +4300,7 @@ var init = (modules) => {
     };
     proxy.getQuickInfoAtPosition = (fileName, position, ...args) => {
       const quickInfo = languageService.getQuickInfoAtPosition(fileName, position, ...args);
-      if (pluginOptions.quickinfo && quickInfo) {
+      if (pluginOptions.quickinfo) {
         const dedupedTagsQuickInfo = dedupeJsDocTags(quickInfo);
         const program = languageService.getProgram();
         if (program) {