eslint-plugin-code-flow

ESLint plugin for control-flow style rules: guard clauses over wrapped happy paths, and related patterns.

Why

Functions that wrap their entire body in a positive if bury the happy path one indentation level deep. Guard clauses invert the condition, return early, and leave the main work at the top level where it reads naturally.

Install

pnpm add -D @boring-stack-pkg/eslint-plugin-code-flow @typescript-eslint/parser

Usage (flat config)

import tsParser from "@typescript-eslint/parser";
import codeFlow from "@boring-stack-pkg/eslint-plugin-code-flow";

export default [
  {
    files: ["**/*.{ts,tsx}"],
    languageOptions: {
      parser: tsParser,
      parserOptions: {
        ecmaVersion: "latest",
        sourceType: "module",
      },
    },
    plugins: {
      "code-flow": codeFlow,
    },
    rules: {
      "code-flow/prefer-early-return": "error",
    },
  },
];

Or use the built-in recommended config:

import codeFlow from "@boring-stack-pkg/eslint-plugin-code-flow";

export default [codeFlow.configs.recommended];

Rules

| Rule | Description | | ------------------------------------------------------------ | ------------------------------------------------------------------------------ | | prefer-early-return | Prefer guard clauses over wrapping the function body in a multi-statement if |

Development

pnpm install
pnpm run typecheck
pnpm test
pnpm run build

Release

Push a v* tag; CI publishes to npm when NPM_TOKEN is configured.

License

MIT