@effect/language-service 0.44.1 → 0.45.0

package/README.md

@@ -282,6 +282,27 @@ The skipLeadingPath array can contain a set of prefixes to remove from the subpa
 
 This pattern uses the package name + identifier. This usually works great if you have a flat structure, with one file per service/error.
 
+## Using Key Patterns in custom API definitions
+
+You can enforce and take advantage of the deterministicKeys rule also in your own custom API that provide an `extends MyApi("identifier")`-like experience, so basically only in extends clause of class declarations.
+
+To do so, first you need to enable `extendedKeyDetection: true` in plugin options to enable slower detection of this custom patterns.
+
+And then you'll need to add a JSDoc `/** @effect-identifier */` to the parameter where you expect to receive string identifier.
+
+Let's say for example that you want to provide a Repository() API that is basically the same of Context.Tag, but prefixes the key identifier with 'Repository/'; the definition of the Resource API would be something like this:
+
+```ts
+export function Repository(/** @effect-identifier */ identifier: string) {
+  return Context.Tag("Repository/" + identifier)
+}
+```
+
+and will be used as follows:
+```ts
+export class UserRepo extends Repository("Hello")<UserRepo, { /** ... */ }>() {}
+```
+
 ## Known gotchas
 
 ### Svelte VSCode extension and SvelteKit

package/effect-lsp-patch-utils.js

@@ -1190,14 +1190,19 @@ var defaults = {
     target: "service",
     pattern: "default",
     skipLeadingPath: ["src/"]
-  }]
+  }, {
+    target: "custom",
+    pattern: "default",
+    skipLeadingPath: ["src/"]
+  }],
+  extendedKeyDetection: false
 };
 function parseKeyPatterns(patterns) {
   const result = [];
   for (const entry of patterns) {
     if (!isObject(entry)) continue;
     result.push({
-      target: hasProperty(entry, "target") && isString(entry.target) && ["service", "error"].includes(entry.target.toLowerCase()) ? entry.target.toLowerCase() : "service",
+      target: hasProperty(entry, "target") && isString(entry.target) && ["service", "error", "custom"].includes(entry.target.toLowerCase()) ? entry.target.toLowerCase() : "service",
       pattern: hasProperty(entry, "pattern") && isString(entry.pattern) && ["package-identifier", "default"].includes(entry.pattern.toLowerCase()) ? entry.pattern.toLowerCase() : "default",
       skipLeadingPath: hasProperty(entry, "skipLeadingPath") && isArray(entry.skipLeadingPath) && entry.skipLeadingPath.every(isString) ? entry.skipLeadingPath : ["src/"]
     });
@@ -1223,7 +1228,8 @@ function parse(config) {
     topLevelNamedReexports: isObject(config) && hasProperty(config, "topLevelNamedReexports") && isString(config.topLevelNamedReexports) && ["ignore", "follow"].includes(config.topLevelNamedReexports.toLowerCase()) ? config.topLevelNamedReexports.toLowerCase() : defaults.topLevelNamedReexports,
     renames: isObject(config) && hasProperty(config, "renames") && isBoolean(config.renames) ? config.renames : defaults.renames,
     noExternal: isObject(config) && hasProperty(config, "noExternal") && isBoolean(config.noExternal) ? config.noExternal : defaults.noExternal,
-    keyPatterns: isObject(config) && hasProperty(config, "keyPatterns") && isArray(config.keyPatterns) ? parseKeyPatterns(config.keyPatterns) : defaults.keyPatterns
+    keyPatterns: isObject(config) && hasProperty(config, "keyPatterns") && isArray(config.keyPatterns) ? parseKeyPatterns(config.keyPatterns) : defaults.keyPatterns,
+    extendedKeyDetection: isObject(config) && hasProperty(config, "extendedKeyDetection") && isBoolean(config.extendedKeyDetection) ? config.extendedKeyDetection : defaults.extendedKeyDetection
   };
 }
 
@@ -3551,6 +3557,62 @@ var deterministicKeys = createDiagnostic({
   apply: fn("deterministicKeys.apply")(function* (sourceFile, report) {
     const ts = yield* service(TypeScriptApi);
     const typeParser = yield* service(TypeParser);
+    const typeChecker = yield* service(TypeCheckerApi);
+    const typeScriptUtils = yield* service(TypeScriptUtils);
+    const options = yield* service(LanguageServicePluginOptions);
+    const parseExtendsCustom = cachedBy(
+      fn("parseExtendsCustom")(function* (classDeclaration) {
+        if (!options.extendedKeyDetection) {
+          return yield* typeParserIssue("Extended key detection is disabled", void 0, classDeclaration);
+        }
+        if (!classDeclaration.name) {
+          return yield* typeParserIssue("Class has no name", void 0, classDeclaration);
+        }
+        if (!ts.isIdentifier(classDeclaration.name)) {
+          return yield* typeParserIssue("Class name is not an identifier", void 0, classDeclaration);
+        }
+        const heritageClauses = classDeclaration.heritageClauses;
+        if (!heritageClauses) {
+          return yield* typeParserIssue("Class has no heritage clauses", void 0, classDeclaration);
+        }
+        const nodeToVisit2 = [...classDeclaration.heritageClauses];
+        const appendNodeToVisit2 = (node) => {
+          nodeToVisit2.push(node);
+          return void 0;
+        };
+        while (nodeToVisit2.length > 0) {
+          const node = nodeToVisit2.shift();
+          if (ts.isCallExpression(node)) {
+            for (let i = 0; i < node.arguments.length; i++) {
+              const arg = node.arguments[i];
+              if (!ts.isStringLiteral(arg)) continue;
+              const resolvedSignature = typeChecker.getResolvedSignature(node);
+              if (resolvedSignature) {
+                const parameter = resolvedSignature.parameters[i];
+                if (!parameter) continue;
+                if (parameter.declarations) {
+                  for (const declaration of parameter.declarations) {
+                    const parameterSourceFile = typeScriptUtils.getSourceFileOfNode(declaration);
+                    const paramText = parameterSourceFile.text.substring(declaration.pos, declaration.end);
+                    if (paramText.toLowerCase().includes("@effect-identifier")) {
+                      return { className: classDeclaration.name, keyStringLiteral: arg, target: "custom" };
+                    }
+                  }
+                }
+              }
+            }
+          }
+          ts.forEachChild(node, appendNodeToVisit2);
+        }
+        return yield* typeParserIssue(
+          "Class does not extend any custom pattern",
+          void 0,
+          classDeclaration
+        );
+      }),
+      "deterministicKeys.parseExtendsCustom",
+      (classDeclaration) => classDeclaration
+    );
     const nodeToVisit = [];
     const appendNodeToVisit = (node) => {
       nodeToVisit.push(node);
@@ -3574,12 +3636,13 @@ var deterministicKeys = createDiagnostic({
               map4(({ className, keyStringLiteral }) => ({ keyStringLiteral, className, target: "error" }))
             )
           ),
+          orElse2(() => parseExtendsCustom(node)),
           orElse2(() => void_)
         );
         if (result && result.keyStringLiteral) {
-          const { className, keyStringLiteral } = result;
+          const { className, keyStringLiteral, target } = result;
           const classNameText = ts.idText(className);
-          const expectedKey = yield* createString(sourceFile, classNameText, result.target);
+          const expectedKey = yield* createString(sourceFile, classNameText, target);
           if (!expectedKey) continue;
           const actualIdentifier = keyStringLiteral.text;
           if (actualIdentifier !== expectedKey) {