oxlint-plugin-effect 0.0.0 → 0.1.0

package/src/rules/no-global-fetch.ts

@@ -1,14 +0,0 @@
-/**
- * Ban bare `fetch()` calls.
- *
- * Use Effect HttpClient service instead.
- *
- * Source: language-service/globalFetch
- */
-import { Rule } from "../vendor/effect-oxlint/index.js"
-
-export const noGlobalFetch = Rule.banCallOf("fetch", {
-  message:
-    "Avoid global fetch. Use HttpClient from 'effect/unstable/http'.",
-  meta: { type: "suggestion" },
-})

package/src/rules/no-global-random.ts

@@ -1,13 +0,0 @@
-/**
- * Ban `Math.random()`.
- *
- * Use Effect Random service instead.
- *
- * Source: language-service/globalRandom
- */
-import { Rule } from "../vendor/effect-oxlint/index.js"
-
-export const noGlobalRandom = Rule.banMember("Math", "random", {
-  message: "Avoid Math.random(). Use Random service.",
-  meta: { type: "suggestion" },
-})

package/src/rules/no-global-timers.ts

@@ -1,17 +0,0 @@
-/**
- * Ban `setTimeout` and `setInterval`.
- *
- * Use Effect Schedule or Effect.sleep instead.
- *
- * Source: language-service/globalTimers
- */
-import { Rule } from "../vendor/effect-oxlint/index.js"
-
-export const noGlobalTimers = Rule.banCallOf(
-  ["setTimeout", "setInterval"],
-  {
-    message:
-      "Avoid setTimeout/setInterval. Use Effect.sleep or Schedule.",
-    meta: { type: "suggestion" },
-  },
-)

package/src/rules/no-json-in-effect.ts

@@ -1,45 +0,0 @@
-/**
- * Ban `JSON.parse`/`JSON.stringify` inside Effect.gen/fn context.
- *
- * Use Schema.fromJsonString for type-safe JSON.
- *
- * Source: language-service/preferSchemaOverJson (inside Effect context)
- */
-import type { ESTree } from "@oxlint/plugins"
-import { AST, Diagnostic, Rule, Visitor } from "../vendor/effect-oxlint/index.js"
-import { RuleContext } from "../vendor/effect-oxlint/index.js"
-import * as Effect from "effect/Effect"
-import * as Option from "effect/Option"
-import * as Ref from "effect/Ref"
-
-import { makeEffectContextTracker } from "./_effect-context.js"
-
-export const noJsonInEffect = Rule.define({
-  name: "no-json-in-effect",
-  meta: Rule.meta({
-    type: "suggestion",
-    description: "Avoid JSON.parse/stringify inside Effect.gen/fn. Use Schema.fromJsonString.",
-  }),
-  create: function* () {
-    const ctx = yield* RuleContext
-    const [depth, tracker] = yield* makeEffectContextTracker
-
-    return Visitor.merge(tracker, {
-      MemberExpression: (node) =>
-        Effect.flatMap(Ref.get(depth), (d) => {
-          if (
-            d > 0 &&
-            Option.isSome(AST.matchMember(node as ESTree.MemberExpression, "JSON", ["parse", "stringify"]))
-          ) {
-            return ctx.report(
-              Diagnostic.make({
-                node,
-                message: "Avoid JSON.parse/stringify inside Effect context. Use Schema.fromJsonString.",
-              }),
-            )
-          }
-          return Effect.void
-        }),
-    })
-  },
-})

package/src/rules/no-json-parse.ts

@@ -1,18 +0,0 @@
-/**
- * Ban `JSON.parse` and `JSON.stringify`.
- *
- * Use Schema.fromJsonString for type-safe JSON handling.
- *
- * Source: language-service/preferSchemaOverJson
- */
-import { Rule } from "../vendor/effect-oxlint/index.js"
-
-export const noJsonParse = Rule.banMember(
-  "JSON",
-  ["parse", "stringify"],
-  {
-    message:
-      "Avoid JSON.parse/stringify. Use Schema.fromJsonString for type-safe JSON.",
-    meta: { type: "suggestion" },
-  },
-)

package/src/rules/no-platform-globals.ts

