@effect/language-service 0.64.1 → 0.65.0

package/README.md

@@ -78,6 +78,8 @@ And you're done! You'll now be able to use a set of refactors and diagnostics th
 - Warn when using `yield* Effect.fail()` with yieldable error types that can be yielded directly
 - Warn when using `Effect.fail` with the global `Error` type, recommending tagged errors
 - Warn when `Layer.mergeAll` contains layers with interdependencies (where one layer provides a service that another layer in the same call requires)
+- Suggest using `Effect.fn` for functions that return `Effect.gen` for better tracing and concise syntax
+- Suggest removing redundant identifier argument when it equals the tag value in `Schema.TaggedClass`, `Schema.TaggedError`, or `Schema.TaggedRequest`
 
 ### Completions
 
@@ -133,7 +135,7 @@ Few options can be provided alongside the initialization of the Language Service
         },
         "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)
-        "reportSuggestionsAsWarningsInTsc": false, // when enabled, diagnostics with "suggestion" or "message" severity will be reported as "warning" in TSC with "[suggestion]" prefix (default: false)
+        "includeSuggestionsInTsc": true, // when enabled with effect-language-service patch enabled, diagnostics with "suggestion" severity will be reported as "message" in TSC with "[suggestion]" prefix; useful to help steer LLM output (default: true)
         "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.)
@@ -163,11 +165,8 @@ The full list can be found in the [diagnostics](https://github.com/Effect-TS/lan
 
 TypeScript LSPs are loaded only while editing your files. That means that if you run `tsc` in your project, the plugin won't be loaded and you'll miss out on the Effect diagnostics.
 
-We provide two approaches to solve this scenario.
 
-### Option A - Effect LSP Cli Patch (experimental recommended)
-
-This option works by modifing directly the source code of the tsc compiler and the typescript library in your project node_modules. This allows to get effect's diagnostics even when noEmit is enabled, for composite and incremental projects as well.
+To solve this we modify directly the source code of the tsc compiler and the typescript library in your project node_modules. This allows to get effect's diagnostics even when noEmit is enabled, for composite and incremental projects as well.
 
 After having installed and configured the LSP for editor usage, you can run the following command inside the folder that contains your local project typescript installation:
 
@@ -194,40 +193,6 @@ To make the patch persistent across package installations and updates, we recomm
 
 so that across updates the patch will be re-applied again.
 
-### Option B - Using ts-patch
-
-if you use `ts-patch` you can enable the transform as well to get the diagnostics also at compile time.
-Your `tsconfig.json` should look like this:
-
-```jsonc
-{
-  "compilerOptions": {
-    "plugins": [
-      {
-        "name": "@effect/language-service",
-        "transform": "@effect/language-service/transform" // enables diagnostics at compile time when using ts-patch
-      }
-    ]
-  }
-}
-```
-
-To get diagnostics you need to install `ts-patch` which will make it possible to run `tspc`.
-
-Running `tspc` in your project will now also run the plugin and give you the error diagnostics at compile time.
-Effect error diagnostics will be shown only after standard TypeScript diagnostics have been satisfied.
-Beware that setting noEmit will completely skip the effect diagnostics, and projects using incremental builds may encounter some issues.
-
-```ts
-$ npx tspc
-index.ts:3:1 - error TS3: Effect must be yielded or assigned to a variable.
-
-3 Effect.succeed(1)
-  ~~~~~~~~~~~~~~~~~
-
-Found 1 error in index.ts:3 
-```
-
 ## Effect-Language-Service CLI
 
 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.
@@ -291,6 +256,30 @@ Layers (2)
     Complete application layer
 ```
 
+### `effect-language-service layerinfo`
+This command provides detailed information about a specific exported layer, including what services it provides, what it requires, and a suggested composition order. Use `--file` to specify the file and `--name` to specify the layer name.
+
+Example output:
+```
+AppLive
+  ./src/layers/app.ts:39:14
+  Layer<Cache | UserRepository, never, never>
+
+Provides (2):
+  - Cache
+  - UserRepository
+
+Suggested Composition:
+  UserRepository.Default.pipe(
+    Layer.provide(DbConnection.Default),
+    Layer.provideMerge(Cache.Default),
+    Layer.provide(FileSystem.Default)
+  )
+
+Tip: Not sure you got your composition right? Just write all layers inside a Layer.mergeAll(...)
+command, and then run the layerinfo command to get the suggested composition order to use.
+```
+
 ## Configuring diagnostics
 
 You can either disable or change the severity of specific diagnostics by using comments in your code.