@effect/language-service 0.9.0 → 0.9.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Effectful Technologies Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,69 @@
+# language-service
+
+This package implements a TypeScript language service plugin that allows additional refactors and diagnostics with your VSCode editor (or any editor that supports TypeScript's LSP).
+
+## Installation
+
+1) `npm install @effect/language-service --save-dev` in your project
+2) inside your tsconfig.json, you should add the plugin configuration as follows:
+
+```json
+{
+  "compilerOptions": {
+    "plugins": [
+      {
+        "name": "@effect/language-service"
+      }
+    ]
+  }
+}
+```
+3) Ensure that you set your editor to use your workspace TypeScript version. 
+  
+    - In VSCode you can do this by pressing "F1" and typing "TypeScript: Select TypeScript version". Then select "Use workspace version".
+    - In JetBrains you may have to disable the Vue language service, and chose the workspace version of TypeScript in the settings from the dropdown.
+
+And you're done! You'll now be able to use a set of refactor and diagnostics that targets Effect!
+
+## Options
+
+Few options can be provided alongside the initialization of the Language Service Plugin.
+
+```json
+{
+  "compilerOptions": {
+    "plugins": [
+      {
+        "name": "@effect/language-service",
+        "diagnostics": true, // controls Effect diagnostics (on by default)
+        "quickinfo": true // controls quickinfo over Effect (on by default)
+      }
+    ]
+  }
+}
+```
+
+## 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
+- Detect floating Effects that are not yielded or run
+- Detect wrong usage of yield inside Effect.gen
+- Detect unnecessary usages of Effect.gen
+
+### 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.

package/index.js

@@ -2892,10 +2892,9 @@ function collectSelfAndAncestorNodesInRange(node, textRange) {
   });
 }
 var getAncestorNodesInRange = fn("AST.getAncestorNodesInRange")(function* (sourceFile, textRange) {
-  const ts = yield* service(TypeScriptApi);
-  const precedingToken = ts.findPrecedingToken(textRange.pos, sourceFile);
-  if (!precedingToken) return empty();
-  return yield* collectSelfAndAncestorNodesInRange(precedingToken, textRange);
+  const nodeAtPosition = yield* option(findNodeAtPosition(sourceFile, textRange.pos));
+  if (isNone2(nodeAtPosition)) return empty();
+  return yield* collectSelfAndAncestorNodesInRange(nodeAtPosition.value, textRange);
 });
 var NodeNotFoundError = class extends TaggedError("@effect/language-service/NodeNotFoundError") {
 };
@@ -2911,13 +2910,6 @@ var findNodeAtPosition = fn("AST.findNodeAtPosition")(function* (sourceFile, pos
   if (!result) return yield* fail3(new NodeNotFoundError());
   return result;
 });
-var collectDescendantsAndAncestorsInRange = fn(
-  "AST.collectDescendantsAndAncestorsInRange"
-)(function* (sourceFile, textRange) {
-  const nodeAtPosition = yield* option(findNodeAtPosition(sourceFile, textRange.pos));
-  if (isNone2(nodeAtPosition)) return empty();
-  return yield* collectSelfAndAncestorNodesInRange(nodeAtPosition.value, textRange);
-});
 function toTextRange(positionOrRange) {
   return typeof positionOrRange === "number" ? { end: positionOrRange, pos: positionOrRange } : positionOrRange;
 }
@@ -3208,6 +3200,43 @@ var contextSelfInClasses = createCompletion({
   })
 });
 
+// src/completions/effectDataClasses.ts
+var effectDataClasses = createCompletion({
+  name: "effect/effectDataClasses",
+  apply: fn("effectDataClasses")(function* (sourceFile, position) {
+    const ts = yield* service(TypeScriptApi);
+    const maybeInfos = yield* parseDataForExtendsClassCompletion(sourceFile, position);
+    if (isNone2(maybeInfos)) return [];
+    const { accessedObject, className, replacementSpan } = maybeInfos.value;
+    const dataName = yield* option(
+      findImportedModuleIdentifierByPackageAndNameOrBarrel(
+        sourceFile,
+        "effect",
+        "Data"
+      )
+    );
+    const effectDataIdentifier = match2(dataName, {
+      onNone: () => "Data",
+      onSome: (_) => _.text
+    });
+    if (effectDataIdentifier !== accessedObject.text) return [];
+    const name = className.text;
+    return [{
+      name: `TaggedError("${name}")`,
+      kind: ts.ScriptElementKind.constElement,
+      insertText: `${effectDataIdentifier}.TaggedError("${name}")<{${"${0}"}}>{}`,
+      replacementSpan,
+      isSnippet: true
+    }, {
+      name: `TaggedClass("${name}")`,
+      kind: ts.ScriptElementKind.constElement,
+      insertText: `${effectDataIdentifier}.TaggedClass("${name}")<{${"${0}"}}>{}`,
+      replacementSpan,
+      isSnippet: true
+    }];
+  })
+});
+
 // src/completions/effectSchemaSelfInClasses.ts
 var effectSchemaSelfInClasses = createCompletion({
   name: "effect/effectSchemaSelfInClasses",
@@ -3289,7 +3318,12 @@ var effectSelfInClasses = createCompletion({
 });
 
 // src/completions.ts
-var completions = [effectSchemaSelfInClasses, effectSelfInClasses, contextSelfInClasses];
+var completions = [
+  effectSchemaSelfInClasses,
+  effectSelfInClasses,
+  contextSelfInClasses,
+  effectDataClasses
+];
 
 // src/utils/TypeCheckerApi.ts
 var TypeCheckerApi = Tag("TypeChecker");
@@ -4462,10 +4496,7 @@ var removeUnnecessaryEffectGen = createRefactor({
   name: "effect/removeUnnecessaryEffectGen",
   description: "Remove unnecessary Effect.gen",
   apply: (sourceFile, textRange) => gen2(function* () {
-    for (const nodeToReplace of yield* collectDescendantsAndAncestorsInRange(
-      sourceFile,
-      textRange
-    )) {
+    for (const nodeToReplace of yield* getAncestorNodesInRange(sourceFile, textRange)) {
       const maybeNode = yield* pipe(
         effectGen(nodeToReplace),
         flatMap4(({ body }) => returnYieldEffectBlock(body)),
@@ -4489,7 +4520,7 @@ var removeUnnecessaryEffectGen = createRefactor({
 // src/refactors/toggleLazyConst.ts
 var toggleLazyConst = createRefactor({
   name: "effect/toggleLazyConst",
-  description: "Toggle type annotation",
+  description: "Toggle lazy const",
   apply: (sourceFile, textRange) => gen2(function* () {
     const ts = yield* service(TypeScriptApi);
     const maybeNode = pipe(