@@ -1,117 +0,0 @@
-/**
- * Ban platform-specific global access inside Effect.gen/fn context.
- *
- * Catches `Bun.*`, `process.*`, `Deno.*` — any runtime-specific API
- * that should be wrapped in an Effect service for testability and portability.
- *
- * Provides Effect alternative hints where known.
- *
- * Sources: language-service/processEnv, processEnvInEffect + generalized
- */
-import type { ESTree } from "@oxlint/plugins"
-import { AST, Diagnostic, Rule, Visitor } from "../vendor/effect-oxlint/index.js"
-import { RuleContext } from "../vendor/effect-oxlint/index.js"
-import * as Effect from "effect/Effect"
-import * as Option from "effect/Option"
-import * as Ref from "effect/Ref"
-
-import { makeEffectContextTracker } from "./_effect-context.js"
-
-const platformObjects = new Set(["Bun", "process", "Deno"])
-
-/**
- * Map of `Object.property` → Effect alternative hint.
- * Falls back to a generic message for unknown properties.
- */
-const alternatives: Record<string, Record<string, string>> = {
-  Bun: {
-    file: "Use FileSystem from 'effect'",
-    write: "Use FileSystem from 'effect'",
-    read: "Use FileSystem from 'effect'",
-    serve: "Use HttpServer from 'effect/unstable/http'",
-    env: "Use Config from 'effect'",
-    spawn: "Use Command from 'effect'",
-    sleep: "Use Effect.sleep",
-    stdin: "Use Terminal from 'effect'",
-    stdout: "Use Terminal from 'effect'",
-    stderr: "Use Terminal from 'effect'",
-    cwd: "Use Path from 'effect'",
-    which: "Use Command from 'effect'",
-    resolveSync: "Use Path from 'effect'",
-    pathToFileURL: "Use Path from 'effect'",
-  },
-  process: {
-    env: "Use Config from 'effect'",
-    exit: "Use Effect.fail or Effect.die",
-    cwd: "Use Path from 'effect'",
-    argv: "Use Args/Command from 'effect/unstable/cli'",
-    stdin: "Use Terminal from 'effect'",
-    stdout: "Use Terminal from 'effect'",
-    stderr: "Use Terminal from 'effect'",
-    chdir: "Use Path from 'effect'",
-    kill: "Use Command from 'effect'",
-    on: "Use Effect.async or Stream.async",
-    platform: "Use PlatformInfo from 'effect'",
-    arch: "Use PlatformInfo from 'effect'",
-    execPath: "Use Command from 'effect'",
-    execArgv: "Use Args/Command from 'effect/unstable/cli'",
-  },
-  Deno: {
-    readFile: "Use FileSystem from 'effect'",
-    writeFile: "Use FileSystem from 'effect'",
-    readTextFile: "Use FileSystem from 'effect'",
-    writeTextFile: "Use FileSystem from 'effect'",
-    open: "Use FileSystem from 'effect'",
-    remove: "Use FileSystem from 'effect'",
-    mkdir: "Use FileSystem from 'effect'",
-    readDir: "Use FileSystem from 'effect'",
-    stat: "Use FileSystem from 'effect'",
-    cwd: "Use Path from 'effect'",
-    env: "Use Config from 'effect'",
-    exit: "Use Effect.fail or Effect.die",
-    serve: "Use HttpServer from 'effect/unstable/http'",
-    run: "Use Command from 'effect'",
-    args: "Use Args/Command from 'effect/unstable/cli'",
-  },
-}
-
-function getHint(obj: string, prop: string): string {
-  const hint = alternatives[obj]?.[prop]
-  if (hint) return `. ${hint}`
-  return ". Wrap in a service for testability"
-}
-
-export const noPlatformGlobals = Rule.define({
-  name: "no-platform-globals",
-  meta: Rule.meta({
-    type: "suggestion",
-    description:
-      "Avoid platform globals (Bun.*, process.*, Deno.*) inside Effect context. Use Effect platform services.",
-  }),
-  create: function* () {
-    const ctx = yield* RuleContext
-    const [depth, tracker] = yield* makeEffectContextTracker
-
-    return Visitor.merge(tracker, {
-      MemberExpression: (node) =>
-        Effect.flatMap(Ref.get(depth), (d) => {
-          if (d <= 0) return Effect.void
-
-          const names = Option.getOrUndefined(
-            AST.memberNames(node as ESTree.MemberExpression),
-          )
-          if (names === undefined) return Effect.void
-
-          const [obj, prop] = names
-          if (!platformObjects.has(obj)) return Effect.void
-
-          return ctx.report(
-            Diagnostic.make({
-              node,
-              message: `Avoid ${obj}.${prop} inside Effect context${getHint(obj, prop)}.`,
-            }),
-          )
-        }),
-    })
-  },
-})

package/src/rules/no-process-env-in-effect.ts

