# `Bylaw.Credo.Check.Ecto.ComposablePreloadQueries`
[🔗](https://github.com/ryanzidago/bylaw/blob/v0.1.0-alpha.1/lib/bylaw/credo/check/ecto/composable_preload_queries.ex#L1)

## Basics

> #### This check is disabled by default. {: .neutral}
>
> [Learn how to enable it](`e:credo:config_file.html#checks`) via `.credo.exs`.

This check has a base priority of `higher` and works with any version of Elixir.

## Explanation

Query helpers named `*_preload_query` should not hard-code their own
Ecto preload expression. Accept a `preloads:` option, bind it to a local
`preloads` variable, and pass it to Ecto with `preload(^preloads)`.

## Examples

Avoid:

      defp input_file_preload_query do
        ToolCallFile
        |> from(as: :tool_file)
        |> preload([:file])
      end

Prefer:

      defp input_file_preload_query(opts) do
        preloads = Keyword.get(opts, :preloads, [])

        ToolCallFile
        |> from(as: :tool_file)
        |> preload(^preloads)
      end

## Notes

This check uses static AST analysis, so it favors clear source-level patterns over runtime behavior.

## Options

This check has no check-specific options. Configure it with an empty option list.

## Usage

Add this check to Credo's `checks:` list in `.credo.exs`:

```elixir
%{
  configs: [
    %{
      name: "default",
      checks: [
        {Bylaw.Credo.Check.Ecto.ComposablePreloadQueries, []}
      ]
    }
  ]
}
```

## Check-Specific Parameters

*There are no specific parameters for this check.*

## General Parameters

Like with all checks, [general params](`e:credo:check_params.html`) can be applied.

Parameters can be configured via the [`.credo.exs` config file](`e:credo:config_file.html`).

---

*Consult [api-reference.md](api-reference.md) for complete listing*
