mcpField
E
effector-playbook

effector-playbook

github.com/neoliteDevelopment484 installsUpdated 39w ago
Repository

About effector-playbook

effector-playbook is a ruleset for writing and reviewing correct, testable Effector code. It is for developers working on Effector models, flows, React integration, SSR, and tests, with concise rules organized by topic.

Key features

  1. 01Rules for core correctness
  2. 02Guidance on flow control and effects
  3. 03Modeling and React integration rules
  4. 04Scopes, SSR, and testing patterns
  5. 05Debugging and linting guidance

Use cases

  1. 01Review Effector models and flows
  2. 02Debug races and stale reads
  3. 03Build SSR-safe logic and scoped tests
  4. 04Enforce architecture with linting

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/neolite/effector-playbook --skill effector-playbook

After installing, type/effector-playbookin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

README.RU.md
AGENTS.md
README.md
references/
babel-plugin.md
scopes-ssr.md
testing.md
patronum-operators.md
rules/
core-no-getstate.md
core-logic-outside-view.md
core-no-guard-forward.md
core-no-watch.md
debug-use-inspect.md
core-store-naming.md
flow-use-on-for-simple.md
flow-avoid-circular-imports.md
flow-no-side-effects-in-map.md
fx-compose-effects-explicitly.md
fx-use-effect-lifecycle.md
flow-use-sample-for-time-correct.md
fx-use-attach-to-inject-deps.md
lint-use-eslint-plugin-effector.md
model-use-factories.md
model-normalize-entities.md
patronum-use-pending-inflight-status.md
patronum-use-combineevents.md
patronum-use-debounce-throttle.md
scope-use-fork-allsettled.md
react-useunit.md
patronum-use-condition.md
scope-use-scopebind-for-external.md

Details

From the project README

Effector Reliability Rules

Concise ruleset for writing correct and testable Effector code. Each rule has a short rationale and examples.

When to Apply

Use this skill when:

  • Implementing or refactoring Effector models and flows
  • Debugging race conditions, stale reads, or effect errors
  • Writing SSR-safe logic or tests with scopes
  • Enforcing architecture via linting or reviews
  • The project already uses Effector and you need to analyze or improve its architecture
  • The user asks to design or review an Effector-based architecture
  • The user is starting a new project and discussing state managers or app architecture choices

Rule Categories

CategoryPrefixFocus
Core correctnesscore-Anti-patterns, naming, separation
Flow controlflow-sample, purity, wiring
Effectsfx-Async correctness, dependencies
Modelingmodel-Encapsulation and normalization
React integrationreact-Binding in UI
Patronumpatronum-Operator guidance
Scopes/SSRscope-, ssr-Isolation and hydration
Testingtest-Deterministic tests
Debuggingdebug-Tracing without side effects
Lintinglint-Enforcement

Quick Reference

Core correctness
  • core-no-guard-forward - Replace legacy guard/forward with sample
  • core-no-watch - Do not use .watch for logic; use effects/inspect
  • core-no-getstate - No imperative getState() in flows
  • core-logic-outside-view - Keep logic in models, not components
  • core-store-naming - Use $ prefix for stores
Flow control
  • flow-use-sample-for-time-correct - Read state at clock time
  • flow-use-on-for-simple - Use .on for simple updates
  • flow-no-side-effects-in-map - Keep .map() pure
  • flow-avoid-circular-imports - Define units before wiring
Effects
  • fx-use-effect-lifecycle - Use pending/done/fail units
  • fx-compose-effects-explicitly - Await or parallelize inner effects
  • fx-use-attach-to-inject-deps - Inject store values via attach
Modeling
  • model-use-factories - Create isolated model instances
  • model-normalize-entities - Store entities in normalized form
React integration
  • react-useunit - Bind stores/events with useUnit
Patronum
  • patronum-use-debounce-throttle - Use debounce/throttle operators for timing
  • patronum-use-condition - Use condition for then/else branching
  • patronum-use-pending-inflight-status - Aggregate effect status via Patronum
  • patronum-use-combineevents - Wait for multiple events declaratively
Scopes/SSR
  • scope-use-fork-allsettled - Use fork and allSettled for isolation
  • scope-use-scopebind-for-external - Bind external callbacks to scope
  • ssr-use-sids-plugin - Enable Babel/SWC plugin for SIDs
Testing, debugging, linting
  • test-mock-effects-with-fork-handlers - Mock effects via fork({ handlers })
  • debug-use-inspect - Use inspect/patronum/debug for tracing
  • lint-use-eslint-plugin-effector - Enforce architecture with ESLint rules

How to Use

Read individual rule files:

rules/core-no-guard-forward.md
rules/scope-use-fork-allsettled.md

References

  • AGENTS.md (compiled rules)
  • references/llms-full.txt (Effector API reference)
  • references/scopes-ssr.md (scopes, SSR, hydration)
  • references/testing.md (testing patterns)
  • references/babel-plugin.md (SIDs and plugin usage)
  • references/patronum-operators.md (operator index)

Comments

Markdown supported