@effect/language-service 0.45.1 → 0.47.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.)
@@ -154,7 +156,7 @@ If everything goes smoothly, something along these lines should be printed out:
 /node_modules/typescript/lib/_tsc.js patched successfully.
 ```
 
-Now the CLI has patched the tsc binary and the typescript library to raise effect diagnostics even at build time if the plugin is configured in your tsconfig!
+Now the CLI has patched the tsc binary and the typescript library to raise Effect diagnostics even at build time if the plugin is configured in your tsconfig!
 
 As the command output suggests, you may need to delete your tsbuildinfo files or perform a full rebuild in order to re-check previously existing files.
 
@@ -202,13 +204,29 @@ index.ts:3:1 - error TS3: Effect must be yielded or assigned to a variable.
 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.
+
+### `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.
+
+### `effect-language-service check`
+This command runs a check of the setup of the patching mechanism of the LSP, to understand if typescript has been patched or not.
+
+### `effect-language-service patch`
+Patches (or re-patches) your local TypeScript installation to provide Effect diagnostics at build time.
+
+### `effect-language-service unpatch`
+Revery any previously applied patch to the local TypeScript installation.
+
 ## Configuring diagnostics
 
 You can either disable or change the severity of specific diagnostics by using comments in your code.
 
 ```ts
 // @effect-diagnostics effect/floatingEffect:off
-Effect.succeed(1); // This will not be reported as a floating effect
+Effect.succeed(1); // This will not be reported as a floating Effect
 
 // @effect-diagnostics effect/floatingEffect:error
 Effect.succeed(1); // This will be reported as a floating effect
@@ -303,6 +321,7 @@ and will be used as follows:
 export class UserRepo extends Repository("Hello")<UserRepo, { /** ... */ }>() {}
 ```
 
+
 ## Known gotchas
 
 ### Svelte VSCode extension and SvelteKit