Skip to content

Latest commit

 

History

History
64 lines (52 loc) · 1.54 KB

floating-effect-in-vitest.md

File metadata and controls

64 lines (52 loc) · 1.54 KB

floatingEffectInVitest

Detects Effects returned from non-Effect-aware Vitest callbacks

Property Value
Category Correctness
Default severity error
Fixable No
Effect versions v3, v4
Diagnostic codes TS377105
Language Service name floatingEffectInVitest
Oxlint name effecttsgo/floating-effect-in-vitest

Preview

import { it } from "@effect/vitest"
import { Effect } from "effect"

it("does not execute", () => Effect.void)
/**
                             ^^^^^^^^^^^ effecttsgo(floating-effect-in-vitest): This Vitest callback returns an Effect that Vitest does not run. Use an Effect-aware test API or run the Effect with Effect.runPromise.
*/

Language Service Configuration

See the Language Service setup guide for installation instructions.

{
  "$schema": "./node_modules/@effect/tsgo/schema.json",
  "compilerOptions": {
    "plugins": [
      {
        "name": "@effect/language-service",
        "diagnosticSeverity": {
          "floatingEffectInVitest": "warning"
        }
      }
    ]
  }
}

Oxlint Configuration

See the Oxlint setup guide for installation and patching instructions.

{
  "$schema": "./node_modules/@effect/tsgo/oxlint-schema.json",
  "options": {
    "typeAware": true
  },
  "plugins": ["effecttsgo"],
  "rules": {
    "effecttsgo/floating-effect-in-vitest": "warn"
  }
}