@effect/language-service 0.21.2 → 0.21.3

package/README.md

@@ -6,11 +6,11 @@ This package implements a TypeScript language service plugin that allows additio
 
 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": [
+      // ... other LSPs (if any) and as last
       {
         "name": "@effect/language-service"
       }
@@ -133,3 +133,42 @@ Effect.succeed(1); // This will not be reported as a floating effect
 // @effect-diagnostics effect/floatingEffect:error
 Effect.succeed(1); // This will be reported as a floating effect
 ```
+
+or you can set the severity for the entire project in the global plugin configuration
+
+```json
+{
+  "compilerOptions": {
+    "plugins": [
+      {
+        // ...
+        "diagnosticSeverity": { // allows to change per-rule default severity of the diagnostic in the whole project
+          "floatingEffect": "warning" // example for a rule, allowed values are off,error,warning,message,suggestion
+        },
+        // ...
+      }
+    ]
+  }
+}
+```
+
+## Known gotchas
+
+### Svelte VSCode extension and SvelteKit
+
+The Svelte LSP does not properly compose with other LSPs when using SvelteKit. So the Effect LSP should be loaded as last entry to ensure proper composition.
+
+If you did not installed the Svelte LSP into your local project but instead through the Svelte VSCode extension, we recommend instead to install locally and add it as first entry. That way it won't be applied by the VSCode extension.
+
+Your tsconfig should look like this:
+
+```json
+{
+  "compilerOptions": {
+    "plugins": [
+      { "name": "typescript-svelte-plugin" },
+      { "name": "@effect/language-service" }
+    ]
+  }
+}
+```

package/index.js

@@ -1191,6 +1191,8 @@ function parsePackageContentNameAndVersionFromScope(v) {
   const packageJsonContent = packageJsonScope.contents.packageJsonContent;
   if (!hasProperty(packageJsonContent, "name")) return;
   if (!hasProperty(packageJsonContent, "version")) return;
+  if (!hasProperty(packageJsonScope, "packageDirectory")) return;
+  if (!isString(packageJsonScope.packageDirectory)) return;
   const { name, version } = packageJsonContent;
   if (!isString(name)) return;
   if (!isString(version)) return;
@@ -1199,7 +1201,8 @@ function parsePackageContentNameAndVersionFromScope(v) {
     name: name.toLowerCase(),
     version: version.toLowerCase(),
     hasEffectInPeerDependencies,
-    contents: packageJsonContent
+    contents: packageJsonContent,
+    packageDirectory: packageJsonScope.packageDirectory
   };
 }
 
@@ -2864,7 +2867,7 @@ var duplicatePackage = createDiagnostic({
         if (!(packageInfo.name === "effect" || packageInfo.hasEffectInPeerDependencies)) return;
         if (options.allowedDuplicatedPackages.indexOf(packageInfo.name) > -1) return;
         resolvedPackages[packageInfo.name] = resolvedPackages[packageInfo.name] || {};
-        resolvedPackages[packageInfo.name][packageInfo.version] = packageInfo.contents;
+        resolvedPackages[packageInfo.name][packageInfo.version] = packageInfo.packageDirectory;
       });
       checkedPackagesCache.set(sourceFile.fileName, resolvedPackages);
       programResolvedCacheSize.set(sourceFile.fileName, newResolvedModuleSize);
@@ -2877,7 +2880,9 @@ var duplicatePackage = createDiagnostic({
           category: ts.DiagnosticCategory.Warning,
           messageText: `Package ${packageName} is referenced multiple times with different versions (${versions.join(", ")}) and may cause unexpected type errors.
 Cleanup your dependencies and your package lockfile to avoid multiple instances of this package and reload the project.
-If this is intended set the LSP config "allowedDuplicatedPackages" to ${JSON.stringify(options.allowedDuplicatedPackages.concat([packageName]))}.`,
+If this is intended set the LSP config "allowedDuplicatedPackages" to ${JSON.stringify(options.allowedDuplicatedPackages.concat([packageName]))}.
+
+${versions.map((version) => `- found ${version} at ${resolvedPackages[packageName][version]}`).join("\n")}`,
           fixes: []
         });
       }
@@ -3208,7 +3213,7 @@ var missingReturnYieldStar = createDiagnostic({
       effectDiagnostics.push({
         node,
         category: ts.DiagnosticCategory.Error,
-        messageText: `Yielded Effect never completes, so it is best to use a 'return yield*' instead.`,
+        messageText: `Yielded Effect never succeeds, so it is best to use a 'return yield*' instead.`,
         fixes: fix
       });
     });