@effect/language-service 0.79.0 → 0.80.0

package/README.md

@@ -10,6 +10,7 @@ This package implements a TypeScript language service plugin that allows additio
 2. Inside your tsconfig.json, you should add the plugin configuration as follows:
 ```jsonc
 {
+  "$schema": "https://raw.githubusercontent.com/Effect-TS/language-service/refs/heads/main/schema.json",
   "compilerOptions": {
     "plugins": [
       // ... other LSPs (if any) and as last
@@ -231,13 +232,13 @@ so that across updates the patch will be re-applied again.
 The effect language service plugin comes with a builtin CLI tool that can be used to perform various utilities, checks and setups. Since it relies on typescript, we recommend to install it locally and run it locally to ensure it loads the same typescript version of your project rather than a global installation that may resolve to use a different TS version from the one of your project.
 
 ### `effect-language-service setup`
-Runs through a wizard to setup/update some basic functionalities of the LSP in an interactive way.
+Runs through a wizard to setup/update some basic functionalities of the LSP in an interactive way. This also keeps the `tsconfig.json` `$schema` aligned with the published Effect Language Service schema.
 
 ### `effect-language-service codegen`
 Automatically updates Effect codegens in your TypeScript files. This command scans files for `@effect-codegens` directives and applies the necessary code transformations. Use `--file` to update a specific file, or `--project` with a tsconfig file to update an entire project. The `--verbose` flag provides detailed output about which files are being processed and updated.
 
 ### `effect-language-service diagnostics`
-Provides a way to get through a CLI the list of Effect specific diagnostics; without patching your typescript installation. A --file option may be used to get diagnostics for a specific file, or --project with a tsconfig file to get an entire project.
+Provides a way to get through a CLI the list of Effect specific diagnostics; without patching your typescript installation. A `--file` option may be used to get diagnostics for a specific file, or `--project` with a tsconfig file to get an entire project. You can also pass `--lspconfig '{ "effectFn": ["untraced"] }'` to override the project plugin configuration inline for that diagnostics run.
 
 ### `effect-language-service quickfixes`
 Shows diagnostics that have available quick fixes along with their proposed code changes. This is useful for previewing what fixes the language service can apply to your code. Use `--file` to check a specific file, or `--project` with a tsconfig file to check an entire project. The output displays each diagnostic with its location and the diff of proposed changes.

package/cli.js

@@ -25719,7 +25719,7 @@ var runWith2 = (command, config) => {
 // package.json
 var package_default = {
   name: "@effect/language-service",
-  version: "0.79.0",
+  version: "0.80.0",
   publishConfig: {
     access: "public",
     directory: "dist"
@@ -25747,13 +25747,13 @@ var package_default = {
   ],
   scripts: {
     build: "tsup",
-    codegen: "node --import tsx ./scripts/generate-diagnostics-readme-table.ts",
+    codegen: "node --import tsx ./scripts/codegen.ts",
     dev: "tsup --watch",
     clean: "rimraf dist build .tsbuildinfo",
     lint: "eslint src test",
     "lint-fix": "eslint src test --fix",
     check: "tsc -b tsconfig.json",
-    "check:codegen": "node --import tsx ./scripts/generate-diagnostics-readme-table.ts --check",
+    "check:codegen": "node --import tsx ./scripts/codegen.ts --check",
     circular: "madge --extensions ts --circular --no-color --no-spinner --warning src",
     test: "vitest",
     "test-update": "vitest --update",
@@ -27536,6 +27536,145 @@ var defaults = {
   mermaidProvider: "mermaid.live",
   skipDisabledOptimization: false
 };
+var booleanSchema = (description, defaultValue) => ({
+  type: "boolean",
+  description,
+  default: defaultValue
+});
+var stringArraySchema = (description, defaultValue) => ({
+  type: "array",
+  description,
+  default: defaultValue,
+  items: { type: "string" }
+});
+var stringEnumSchema = (description, values2, defaultValue) => ({
+  type: "string",
+  description,
+  enum: values2,
+  default: defaultValue
+});
+var languageServicePluginAdditionalPropertiesJsonSchema = {
+  refactors: booleanSchema("Controls Effect refactors.", defaults.refactors),
+  diagnostics: booleanSchema("Controls Effect diagnostics.", defaults.diagnostics),
+  diagnosticsName: booleanSchema(
+    "Controls whether to include the rule name in diagnostic messages.",
+    defaults.diagnosticsName
+  ),
+  missingDiagnosticNextLine: stringEnumSchema(
+    "Controls the severity of warnings for unused @effect-diagnostics-next-line comments.",
+    ["off", "error", "warning", "message", "suggestion"],
+    defaults.missingDiagnosticNextLine
+  ),
+  includeSuggestionsInTsc: booleanSchema(
+    "When patch mode is enabled, reports suggestion diagnostics as messages in TSC with a [suggestion] prefix.",
+    defaults.includeSuggestionsInTsc
+  ),
+  ignoreEffectWarningsInTscExitCode: booleanSchema(
+    "When enabled, Effect warnings do not affect the patched tsc exit code.",
+    defaults.ignoreEffectWarningsInTscExitCode
+  ),
+  ignoreEffectErrorsInTscExitCode: booleanSchema(
+    "When enabled, Effect errors do not affect the patched tsc exit code.",
+    defaults.ignoreEffectErrorsInTscExitCode
+  ),
+  ignoreEffectSuggestionsInTscExitCode: booleanSchema(
+    "When enabled, Effect suggestions do not affect the patched tsc exit code.",
+    defaults.ignoreEffectSuggestionsInTscExitCode
+  ),
+  quickinfoEffectParameters: stringEnumSchema(
+    "Controls when Effect quickinfo should include full type parameters.",
+    ["always", "never", "whentruncated"],
+    defaults.quickinfoEffectParameters
+  ),
+  quickinfo: booleanSchema("Controls Effect quickinfo.", defaults.quickinfo),
+  quickinfoMaximumLength: {
+    type: "number",
+    description: "Controls the maximum quickinfo length. Use -1 to disable truncation.",
+    default: defaults.quickinfoMaximumLength
+  },
+  keyPatterns: {
+    type: "array",
+    description: "Configures key patterns used for generated Effect service and error keys.",
+    default: defaults.keyPatterns,
+    items: {
+      type: "object",
+      properties: {
+        target: stringEnumSchema("The key builder target.", ["service", "error", "custom"], "service"),
+        pattern: stringEnumSchema(
+          "The key generation pattern.",
+          ["package-identifier", "default", "default-hashed"],
+          "default"
+        ),
+        skipLeadingPath: stringArraySchema("Path prefixes to strip before generating keys.", ["src/"])
+      }
+    }
+  },
+  extendedKeyDetection: booleanSchema(
+    "Enables extended heuristics when detecting key sources.",
+    defaults.extendedKeyDetection
+  ),
+  completions: booleanSchema("Controls Effect completions.", defaults.completions),
+  goto: booleanSchema("Controls Effect goto references support.", defaults.goto),
+  inlays: booleanSchema("Controls Effect inlay hints.", defaults.inlays),
+  allowedDuplicatedPackages: stringArraySchema(
+    "Package names that are allowed to duplicate Effect as a peer dependency.",
+    defaults.allowedDuplicatedPackages
+  ),
+  namespaceImportPackages: stringArraySchema(
+    "Package names that should prefer namespace imports.",
+    defaults.namespaceImportPackages
+  ),
+  topLevelNamedReexports: stringEnumSchema(
+    "For namespaceImportPackages, controls how top-level named re-exports are handled.",
+    ["ignore", "follow"],
+    defaults.topLevelNamedReexports
+  ),
+  barrelImportPackages: stringArraySchema(
+    "Package names that should prefer imports from their top-level barrel file.",
+    defaults.barrelImportPackages
+  ),
+  importAliases: {
+    type: "object",
+    description: "Custom aliases to use for imported identifiers.",
+    default: defaults.importAliases,
+    additionalProperties: {
+      type: "string"
+    }
+  },
+  renames: booleanSchema("Controls Effect rename helpers.", defaults.renames),
+  noExternal: booleanSchema(
+    "Disables features that link to external websites.",
+    defaults.noExternal
+  ),
+  pipeableMinArgCount: {
+    type: "number",
+    description: "Minimum argument count required before pipeable suggestions are emitted.",
+    default: defaults.pipeableMinArgCount
+  },
+  effectFn: {
+    type: "array",
+    description: "Configures which Effect.fn variants should be suggested.",
+    default: defaults.effectFn,
+    items: {
+      type: "string",
+      enum: ["untraced", "span", "suggested-span", "inferred-span", "no-span"]
+    }
+  },
+  layerGraphFollowDepth: {
+    type: "number",
+    description: "Controls how deeply layer graph analysis follows dependencies.",
+    default: defaults.layerGraphFollowDepth
+  },
+  mermaidProvider: {
+    type: "string",
+    description: "Controls which Mermaid renderer is used for layer graphs.",
+    default: defaults.mermaidProvider
+  },
+  skipDisabledOptimization: booleanSchema(
+    "When enabled, disabled diagnostics are still processed so comment-based overrides can be honored.",
+    defaults.skipDisabledOptimization
+  )
+};
 function parseKeyPatterns(patterns) {
   const result3 = [];
   for (const entry of patterns) {
@@ -37145,6 +37284,11 @@ var DiagnosticsFoundError = class extends TaggedError2("DiagnosticsFoundError")
     return `Found ${this.errorsCount} errors, ${this.warningsCount} warnings and ${this.messagesCount} messages.`;
   }
 };
+var InvalidLspConfigError = class extends TaggedError2("InvalidLspConfigError") {
+  get message() {
+    return `Invalid JSON lsp config: ${this.lspconfig}`;
+  }
+};
 var categoryToSeverity = (category, tsInstance) => {
   switch (category) {
     case tsInstance.DiagnosticCategory.Error:
@@ -37340,9 +37484,15 @@ var diagnostics2 = Command_exports.make(
     progress: Flag_exports.boolean("progress").pipe(
       Flag_exports.withDefault(false),
       Flag_exports.withDescription("Show progress as files are checked (outputs to stderr)")
+    ),
+    lspconfig: Flag_exports.string("lspconfig").pipe(
+      Flag_exports.optional,
+      Flag_exports.withDescription(
+        `An optional inline JSON lsp config that replaces the current project lsp config. e.g. '{ "effectFn": ["untraced"] }'`
+      )
     )
   },
-  fn2("diagnostics")(function* ({ file: file4, format: format3, progress, project: project2, severity, strict }) {
+  fn2("diagnostics")(function* ({ file: file4, format: format3, lspconfig, progress, project: project2, severity, strict }) {
     const path4 = yield* Path;
     const severityFilter = parseSeverityFilter(severity);
     const state = {
@@ -37406,7 +37556,14 @@ var diagnostics2 = Command_exports.make(
           if (!program) continue;
           const sourceFile = program.getSourceFile(filePath);
           if (!sourceFile) continue;
-          const pluginConfig = extractEffectLspOptions(program.getCompilerOptions());
+          let pluginConfig = extractEffectLspOptions(program.getCompilerOptions());
+          if (isSome2(lspconfig)) {
+            try {
+              pluginConfig = { name: "@effect/language-service", ...JSON.parse(lspconfig.value) };
+            } catch {
+              return yield* new InvalidLspConfigError({ lspconfig: lspconfig.value });
+            }
+          }
           if (!pluginConfig) continue;
           const rawResults = pipe(
             getSemanticDiagnosticsWithCodeFixes(diagnostics, sourceFile),
@@ -39690,6 +39847,7 @@ var assess = (input) => gen2(function* () {
 });
 
 // src/cli/setup/changes.ts
+var TSCONFIG_SCHEMA_URL = "https://raw.githubusercontent.com/Effect-TS/language-service/refs/heads/main/schema.json";
 function emptyFileChangesResult() {
   return {
     codeActions: [],
@@ -40036,8 +40194,17 @@ var computeTsConfigChanges = (current, target, lspVersion) => {
     const fileChanges = textChanges.ChangeTracker.with(
       { host, formatContext, preferences },
       (tracker) => {
+        const schemaProperty = findPropertyInObject(ts, rootObj, "$schema");
         const pluginsProperty = findPropertyInObject(ts, compilerOptions, "plugins");
+        const schemaPropertyAssignment = ts.factory.createPropertyAssignment(
+          ts.factory.createStringLiteral("$schema"),
+          ts.factory.createStringLiteral(TSCONFIG_SCHEMA_URL)
+        );
         if (isNone2(lspVersion)) {
+          if (schemaProperty) {
+            descriptions.push("Remove $schema from tsconfig");
+            deleteNodeFromList(tracker, current.sourceFile, rootObj.properties, schemaProperty);
+          }
           if (pluginsProperty && ts.isArrayLiteralExpression(pluginsProperty.initializer)) {
             const pluginsArray = pluginsProperty.initializer;
             const lspPluginElement = pluginsArray.elements.find((element) => {
@@ -40055,6 +40222,13 @@ var computeTsConfigChanges = (current, target, lspVersion) => {
             }
           }
         } else {
+          if (!schemaProperty) {
+            descriptions.push("Add $schema to tsconfig");
+            insertNodeAtEndOfList(tracker, current.sourceFile, rootObj.properties, schemaPropertyAssignment);
+          } else if (!ts.isStringLiteral(schemaProperty.initializer) || schemaProperty.initializer.text !== TSCONFIG_SCHEMA_URL) {
+            descriptions.push("Update $schema in tsconfig");
+            tracker.replaceNode(current.sourceFile, schemaProperty.initializer, schemaPropertyAssignment.initializer);
+          }
           const buildPluginObject = (severities) => {
             const nameProperty = ts.factory.createPropertyAssignment(
               ts.factory.createStringLiteral("name"),