@@ -1,39 +0,0 @@
-/**
- * Ban `process.env` inside Effect.gen/fn context.
- *
- * Use Effect Config service instead.
- *
- * Source: language-service/processEnvInEffect
- */
-import type { ESTree } from "@oxlint/plugins"
-import { AST, Diagnostic, Rule, Visitor } from "../vendor/effect-oxlint/index.js"
-import { RuleContext } from "../vendor/effect-oxlint/index.js"
-import * as Effect from "effect/Effect"
-import * as Option from "effect/Option"
-import * as Ref from "effect/Ref"
-
-import { makeEffectContextTracker } from "./_effect-context.js"
-
-export const noProcessEnvInEffect = Rule.define({
-  name: "no-process-env-in-effect",
-  meta: Rule.meta({
-    type: "suggestion",
-    description: "Avoid process.env inside Effect.gen/fn. Use Config service.",
-  }),
-  create: function* () {
-    const ctx = yield* RuleContext
-    const [depth, tracker] = yield* makeEffectContextTracker
-
-    return Visitor.merge(tracker, {
-      MemberExpression: (node) =>
-        Effect.flatMap(Ref.get(depth), (d) => {
-          if (d > 0 && Option.isSome(AST.matchMember(node as ESTree.MemberExpression, "process", "env"))) {
-            return ctx.report(
-              Diagnostic.make({ node, message: "Avoid process.env inside Effect context. Use Config service." }),
-            )
-          }
-          return Effect.void
-        }),
-    })
-  },
-})

package/src/rules/no-process-env.ts

@@ -1,13 +0,0 @@
-/**
- * Ban `process.env` access.
- *
- * Use Effect Config service instead.
- *
- * Source: language-service/processEnv
- */
-import { Rule } from "../vendor/effect-oxlint/index.js"
-
-export const noProcessEnv = Rule.banMember("process", "env", {
-  message: "Avoid process.env. Use Effect Config service.",
-  meta: { type: "suggestion" },
-})

package/src/rules/no-random-in-effect.ts

@@ -1,39 +0,0 @@
-/**
- * Ban `Math.random()` inside Effect.gen/fn context.
- *
- * Use Random service instead.
- *
- * Source: language-service/globalRandomInEffect
- */
-import type { ESTree } from "@oxlint/plugins"
-import { AST, Diagnostic, Rule, Visitor } from "../vendor/effect-oxlint/index.js"
-import { RuleContext } from "../vendor/effect-oxlint/index.js"
-import * as Effect from "effect/Effect"
-import * as Option from "effect/Option"
-import * as Ref from "effect/Ref"
-
-import { makeEffectContextTracker } from "./_effect-context.js"
-
-export const noRandomInEffect = Rule.define({
-  name: "no-random-in-effect",
-  meta: Rule.meta({
-    type: "suggestion",
-    description: "Avoid Math.random() inside Effect.gen/fn. Use Random service.",
-  }),
-  create: function* () {
-    const ctx = yield* RuleContext
-    const [depth, tracker] = yield* makeEffectContextTracker
-
-    return Visitor.merge(tracker, {
-      MemberExpression: (node) =>
-        Effect.flatMap(Ref.get(depth), (d) => {
-          if (d > 0 && Option.isSome(AST.matchMember(node as ESTree.MemberExpression, "Math", "random"))) {
-            return ctx.report(
-              Diagnostic.make({ node, message: "Avoid Math.random() inside Effect context. Use Random service." }),
-            )
-          }
-          return Effect.void
-        }),
-    })
-  },
-})

package/src/rules/no-return-null.ts

@@ -1,47 +0,0 @@
-/**
- * Ban `return null` statements.
- *
- * Use Option.none for absence or Effect.fail for errors.
- *
- * Source: biome-effect-linting-rules/no-return-null
- */
-import { AST, Diagnostic, Rule, Visitor } from "../vendor/effect-oxlint/index.js"
-import { RuleContext } from "../vendor/effect-oxlint/index.js"
-import * as Effect from "effect/Effect"
-import * as Option from "effect/Option"
-import { pipe } from "effect/Function"
-
-export const noReturnNull = Rule.define({
-  name: "no-return-null",
-  meta: Rule.meta({
-    type: "suggestion",
-    description:
-      "Avoid returning null. Use Option.none for absence or Effect.fail for errors.",
-  }),
-  create: function* () {
-    const ctx = yield* RuleContext
-    return {
-      ReturnStatement: (node) => {
-        if (
-          node.type === "ReturnStatement" &&
-          "argument" in node &&
-          node.argument !== null &&
-          node.argument !== undefined &&
-          "type" in node.argument &&
-          node.argument.type === "Literal" &&
-          "value" in node.argument &&
-          node.argument.value === null
-        ) {
-          return ctx.report(
-            Diagnostic.make({
-              node,
-              message:
-                "Avoid returning null. Use Option.none for absence.",
-            }),
-          )
-        }
-        return Effect.void
-      },
-    }
-  },
-})

package/src/rules/no-throw-in-effect-gen.ts

