@effect/language-service 0.45.1 → 0.46.0

package/README.md

@@ -63,6 +63,7 @@ And you're done! You'll now be able to use a set of refactors and diagnostics th
 - Warn on missing service dependencies in `Effect.Service` declarations
 - Warn when `Effect.Service` is used with a primitive type instead of an object type
 - Warn when schema classes override the default constructor behavior
+- Warn when `@effect-diagnostics-next-line` comments have no effect (i.e., they don't suppress any diagnostic)
 
 ### Completions
 
@@ -110,6 +111,7 @@ Few options can be provided alongside the initialization of the Language Service
           "floatingEffect": "warning" // example for a rule, allowed values are off,error,warning,message,suggestion
         },
         "diagnosticsName": true, // controls whether to include the rule name in diagnostic messages (default: true)
+        "missingDiagnosticNextLine": "warning", // controls the severity of warnings for unused @effect-diagnostics-next-line comments (default: "warning", allowed values: off,error,warning,message,suggestion)
         "quickinfo": true, // controls Effect quickinfo (default: true)
         "quickinfoEffectParameters": "whenTruncated", // (default: "whenTruncated") controls when to display effect type parameters always,never,whenTruncated
         "quickinfoMaximumLength": -1, // controls how long can be the types in the quickinfo hover (helps with very long type to improve perfs, defaults to -1 for no truncation, can be any number eg. 1000 and TS will try to fit as much as possible in that budget, higher number means more info.)

package/effect-lsp-patch-utils.js

@@ -1155,6 +1155,9 @@ var all = fn("all")(
 
 // src/core/LanguageServicePluginOptions.ts
 var LanguageServicePluginOptions = Tag("PluginOptions");
+function isValidSeverityLevel(value) {
+  return value === "off" || value === "error" || value === "warning" || value === "message" || value === "suggestion";
+}
 function parseDiagnosticSeverity(config) {
   if (!isRecord(config)) return {};
   return Object.fromEntries(
@@ -1162,9 +1165,7 @@ function parseDiagnosticSeverity(config) {
       Object.entries(config),
       filter(([key, value]) => isString(key) && isString(value)),
       map3(([key, value]) => [String(key).toLowerCase(), String(value).toLowerCase()]),
-      filter(
-        ([_, value]) => value === "off" || value === "error" || value === "warning" || value === "message" || value === "suggestion"
-      )
+      filter(([_, value]) => isValidSeverityLevel(value))
     )
   );
 }
@@ -1173,6 +1174,7 @@ var defaults = {
   diagnostics: true,
   diagnosticSeverity: {},
   diagnosticsName: true,
+  missingDiagnosticNextLine: "warning",
   quickinfo: true,
   quickinfoEffectParameters: "whentruncated",
   quickinfoMaximumLength: -1,
@@ -1215,6 +1217,7 @@ function parse(config) {
     diagnostics: isObject(config) && hasProperty(config, "diagnostics") && isBoolean(config.diagnostics) ? config.diagnostics : defaults.diagnostics,
     diagnosticSeverity: isObject(config) && hasProperty(config, "diagnosticSeverity") && isRecord(config.diagnosticSeverity) ? parseDiagnosticSeverity(config.diagnosticSeverity) : defaults.diagnosticSeverity,
     diagnosticsName: isObject(config) && hasProperty(config, "diagnosticsName") && isBoolean(config.diagnosticsName) ? config.diagnosticsName : defaults.diagnosticsName,
+    missingDiagnosticNextLine: isObject(config) && hasProperty(config, "missingDiagnosticNextLine") && isString(config.missingDiagnosticNextLine) && isValidSeverityLevel(config.missingDiagnosticNextLine) ? config.missingDiagnosticNextLine : defaults.missingDiagnosticNextLine,
     quickinfo: isObject(config) && hasProperty(config, "quickinfo") && isBoolean(config.quickinfo) ? config.quickinfo : defaults.quickinfo,
     quickinfoEffectParameters: isObject(config) && hasProperty(config, "quickinfoEffectParameters") && isString(config.quickinfoEffectParameters) && ["always", "never", "whentruncated"].includes(config.quickinfoEffectParameters.toLowerCase()) ? config.quickinfoEffectParameters.toLowerCase() : defaults.quickinfoEffectParameters,
     quickinfoMaximumLength: isObject(config) && hasProperty(config, "quickinfoMaximumLength") && isNumber(config.quickinfoMaximumLength) ? config.quickinfoMaximumLength : defaults.quickinfoMaximumLength,
@@ -1888,7 +1891,8 @@ var createDiagnosticExecutor = fn("LSP.createCommentDirectivesProcessor")(
                   lineOverrides[ruleName].unshift({
                     pos: foundNode.node.pos,
                     end: foundNode.node.end,
-                    level: ruleLevel
+                    level: ruleLevel,
+                    commentRange: foundNode.commentRange
                   });
                 }
               } else {
@@ -1961,6 +1965,7 @@ var createDiagnosticExecutor = fn("LSP.createCommentDirectivesProcessor")(
           fixes: entry.fixes.concat(node ? [fixByDisableNextLine(node)] : []).concat([fixByDisableEntireFile])
         });
       });
