@effect/language-service 0.31.2 → 0.33.0

package/README.md

@@ -90,16 +90,20 @@ Few options can be provided alongside the initialization of the Language Service
     "plugins": [
       {
         "name": "@effect/language-service",
+        "refactors": true, // controls Effect refactors (default: true)
         "diagnostics": true, // controls Effect diagnostics (default: true)
         "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
         },
-        "quickinfo": true, // controls quickinfo over Effect (default: true)
+        "quickinfo": true, // controls Effect quickinfo (default: true)
+        "quickinfoEffectParameters": "whenTruncated", // (default: "whenTruncated") controls when to display effect type parameters always,never,whenTruncated
         "completions": true, // controls Effect completions (default: true)
         "goto": true, // controls Effect goto references (default: true)
+        "inlays": true, // controls Effect provided inlayHints (default: true)
         "allowedDuplicatedPackages": [], // list of package names that have effect in peer dependencies and are allowed to be duplicated (default: [])
         "barrelImportPackages": [], // package names that should be preferred as imported from the top level barrel file (default: [])
-        "namespaceImportPackages": [] // package names that should be preferred as imported with namespace imports e.g. ["effect", "@effect/*"] (default: [])
+        "namespaceImportPackages": [], // package names that should be preferred as imported with namespace imports e.g. ["effect", "@effect/*"] (default: [])
+        "topLevelNamedReexports": "ignore" // for namespaceImportPackages, how should top level named re-exports (e.g. {pipe} from "effect") be treated? "ignore" will leave them as is, "follow" will rewrite them to the re-exported module (e.g. {pipe} from "effect/Function")
       }
     ]
   }

package/cli.js

@@ -28777,16 +28777,34 @@ function parseDiagnosticSeverity(config2) {
     )
   );
 }
+var defaults = {
+  refactors: true,
+  diagnostics: true,
+  diagnosticSeverity: {},
+  quickinfo: true,
+  quickinfoEffectParameters: "whentruncated",
+  completions: true,
+  goto: true,
+  inlays: true,
+  allowedDuplicatedPackages: [],
+  namespaceImportPackages: [],
+  barrelImportPackages: [],
+  topLevelNamedReexports: "ignore"
+};
 function parse4(config2) {
   return {
-    diagnostics: isObject(config2) && hasProperty(config2, "diagnostics") && isBoolean(config2.diagnostics) ? config2.diagnostics : true,
-    diagnosticSeverity: isObject(config2) && hasProperty(config2, "diagnosticSeverity") && isRecord(config2.diagnosticSeverity) ? parseDiagnosticSeverity(config2.diagnosticSeverity) : {},
-    quickinfo: isObject(config2) && hasProperty(config2, "quickinfo") && isBoolean(config2.quickinfo) ? config2.quickinfo : true,
-    completions: isObject(config2) && hasProperty(config2, "completions") && isBoolean(config2.completions) ? config2.completions : true,
-    goto: isObject(config2) && hasProperty(config2, "goto") && isBoolean(config2.goto) ? config2.goto : true,
-    allowedDuplicatedPackages: isObject(config2) && hasProperty(config2, "allowedDuplicatedPackages") && isArray(config2.allowedDuplicatedPackages) && config2.allowedDuplicatedPackages.every(isString) ? config2.allowedDuplicatedPackages.map((_) => _.toLowerCase()) : [],
-    namespaceImportPackages: isObject(config2) && hasProperty(config2, "namespaceImportPackages") && isArray(config2.namespaceImportPackages) && config2.namespaceImportPackages.every(isString) ? config2.namespaceImportPackages.map((_) => _.toLowerCase()) : [],
-    barrelImportPackages: isObject(config2) && hasProperty(config2, "barrelImportPackages") && isArray(config2.barrelImportPackages) && config2.barrelImportPackages.every(isString) ? config2.barrelImportPackages.map((_) => _.toLowerCase()) : []
+    refactors: isObject(config2) && hasProperty(config2, "refactors") && isBoolean(config2.refactors) ? config2.refactors : defaults.refactors,
+    diagnostics: isObject(config2) && hasProperty(config2, "diagnostics") && isBoolean(config2.diagnostics) ? config2.diagnostics : defaults.diagnostics,
+    diagnosticSeverity: isObject(config2) && hasProperty(config2, "diagnosticSeverity") && isRecord(config2.diagnosticSeverity) ? parseDiagnosticSeverity(config2.diagnosticSeverity) : defaults.diagnosticSeverity,
+    quickinfo: isObject(config2) && hasProperty(config2, "quickinfo") && isBoolean(config2.quickinfo) ? config2.quickinfo : defaults.quickinfo,
+    quickinfoEffectParameters: isObject(config2) && hasProperty(config2, "quickinfoEffectParameters") && isString(config2.quickinfoEffectParameters) && ["always", "never", "whentruncated"].includes(config2.quickinfoEffectParameters.toLowerCase()) ? config2.quickinfoEffectParameters.toLowerCase() : defaults.quickinfoEffectParameters,
+    completions: isObject(config2) && hasProperty(config2, "completions") && isBoolean(config2.completions) ? config2.completions : defaults.completions,
+    goto: isObject(config2) && hasProperty(config2, "goto") && isBoolean(config2.goto) ? config2.goto : defaults.goto,
+    inlays: isObject(config2) && hasProperty(config2, "inlays") && isBoolean(config2.inlays) ? config2.inlays : defaults.inlays,
+    allowedDuplicatedPackages: isObject(config2) && hasProperty(config2, "allowedDuplicatedPackages") && isArray(config2.allowedDuplicatedPackages) && config2.allowedDuplicatedPackages.every(isString) ? config2.allowedDuplicatedPackages.map((_) => _.toLowerCase()) : defaults.allowedDuplicatedPackages,
+    namespaceImportPackages: isObject(config2) && hasProperty(config2, "namespaceImportPackages") && isArray(config2.namespaceImportPackages) && config2.namespaceImportPackages.every(isString) ? config2.namespaceImportPackages.map((_) => _.toLowerCase()) : defaults.namespaceImportPackages,
+    barrelImportPackages: isObject(config2) && hasProperty(config2, "barrelImportPackages") && isArray(config2.barrelImportPackages) && config2.barrelImportPackages.every(isString) ? config2.barrelImportPackages.map((_) => _.toLowerCase()) : defaults.barrelImportPackages,
+    topLevelNamedReexports: isObject(config2) && hasProperty(config2, "topLevelNamedReexports") && isString(config2.topLevelNamedReexports) && ["ignore", "follow"].includes(config2.topLevelNamedReexports.toLowerCase()) ? config2.topLevelNamedReexports.toLowerCase() : defaults.topLevelNamedReexports
   };
 }
 
@@ -30817,9 +30835,11 @@ var floatingEffect = createDiagnostic({
           option4
         );
         if (isNone2(allowedFloatingEffects)) {
+          const isStrictEffect = yield* option4(typeParser.strictEffectType(type2, node.expression));
+          const name = isSome2(isStrictEffect) ? "Effect" : "Effect-able " + typeChecker.typeToString(type2);
           report({
             location: node,
-            messageText: `Effect must be yielded or assigned to a variable.`,
+            messageText: `${name} must be yielded or assigned to a variable.`,
             fixes: []
           });
         }
@@ -31446,7 +31466,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
                 });
               }