@codeforbreakfast/eslint-effect
v0.8.5
Published
ESLint rules and configurations for Effect projects enforcing functional programming best practices
Maintainers
Readme
@codeforbreakfast/eslint-effect
ESLint rules and configurations for Effect projects that enforce functional programming best practices and idiomatic Effect code patterns.
Installation
npm install --save-dev @codeforbreakfast/eslint-effect
# or
bun add --dev @codeforbreakfast/eslint-effectFeatures
This package provides:
- Custom ESLint Rules for Effect-specific patterns
- Syntax Restrictions to enforce functional programming principles
- Pre-configured Rule Sets for different contexts
- Functional Immutability Rules tailored for Effect types
Custom Rules
no-unnecessary-pipe-wrapper
Detects unnecessary function wrappers around single pipe operations.
❌ Bad:
import { pipe } from 'effect';
declare const transform: (x: unknown) => unknown;
const fn = (x: unknown) => pipe(x, transform);✅ Good:
declare const transform: (x: unknown) => unknown;
const fn = transform;no-eta-expansion
Detects unnecessary function wrappers (eta-expansion) that only pass parameters directly to another function. Also known as "prefer point-free style."
❌ Bad:
import { Console } from 'effect';
declare const doSomething: (x: number) => unknown;
declare const processData: (a: string, b: number) => unknown;
const logError = (msg: string) => Console.error(msg);
const transform = (x: number) => doSomething(x);
const handler = (a: string, b: number) => processData(a, b);✅ Good:
import { Console } from 'effect';
declare const doSomething: (x: number) => unknown;
declare const processData: (a: string, b: number) => unknown;
const logError = Console.error;
const transform = doSomething;
const handler = processData;Rationale: In functional programming, eta-reduction (λx.f(x) → f) eliminates unnecessary indirection. When a function only passes its parameters directly to another function without any transformation, the wrapper adds no value and reduces readability.
no-unnecessary-function-alias
Detects unnecessary function aliases that provide no semantic value. When a constant is assigned directly to another function without adding clarity or abstraction, it should be inlined at the call site.
❌ Bad:
import { Array, Ref } from 'effect';
declare const ref: Ref.Ref<unknown>;
declare const arr: readonly unknown[];
declare function useOnce(val: unknown): void;
declare function useTwice(val: unknown): void;
const getState = Ref.get;
const transform = Array.map;
// Used only once or twice
useOnce(getState(ref));
useTwice(transform(arr, (x: unknown) => (x as number) * 2));✅ Good:
import { Array, Ref, Stream } from 'effect';
declare const ref: Ref.Ref<unknown>;
declare const arr: readonly unknown[];
declare function useOnce(val: unknown): void;
declare function useTwice(val: unknown): void;
// Inline when used infrequently
useOnce(Ref.get(ref));
useTwice(Array.map(arr, (x: unknown) => (x as number) * 2));
// OR keep the alias if it adds semantic value
// eslint-disable-next-line effect/no-unnecessary-function-alias -- Alias clarifies stream processing context
const collectStreamResults = Stream.runCollect;Configuration:
maxReferences(default:2) - Maximum number of references before alias is considered justified
{
rules: {
'effect/no-unnecessary-function-alias': ['warn', {
maxReferences: 3, // Allow aliases used 3+ times
}]
}
}Rationale: Function aliases that are used only once or twice add cognitive overhead without meaningful benefit. They force readers to jump between the alias definition and usage site. Direct function calls are more straightforward. However, aliases that are used frequently (3+ times) or that add semantic clarity through their name should be kept.
prefer-match-tag
Enforces Match.tag() over Match.when() for _tag discriminators.
❌ Bad:
import { Match, pipe } from 'effect';
type Tagged = { _tag: 'Success' } | { _tag: 'Error' };
declare const value: Tagged;
declare const handler: (val: { _tag: 'Success' }) => unknown;
pipe(Match.value(value), Match.when({ _tag: 'Success' }, handler));✅ Good:
import { Match, pipe } from 'effect';
type Tagged = { _tag: 'Success' } | { _tag: 'Error' };
declare const value: Tagged;
declare const handler: (val: { _tag: 'Success' }) => unknown;
pipe(Match.value(value), Match.tag('Success', handler));prefer-match-over-conditionals
Encourages declarative Match patterns over imperative if statements in Effect callbacks.
❌ Bad:
import { Effect, Match, pipe } from 'effect';
type TaggedValue = { _tag: 'Success' } | { _tag: 'Error' };
declare const handleSuccess: (x: { _tag: 'Success' }) => Effect.Effect<unknown>;
declare const handleError: (x: TaggedValue) => Effect.Effect<unknown>;
declare const effectValue: Effect.Effect<TaggedValue>;
pipe(
effectValue,
Effect.flatMap((x: TaggedValue) => {
if (x._tag === 'Success') return handleSuccess(x);
return handleError(x);
})
);✅ Good:
import { Effect, Match, pipe } from 'effect';
type TaggedValue = { _tag: 'Success' } | { _tag: 'Error' };
declare const handleSuccess: (x: { _tag: 'Success' }) => Effect.Effect<unknown>;
declare const handleError: (x: TaggedValue) => Effect.Effect<unknown>;
declare const effectValue: Effect.Effect<TaggedValue>;
pipe(
effectValue,
Effect.flatMap((x: TaggedValue) =>
pipe(Match.value(x), Match.tag('Success', handleSuccess), Match.orElse(handleError))
)
);prefer-effect-if-over-match-boolean
Enforces Effect.if over Match.value for boolean conditionals. Match.value should be reserved for pattern matching on multiple values, not simple true/false branches.
❌ Bad:
import { Effect, Match, pipe } from 'effect';
declare const isValid: boolean;
declare const user: { isAdmin: boolean };
declare function grantAccess(): Effect.Effect<unknown>;
declare function denyAccess(): Effect.Effect<unknown>;
pipe(
isValid,
Match.value,
Match.when(true, () => Effect.succeed('valid')),
Match.when(false, () => Effect.fail('invalid')),
Match.exhaustive
);
pipe(
user.isAdmin,
Match.value,
Match.when(true, () => grantAccess()),
Match.when(false, () => denyAccess()),
Match.exhaustive
);✅ Good:
import { Effect } from 'effect';
declare const isValid: boolean;
declare const user: { isAdmin: boolean };
declare function grantAccess(): Effect.Effect<unknown>;
declare function denyAccess(): Effect.Effect<unknown>;
Effect.if(isValid, {
onTrue: () => Effect.succeed('valid'),
onFalse: () => Effect.fail('invalid'),
});
Effect.if(user.isAdmin, {
onTrue: () => grantAccess(),
onFalse: () => denyAccess(),
});Rationale: Match.value is designed for pattern matching on discriminated unions and multiple values. Using it for simple boolean conditions is verbose and obscures intent. Effect.if is explicit, concise, and clearly communicates boolean branching logic.
prefer-match-over-ternary
Encourages declarative Match.value patterns over ternary operators when pattern matching on non-boolean values or selecting between function calls.
Note: For boolean conditions returning Effects, use Effect.if instead (see prefer-effect-if-over-match-boolean rule above).
❌ Bad:
import { Option, Stream } from 'effect';
type FilterFn = (v: unknown) => boolean;
declare const filter: FilterFn | undefined;
declare const stream: Stream.Stream<unknown>;
declare function processValue(val: number): unknown;
declare function getDefault(): unknown;
declare function finalizeTask(): unknown;
declare function continueTask(): unknown;
const result = filter !== undefined ? Stream.filter(stream, filter) : stream;
const handler = (option: Option.Option<number>) =>
Option.isSome(option) ? processValue(option.value) : getDefault();
const processStatus = (status: 'pending' | 'active' | 'complete') =>
status === 'complete' ? finalizeTask() : continueTask();✅ Good:
import { Match, Option, pipe, Stream } from 'effect';
type FilterFn = (v: unknown) => boolean;
declare const filter: FilterFn | undefined;
declare const stream: Stream.Stream<unknown>;
declare function processValue(val: number): unknown;
declare function getDefault(): unknown;
declare function finalizeTask(): unknown;
declare function continueTask(): unknown;
const result = pipe(
filter,
Match.value,
Match.when(Match.undefined, () => stream),
Match.orElse((f) => Stream.filter(stream, f))
);
const handler = (option: Option.Option<number>) =>
pipe(
option,
Match.value,
Match.when({ _tag: 'Some' }, (opt) => processValue(opt.value)),
Match.orElse(getDefault)
);
const processStatus = (status: 'pending' | 'active' | 'complete') =>
pipe(status, Match.value, Match.when('complete', finalizeTask), Match.orElse(continueTask));For boolean conditions with Effects, use Effect.if:
import { Effect } from 'effect';
declare const condition: boolean;
// Boolean condition returning Effects - use Effect.if, NOT Match.value
const result = Effect.if(condition, {
onTrue: () => Effect.succeed(42),
onFalse: () => Effect.fail('error'),
});Rationale: Ternary operators are imperative and less composable than Match patterns. Using Match.value provides better composability for pattern matching on values like optional types, union types, or non-boolean conditions. However, for simple boolean conditionals returning Effects, Effect.if is the preferred pattern as it's more explicit and type-safe. Plain value ternaries (not function calls) are allowed as they're appropriate for simple value selection.
no-switch-statement
Forbids switch statements in functional Effect code. Switch statements are imperative and don't provide exhaustiveness checking. Use Match for type-safe, exhaustive pattern matching.
❌ Bad:
import { Match, pipe } from 'effect';
type Event = { type: 'Created' } | { type: 'Updated' } | { type: 'Other' };
declare const event: Event;
declare function handleCreated(e: Event): unknown;
declare function handleUpdated(e: Event): unknown;
declare function handleUnknown(e: Event): unknown;
function processEvent() {
switch (event.type) {
case 'Created':
return handleCreated(event);
case 'Updated':
return handleUpdated(event);
default:
return handleUnknown(event);
}
}✅ Good:
import { Match, pipe } from 'effect';
type Event = { type: 'Created' } | { type: 'Updated' } | { type: 'Other' };
declare const event: Event;
declare function handleCreated(e: Event): unknown;
declare function handleUpdated(e: Event): unknown;
declare function handleUnknown(e: Event): unknown;
pipe(
Match.value(event),
Match.when({ type: 'Created' }, handleCreated),
Match.when({ type: 'Updated' }, handleUpdated),
Match.orElse(handleUnknown)
);For discriminated unions with _tag:
import { Match, pipe } from 'effect';
type TaggedEither = { _tag: 'Right'; value: unknown } | { _tag: 'Left'; error: unknown };
declare const either: TaggedEither;
declare function handleRight(val: { _tag: 'Right'; value: unknown }): unknown;
declare function handleLeft(val: { _tag: 'Left'; error: unknown }): unknown;
pipe(
Match.value(either),
Match.tag('Right', handleRight),
Match.tag('Left', handleLeft),
Match.exhaustive
);no-if-statement
Forbids if statements in functional Effect code. If statements are imperative and don't compose well. Use Effect.if for boolean conditionals with Effects, Match.value for pattern matching, or type-specific matchers for declarative control flow.
❌ Bad:
import { Effect, Option, pipe } from 'effect';
declare const todoState: { deleted: boolean };
declare const event: { type: string; data: { title: string } };
declare const option: Option.Option<string>;
declare const state: Option.Option<{ deleted: boolean }>;
declare const defaultValue: string;
// Bad pattern 1
function check1() {
if (todoState.deleted) {
return Effect.fail(new Error('Cannot complete deleted TODO'));
}
return Effect.succeed(todoState);
}
// Bad pattern 2
function check2() {
if (event.type === 'TodoCreated') {
return Effect.succeed({ title: event.data.title, completed: false });
}
return pipe(state, Option.match({ onNone: () => defaultValue, onSome: (s) => s }));
}
// Bad pattern 3
function check3() {
if (Option.isSome(option)) {
return option.value;
}
return defaultValue;
}✅ Good:
import { Effect, Option, Match, pipe } from 'effect';
declare const todoState: { deleted: boolean };
declare const event: { type: string; data: { title: string } };
declare const option: Option.Option<string>;
declare const state: Option.Option<{ deleted: boolean }>;
declare const defaultValue: string;
declare const condition: boolean;
// Boolean conditionals with Effects
Effect.if(todoState.deleted, {
onTrue: () => Effect.fail(new Error('Cannot complete deleted TODO')),
onFalse: () => Effect.succeed(todoState),
});
// Pattern matching on discriminated unions
pipe(
event,
Match.value,
Match.when({ type: 'TodoCreated' }, (e) =>
Effect.succeed({ title: e.data.title, completed: false })
),
Match.orElse((e) => pipe(state, Option.match({ onNone: () => defaultValue, onSome: (s) => s })))
);
// Option/Either with built-in matchers
pipe(
option,
Option.getOrElse(() => defaultValue)
);
// Simple value selection - use ternary operators
const x = condition ? 'yes' : 'no';Rationale: If statements break functional composition and make code harder to reason about. They don't provide exhaustiveness checking for pattern matching and can't be easily composed in pipes. Using Effect.if, Match.value, or type-specific matchers like Option.match provides better type safety, exhaustiveness checking, and composability. Ternary operators are still allowed for simple value selection as they're appropriate for plain values.
prefer-schema-validation-over-assertions
Discourages type assertions in Effect callbacks in favor of runtime validation.
❌ Bad:
import { Effect } from 'effect';
type MyType = { value: string };
declare function handler(x: MyType): unknown;
Effect.map((x: unknown) => handler(x as MyType));✅ Good:
import { Effect, pipe, Schema } from 'effect';
type MyType = { value: string };
declare const MyTypeSchema: Schema.Schema<MyType>;
declare const input: Effect.Effect<unknown>;
declare function handler(x: MyType): unknown;
pipe(input, Effect.flatMap(Schema.decodeUnknown(MyTypeSchema)), Effect.map(handler));suggest-currying-opportunity
Suggests currying user-defined functions to eliminate arrow function wrappers in pipe chains. By default, only suggests currying when parameters are already in the right order (no reordering needed) and limits to single-level currying for readability.
✅ Will Suggest (good pattern - params already at end):
import { Effect } from 'effect';
declare const myEffect: Effect.Effect<unknown>;
declare function logError(message: string, error: unknown): Effect.Effect<void>;
// Before
Effect.catchAll(myEffect, (error) => logError('Failed', error));
// After currying (params already in right order)
const logErrorCurried = (message: string) => (error: unknown) =>
Effect.sync(() => console.error(message, error));
Effect.catchAll(myEffect, logErrorCurried('Failed'));⚠️ Won't Suggest by Default (would require parameter reordering):
import { Effect } from 'effect';
declare const myEffect: Effect.Effect<unknown>;
declare function logError(error: unknown, message: string): Effect.Effect<void>;
// This would break semantic order - error should come before message
Effect.catchAll(myEffect, (error) => logError(error, 'Failed'));
// Would require changing to: logError = (message) => (error) => ...
// But semantically, error should come first in the return object⚠️ Won't Suggest by Default (would create deep currying):
import { Effect } from 'effect';
declare const myEffect: Effect.Effect<unknown>;
declare function processData(prefix: string, suffix: string, data: unknown): unknown;
// Would create 2-level currying: (prefix) => (suffix) => (data) => ...
Effect.map(myEffect, (data) => processData('prefix', 'suffix', data));
// Too many parentheses at call site: processData('prefix')('suffix')Configuration Options:
allowReordering(default:false) - Allow suggestions even when parameters would need reorderingmaxCurriedParams(default:1, max:3) - Maximum number of curried parameters to suggest
{
rules: {
'effect/suggest-currying-opportunity': ['warn', {
allowReordering: true, // Allow parameter reordering suggestions
maxCurriedParams: 2, // Allow up to 2-level currying
}]
}
}Note: This rule only triggers on user-defined functions, not Effect library functions.
no-intermediate-effect-variables
Forbids storing Effect/Stream/pipe results in intermediate variables when they should be inlined into pipe chains. Configuration data like Schedule constants, retry policies, and Effect values passed as parameters are allowed.
❌ Bad (should inline):
import { Effect, pipe, Schema } from 'effect';
type User = { id: string; name: string };
declare const userId: string;
declare const UserSchema: Schema.Schema<User>;
declare const data: unknown;
declare function fetchUser(id: string): Effect.Effect<User>;
declare function validateUser(u: User): Effect.Effect<User>;
declare function formatUserData(u: User): unknown;
declare function processUser(u: User): User;
declare function saveToDatabase(u: User): Effect.Effect<void>;
// Breaking up the pipe chain for a single use
const userEffect = fetchUser(userId);
const result = pipe(userEffect, Effect.flatMap(validateUser), Effect.map(formatUserData));
// Storing intermediate pipe results used once
function processData() {
const validated = pipe(data, Schema.decodeUnknown(UserSchema));
const processed = Effect.map(validated, processUser);
return Effect.flatMap(processed, saveToDatabase);
}
// Schema defined but only used once
const UserIdSchema = pipe(Schema.String, Schema.nonEmptyString());
export const decodeUserId = Schema.decode(UserIdSchema); // Only usage✅ Good (inline pipeline values):
import { Effect, pipe, Schema } from 'effect';
type User = { id: string; name: string };
declare const userId: string;
declare const UserSchema: Schema.Schema<User>;
declare const data: unknown;
declare function fetchUser(id: string): Effect.Effect<User>;
declare function validateUser(u: User): Effect.Effect<User>;
declare function formatUserData(u: User): unknown;
declare function processUser(u: User): User;
declare function saveToDatabase(u: User): Effect.Effect<void>;
// Single cohesive pipe chain
const result = pipe(fetchUser(userId), Effect.flatMap(validateUser), Effect.map(formatUserData));
// All transformations in one composition
function processData() {
return pipe(
data,
Schema.decodeUnknown(UserSchema),
Effect.map(processUser),
Effect.flatMap(saveToDatabase)
);
}
// Schema inlined directly
export const decodeUserId = Schema.decode(pipe(Schema.String, Schema.nonEmptyString()));✅ Good (configuration data):
import { Effect, pipe, Schedule } from 'effect';
declare const operation: Effect.Effect<unknown>;
// Schedule constants used as configuration
const retrySchedule = pipe(
Schedule.exponential('100 millis'),
Schedule.union(Schedule.spaced('1 second'))
);
const result = pipe(operation, Effect.retry(retrySchedule));
// Effect values used as parameters
const defaultValue = Effect.succeed(42);
const combined = pipe(
Effect.succeed(1),
Effect.zipWith(defaultValue, (a, b) => a + b)
);✅ Good (multiple uses - legitimate reuse):
import { Context, Effect, Layer, pipe } from 'effect';
declare class PgClientService extends Context.Tag('PgClient')<PgClientService, unknown>() {}
declare const createPgClient: Effect.Effect<unknown>;
declare const Migration: { layer: Layer.Layer<unknown> };
declare const EventStore: { layer: Layer.Layer<unknown> };
declare function it(name: string, fn: () => unknown): void;
// Layer reused in multiple compositions
const PgLive = Layer.effect(PgClientService, createPgClient);
const Layer1 = pipe(Migration.layer, Layer.provide(PgLive)); // Use 1
const Layer2 = pipe(EventStore.layer, Layer.provide(PgLive)); // Use 2
// Effect reused across test cases
const setupTest = Effect.gen(function* () {
yield* Effect.void;
});
it('test 1', () =>
pipe(
setupTest,
Effect.flatMap(() => Effect.void)
)); // Use 1
it('test 2', () =>
pipe(
setupTest,
Effect.flatMap(() => Effect.void)
)); // Use 2✅ Good (execution results are plain values):
import { Effect, Either, pipe } from 'effect';
type Request = { token: string };
declare const req: Request;
declare function authenticate(r: Request): Effect.Effect<string, Error>;
// runSync returns a plain value, not an Effect
function handleAuth() {
const authResult = Effect.runSync(pipe(authenticate(req), Effect.either));
if (Either.isLeft(authResult)) {
return { json: () => ({ error: authResult.left }) };
}
return { json: () => ({ token: authResult.right }) };
}Rationale: Intermediate pipeline variables break the flow of pipe composition. Configuration data like Schedule constants and Effect values used as parameters to Effect operations are legitimate building blocks and should be extracted. Multiple uses also justify variable extraction.
Note: This is an aggressive rule included in the pipeStrict config.
Rule Presets
Recommended Presets
recommended ⭐
Recommended for most projects - Core Effect best practices without controversial rules:
- All Effect plugin rules
- Forbids classes (except Effect tags/errors)
- Forbids
Effect.runSync/runPromisein production - Enforces
Effect.andThen()overEffect.flatMap(() => ) - Enforces
Effect.as()overEffect.map(() => value) - Forbids method-based
.pipe()(use standalonepipe()) - Forbids curried function calls (use
pipeinstead) - Forbids identity functions in transformations
- Enforces proper pipe argument order
Does NOT include:
Effect.genban (opt-in withnoGen)_tagaccess ban (opt-in withpreferMatch)- Strict pipe rules (opt-in with
pipeStrict)
strict
For zealots - Everything in recommended plus all opinionated rules:
- All
recommendedrules - Forbids
Effect.gen(usepipeinstead) - Forbids direct
_tagaccess (use type guards orMatch) - Forbids ALL
switchstatements (useMatch.valuefor pattern matching) - Forbids ALL
ifstatements (useEffect.if,Match.value, or type-specific matchers) - Forbids nested
pipe()calls - Forbids multiple
pipe()calls in one function
Opt-in Configs
Mix these with recommended to customize your rules:
noGen
Forbids Effect.gen in favor of pipe composition. Controversial - some teams prefer gen!
preferMatch
Forbids direct _tag access, ALL switch statements, and ALL if statements. Encourages declarative Match patterns, Effect.if for boolean conditionals, and type-specific matchers.
pipeStrict
Enforces strict pipe composition rules:
- Forbids nested
pipe()calls - Forbids multiple
pipe()calls per function - Forbids storing pipe/Effect results in single-use intermediate variables
plugin
Plugin rules only, no syntax restrictions.
Functional Immutability
functionalImmutabilityRules
Leverages eslint-plugin-functional with Effect-aware configuration:
- Enforces readonly types with Effect type exceptions
- Forbids
letbindings - Enforces immutable data patterns
- Forbids loops (use
Effect.forEach,Array.map, etc.)
Usage
Recommended Setup
Start with recommended for sensible defaults:
import effectPlugin from '@codeforbreakfast/eslint-effect';
export default [
{
...effectPlugin.configs.recommended,
files: ['**/*.ts', '**/*.tsx'],
plugins: {
effect: effectPlugin,
},
},
];Add Opinionated Rules
Opt-in to stricter rules as needed:
import effectPlugin from '@codeforbreakfast/eslint-effect';
export default [
{
...effectPlugin.configs.recommended,
files: ['**/*.ts', '**/*.tsx'],
plugins: {
effect: effectPlugin,
},
},
// Forbid Effect.gen
{
...effectPlugin.configs.noGen,
files: ['src/**/*.ts'],
},
// Enforce strict pipe rules
{
...effectPlugin.configs.pipeStrict,
files: ['src/**/*.ts'],
},
// Or just use strict for everything
{
...effectPlugin.configs.strict,
files: ['src/**/*.ts'],
plugins: {
effect: effectPlugin,
},
},
];With Functional Immutability
Requires eslint-plugin-functional:
import functionalPlugin from 'eslint-plugin-functional';
import effectPlugin from '@codeforbreakfast/eslint-effect';
export default [
{
files: ['**/*.ts'],
plugins: {
functional: functionalPlugin,
},
rules: effectPlugin.configs.functionalImmutabilityRules,
},
{
...effectPlugin.configs.recommended,
files: ['**/*.ts'],
plugins: {
effect: effectPlugin,
},
},
];Disabling Individual Rules
All syntax restriction rules are exposed as named ESLint rules, making it easy to disable specific rules:
import effectPlugin from '@codeforbreakfast/eslint-effect';
export default [
{
...effectPlugin.configs.recommended,
files: ['scripts/**/*.ts'],
plugins: {
effect: effectPlugin,
},
rules: {
// Allow runPromise/runSync in scripts (application entry points)
'effect/no-runPromise': 'off',
'effect/no-runSync': 'off',
},
},
];Available named rules:
effect/no-classes- Forbid classes except Effect tags/errorseffect/no-runSync- Forbid Effect.runSynceffect/no-runPromise- Forbid Effect.runPromiseeffect/prefer-andThen- Use andThen over flatMap(() => ...)effect/prefer-as- Use as over map(() => value)effect/no-gen- Forbid Effect.gen (opt-in vianoGenconfig)effect/no-unnecessary-pipe-wrapper- Detect unnecessary pipe wrapperseffect/no-eta-expansion- Detect unnecessary function wrappers (prefer point-free style)effect/no-unnecessary-function-alias- Detect unnecessary function aliaseseffect/prefer-match-tag- Use Match.tag over Match.when for _tageffect/prefer-match-over-conditionals- Use Match over if statementseffect/prefer-effect-if-over-match-boolean- Use Effect.if over Match.value for boolean conditionalseffect/prefer-match-over-ternary- Use Match.value over ternary operators for non-boolean pattern matchingeffect/no-switch-statement- Forbid ALL switch statements (use Match.value instead)effect/no-if-statement- Forbid ALL if statements (use Effect.if, Match.value, or type-specific matchers instead)effect/prefer-schema-validation-over-assertions- Use Schema over type assertionseffect/suggest-currying-opportunity- Suggest currying to eliminate arrow function wrapperseffect/no-intermediate-effect-variables- Forbid storing pipe/Effect results in single-use intermediate variables (opt-in viapipeStrictconfig)
Available Exports
Default Export (Recommended)
// @ts-nocheck - Package types available at runtime
import effectPlugin from '@codeforbreakfast/eslint-effect';
effectPlugin.rules; // All custom rules
effectPlugin.meta; // Plugin metadata
// Configs
effectPlugin.configs.recommended; // ⭐ Recommended for most projects
effectPlugin.configs.strict; // All rules including opinionated ones
effectPlugin.configs.noGen; // Opt-in: forbid Effect.gen
effectPlugin.configs.preferMatch; // Opt-in: forbid _tag access
effectPlugin.configs.pipeStrict; // Opt-in: strict pipe rules
effectPlugin.configs.plugin; // Plugin rules only
effectPlugin.configs.functionalImmutabilityRules; // Functional immutability rules objectEach config (except functionalImmutabilityRules) is a complete ESLint flat config object with:
name: Config identifierrules: Rule configurationplugins: Required plugins (where applicable)
Named Exports
// @ts-nocheck - Package types available at runtime
import {
rules, // All custom rules (for plugin registration)
functionalImmutabilityRules, // Functional immutability rules object
} from '@codeforbreakfast/eslint-effect';Scoped Imports
import rules from '@codeforbreakfast/eslint-effect/rules';Philosophy
This package enforces a strict functional programming style with Effect:
- Composition over Generation: Prefer
pipecomposition overEffect.gen - Type Safety: Use runtime validation (Schema) over type assertions
- Declarative Patterns: Use
Matchover imperative conditionals - Immutability: Enforce readonly types and immutable data patterns
- Boundary Execution: Run effects only at application boundaries
License
MIT © CodeForBreakfast