+      const unusedLineOverrides = new Set(lineOverrides[ruleNameLowered] || []);
       for (const emitted of applicableDiagnostics.slice(0)) {
         let newLevel = defaultLevel;
         const lineOverride = (lineOverrides[ruleNameLowered] || []).find(
@@ -1968,6 +1973,7 @@ var createDiagnosticExecutor = fn("LSP.createCommentDirectivesProcessor")(
         );
         if (lineOverride) {
           newLevel = lineOverride.level;
+          unusedLineOverrides.delete(lineOverride);
         } else {
           const sectionOverride = (sectionOverrides[ruleNameLowered] || []).find((_) => _.pos < emitted.range.pos);
           if (sectionOverride) newLevel = sectionOverride.level;
@@ -1991,6 +1997,19 @@ var createDiagnosticExecutor = fn("LSP.createCommentDirectivesProcessor")(
           });
         }
       }
+      if (pluginOptions.missingDiagnosticNextLine !== "off" && unusedLineOverrides.size > 0) {
+        for (const unusedLineOverride of unusedLineOverrides) {
+          diagnostics2.push({
+            file: sourceFile,
+            start: unusedLineOverride.commentRange.pos,
+            length: unusedLineOverride.commentRange.end - unusedLineOverride.commentRange.pos,
+            messageText: `@effect-diagnostics-next-line ${rule.name}:${unusedLineOverride.level} has no effect, make sure you are suppressing the right rule.`,
+            category: levelToDiagnosticCategory[pluginOptions.missingDiagnosticNextLine],
+            code: -1,
+            source: "effect"
+          });
+        }
+      }
       return { diagnostics: diagnostics2, codeFixes };
     });
     return { execute };
@@ -4044,6 +4063,7 @@ var leakingRequirements = createDiagnostic({
     const typeChecker = yield* service(TypeCheckerApi);
     const typeCheckerUtils = yield* service(TypeCheckerUtils);
     const typeParser = yield* service(TypeParser);
+    const tsUtils = yield* service(TypeScriptUtils);
     const parseLeakedRequirements = cachedBy(
       fn("leakingServices.checkServiceLeaking")(
         function* (service2, atLocation) {
@@ -4101,7 +4121,21 @@ var leakingRequirements = createDiagnostic({
             }
           }
           if (sharedRequirementsKeys && sharedRequirementsKeys.length > 0 && effectMembers >= 2) {
-            return sharedRequirementsKeys.map((key) => memory.get(key));
+            return sharedRequirementsKeys.map((key) => memory.get(key)).filter(
+              (type) => {
+                let symbol3 = type.symbol;
+                if (symbol3 && symbol3.flags & ts.SymbolFlags.Alias) {
+                  symbol3 = typeChecker.getAliasedSymbol(symbol3);
+                }
+                return !(symbol3.declarations || []).some((declaration) => {
+                  const declarationSource = tsUtils.getSourceFileOfNode(declaration);
+                  if (!declarationSource) return false;
+                  return declarationSource.text.substring(declaration.pos, declaration.end).toLowerCase().indexOf(
+                    "@effect-leakable-service"
+                  ) > -1;
+                });
+              }
+            );
           }
           return [];
         }
@@ -4114,7 +4148,7 @@ var leakingRequirements = createDiagnostic({
       report({
         location: node,
         messageText: `This Service is leaking the ${requirements.map((_) => typeChecker.typeToString(_)).join(" | ")} requirement.
-If these requirements cannot be cached and are expected to be provided per method invocation (e.g. HttpServerRequest), you can safely disable this diagnostic for this line through quickfixes.
+If these requirements cannot be cached and are expected to be provided per method invocation (e.g. HttpServerRequest), you can either safely disable this diagnostic for this line through quickfixes or mark the service declaration with a JSDoc @effect-leakable-service.
 More info at https://effect.website/docs/requirements-management/layers/#avoiding-requirement-leakage`,
         fixes: []
       });