@@ -1,42 +0,0 @@
-/**
- * Ban `throw` statements inside Effect.gen/fn generators.
- *
- * Use Effect.fail with tagged errors instead.
- *
- * Source: effect convention — errors should be in the type system
- */
-import { Diagnostic, Rule, Visitor } from "../vendor/effect-oxlint/index.js"
-import { RuleContext } from "../vendor/effect-oxlint/index.js"
-import * as Effect from "effect/Effect"
-import * as Ref from "effect/Ref"
-
-import { makeEffectContextTracker } from "./_effect-context.js"
-
-export const noThrowInEffectGen = Rule.define({
-  name: "no-throw-in-effect-gen",
-  meta: Rule.meta({
-    type: "problem",
-    description:
-      "Avoid throw inside Effect.gen/fn. Use Effect.fail with tagged errors.",
-  }),
-  create: function* () {
-    const ctx = yield* RuleContext
-    const [depth, tracker] = yield* makeEffectContextTracker
-
-    return Visitor.merge(tracker, {
-      ThrowStatement: (node) =>
-        Effect.flatMap(Ref.get(depth), (d) => {
-          if (d > 0) {
-            return ctx.report(
-              Diagnostic.make({
-                node,
-                message:
-                  "Avoid throw inside Effect.gen/fn. Use Effect.fail with tagged errors.",
-              }),
-            )
-          }
-          return Effect.void
-        }),
-    })
-  },
-})

package/src/rules/no-timers-in-effect.ts

@@ -1,47 +0,0 @@
-/**
- * Ban `setTimeout`/`setInterval` inside Effect.gen/fn context.
- *
- * Use Effect.sleep or Schedule instead.
- *
- * Source: language-service/globalTimersInEffect
- */
-import type { ESTree } from "@oxlint/plugins"
-import { AST, Diagnostic, Rule, Visitor } from "../vendor/effect-oxlint/index.js"
-import { RuleContext } from "../vendor/effect-oxlint/index.js"
-import * as Effect from "effect/Effect"
-import * as Option from "effect/Option"
-import * as Ref from "effect/Ref"
-
-import { makeEffectContextTracker } from "./_effect-context.js"
-
-const timerNames = ["setTimeout", "setInterval"]
-
-export const noTimersInEffect = Rule.define({
-  name: "no-timers-in-effect",
-  meta: Rule.meta({
-    type: "suggestion",
-    description: "Avoid setTimeout/setInterval inside Effect.gen/fn. Use Effect.sleep or Schedule.",
-  }),
-  create: function* () {
-    const ctx = yield* RuleContext
-    const [depth, tracker] = yield* makeEffectContextTracker
-
-    return Visitor.merge(tracker, {
-      CallExpression: (node) =>
-        Effect.flatMap(Ref.get(depth), (d) => {
-          if (d > 0) {
-            const name = Option.getOrUndefined(AST.calleeName(node as ESTree.CallExpression))
-            if (name !== undefined && timerNames.includes(name)) {
-              return ctx.report(
-                Diagnostic.make({
-                  node,
-                  message: "Avoid setTimeout/setInterval inside Effect context. Use Effect.sleep or Schedule.",
-                }),
-              )
-            }
-          }
-          return Effect.void
-        }),
-    })
-  },
-})

package/src/rules/no-try-catch-in-effect-gen.ts

@@ -1,42 +0,0 @@
-/**
- * Ban `try/catch` inside Effect.gen/fn generators.
- *
- * Use Effect.try, Effect.tryPromise, or Effect.catch* instead.
- *
- * Source: language-service/tryCatchInEffectGen
- */
-import { Diagnostic, Rule, Visitor } from "../vendor/effect-oxlint/index.js"
-import { RuleContext } from "../vendor/effect-oxlint/index.js"
-import * as Effect from "effect/Effect"
-import * as Ref from "effect/Ref"
-
-import { makeEffectContextTracker } from "./_effect-context.js"
-
-export const noTryCatchInEffectGen = Rule.define({
-  name: "no-try-catch-in-effect-gen",
-  meta: Rule.meta({
-    type: "suggestion",
-    description:
-      "Avoid try/catch inside Effect.gen/fn. Use Effect.try or Effect.tryPromise.",
-  }),
-  create: function* () {
-    const ctx = yield* RuleContext
-    const [depth, tracker] = yield* makeEffectContextTracker
-
-    return Visitor.merge(tracker, {
-      TryStatement: (node) =>
-        Effect.flatMap(Ref.get(depth), (d) => {
-          if (d > 0) {
-            return ctx.report(
-              Diagnostic.make({
-                node,
-                message:
-                  "Avoid try/catch inside Effect.gen/fn. Use Effect.try, Effect.tryPromise, or Effect.catch*.",
-              }),
-            )
-          }
-          return Effect.void
-        }),
-    })
-  },
-})